org.datavec.api.split

Class FileSplit

java.lang.Object

org.datavec.api.split.BaseInputSplit

org.datavec.api.split.FileSplit

All Implemented Interfaces:

Serializable, InputSplit, Writable

public class FileSplit
extends BaseInputSplit

File input split. Splits up a root directory in to files.

Author:

Adam Gibson

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	allowFormat
protected Random	random
protected boolean	randomize
protected boolean	recursive
protected File	rootDir

Fields inherited from class org.datavec.api.split.BaseInputSplit

iterationOrder, length, uriStrings

Constructor Summary

Constructors

Modifier	Constructor and Description
	FileSplit(File rootDir)
	FileSplit(File rootDir, Random rng)
	FileSplit(File rootDir, String[] allowFormat)
	FileSplit(File rootDir, String[] allowFormat, boolean recursive)
protected	FileSplit(File rootDir, String[] allowFormat, boolean recursive, Random random, boolean runMain)
	FileSplit(File rootDir, String[] allowFormat, Random rng)

Method Summary

Modifier and Type	Method and Description
File	getRootDir()
WritableType	getType()
protected void	initialize()
long	length() Length of the split
void	readFields(DataInput in) Deserialize the fields of this object from in.
void	reset() Reset the InputSplit without reinitializing it from scratch.
void	write(DataOutput out) Serialize the fields of this object to out.

Methods inherited from class org.datavec.api.split.BaseInputSplit

locations, locationsIterator, locationsPathIterator, sample, toDouble, toFloat, toInt, toLong, writeType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rootDir

protected File rootDir

allowFormat

protected String[] allowFormat

recursive

protected boolean recursive

random

protected Random random

randomize

protected boolean randomize

Constructor Detail

FileSplit

protected FileSplit(File rootDir,
                    String[] allowFormat,
                    boolean recursive,
                    Random random,
                    boolean runMain)

FileSplit

public FileSplit(File rootDir)

FileSplit

public FileSplit(File rootDir,
                 Random rng)

FileSplit

public FileSplit(File rootDir,
                 String[] allowFormat)

FileSplit

public FileSplit(File rootDir,
                 String[] allowFormat,
                 Random rng)

FileSplit

public FileSplit(File rootDir,
                 String[] allowFormat,
                 boolean recursive)

Method Detail

initialize

protected void initialize()

length

public long length()

Description copied from interface: InputSplit

Length of the split

Specified by:

length in interface InputSplit

Overrides:

length in class BaseInputSplit

Returns:

reset

public void reset()

Description copied from interface: InputSplit

Reset 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.

write

public void write(DataOutput out)
           throws IOException

Description copied from interface: Writable

Serialize the fields of this object to out.

Parameters:

out - DataOuput to serialize this object into.

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Description copied from interface: Writable

Deserialize the fields of this object from in.

For efficiency, implementations should attempt to re-use storage in the existing object where possible.

Parameters:

in - DataInput to deseriablize this object from.

Throws:

IOException

getType

public WritableType getType()

Specified by:

getType in interface Writable

Overrides:

getType in class BaseInputSplit

getRootDir

public File getRootDir()