Package adams.flow.transformer.splitfile

Interface FileSplitter

All Superinterfaces:

Destroyable, OptionHandler, Stoppable

All Known Subinterfaces:

FileSplitterWithBinarySupport

All Known Implementing Classes:

AbstractFileSplitter, AbstractFileSplitterWithBinarySupport, SplitByLineCount, SplitByNumber, SplitBySize

public interface FileSplitter
extends OptionHandler, Stoppable

Interface for file splitters.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
String	extensionTipText()	Returns the tip text for this property.
String	getExtension()	Returns the extension for the generated files.
int	getNumDigits()	Returns the number of digits to use for the index of the generated files.
PlaceholderFile	getPrefix()	Returns the prefix for the generated files.
String	numDigitsTipText()	Returns the tip text for this property.
String	prefixTipText()	Returns the tip text for this property.
void	setExtension(String value)	Sets the extension for the generated files.
void	setNumDigits(int value)	Sets the number of digits to use for the index of the generated files.
void	setPrefix(PlaceholderFile value)	Sets the prefix for the generated files.
String[]	split(PlaceholderFile file)	Splits the file and returns the filenames of the generated files.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.Stoppable

stopExecution

Method Detail

setPrefix

void setPrefix(PlaceholderFile value)

Sets the prefix for the generated files.

Parameters:

value - the prefix

getPrefix

PlaceholderFile getPrefix()

Returns the prefix for the generated files.

Returns:

the prefix

prefixTipText

String prefixTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setExtension

void setExtension(String value)

Sets the extension for the generated files.

Parameters:

value - the extension

getExtension

String getExtension()

Returns the extension for the generated files.

Returns:

the extension

extensionTipText

String extensionTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setNumDigits

void setNumDigits(int value)

Sets the number of digits to use for the index of the generated files.

Parameters:

value - the number of digits

getNumDigits

int getNumDigits()

Returns the number of digits to use for the index of the generated files.

Returns:

the number of digits

numDigitsTipText

String numDigitsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

split

String[] split(PlaceholderFile file)

Splits the file and returns the filenames of the generated files.

Parameters:

file - the file to split

Returns:

the filenames of the new files generated