Package org.datavec.api.split
Class CollectionInputSplit
- java.lang.Object
-
- org.datavec.api.split.BaseInputSplit
-
- org.datavec.api.split.CollectionInputSplit
-
- All Implemented Interfaces:
InputSplit
public class CollectionInputSplit extends BaseInputSplit
-
-
Field Summary
-
Fields inherited from class org.datavec.api.split.BaseInputSplit
iterationOrder, length, uriStrings
-
-
Constructor Summary
Constructors Constructor Description CollectionInputSplit(URI[] array)CollectionInputSplit(Collection<URI> list)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidbootStrapForWrite()Bootstrap this input split for writing.longlength()Length of the splitbooleanneedsBootstrapForWrite()Returns true if thisInputSplitneeds bootstrapping for writing.InputStreamopenInputStreamFor(String location)Open anInputStreamfor the given location.OutputStreamopenOutputStreamFor(String location)Open anOutputStreamfor the given location.voidreset()Reset the InputSplit without reinitializing it from scratch.booleanresetSupported()voidupdateSplitLocations(boolean reset)Refreshes the split locations if needed in memory.-
Methods inherited from class org.datavec.api.split.BaseInputSplit
addNewLocation, addNewLocation, canWriteToLocation, locations, locationsIterator, locationsPathIterator, sample
-
-
-
-
Constructor Detail
-
CollectionInputSplit
public CollectionInputSplit(URI[] array)
-
CollectionInputSplit
public CollectionInputSplit(Collection<URI> list)
-
-
Method Detail
-
updateSplitLocations
public void updateSplitLocations(boolean reset)
Description copied from interface:InputSplitRefreshes the split locations if needed in memory. (Think a few file gets added)
-
needsBootstrapForWrite
public boolean needsBootstrapForWrite()
Description copied from interface:InputSplitReturns true if thisInputSplitneeds bootstrapping for writing. A simple example of needing bootstrapping is forFileSplitwhere there is only a directory existing, but no file to write to- Returns:
- true if this input split needs bootstrapping for writing to or not
-
bootStrapForWrite
public void bootStrapForWrite()
Description copied from interface:InputSplitBootstrap this input split for writing. This is for use withRecordWriter
-
openOutputStreamFor
public OutputStream openOutputStreamFor(String location) throws Exception
Description copied from interface:InputSplitOpen anOutputStreamfor the given location. Note that the user is responsible for closing the associated output stream.- Parameters:
location- the location to open the output stream for- Returns:
- the output input stream
- Throws:
Exception
-
openInputStreamFor
public InputStream openInputStreamFor(String location) throws Exception
Description copied from interface:InputSplitOpen anInputStreamfor the given location. Note that the user is responsible for closing the associated input stream.- Parameters:
location- the location to open the input stream for- Returns:
- the opened input stream
- Throws:
Exception
-
length
public long length()
Description copied from interface:InputSplitLength of the split- Specified by:
lengthin interfaceInputSplit- Overrides:
lengthin classBaseInputSplit- Returns:
-
reset
public void reset()
Description copied from interface:InputSplitReset the InputSplit without reinitializing it from scratch. In many cases, this is a no-op. For InputSplits that have randomization: reset should shuffle the order.
-
resetSupported
public boolean resetSupported()
- Returns:
- True if the reset() method is supported (or is a no-op), false otherwise. If false is returned, reset() may throw an exception
-
-