Package adams.flow.transformer.splitfile

Class SplitByNumber

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.splitfile.AbstractFileSplitter

adams.flow.transformer.splitfile.SplitByNumber

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Stoppable, Serializable

public class SplitByNumber
extends AbstractFileSplitter

Splits the file into a number of equally sized files.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-prefix <adams.core.io.PlaceholderFile> (property: prefix)
    The prefix for the generated files.
    default: ./split
 

-extension <java.lang.String> (property: extension)
    The file extension to use.
    default: .bin
 

-num-digits <int> (property: numDigits)
    The number of digits to use for the index of the generated files.
    default: 3
    minimum: 1
 

-num-files <int> (property: numFiles)
    The number of files to generate.
    default: 1
    minimum: 1
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_NumFiles	the number of files.

Fields inherited from class adams.flow.transformer.splitfile.AbstractFileSplitter

m_Extension, m_Generated, m_NumDigits, m_Prefix, m_Stopped

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
SplitByNumber()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doSplit(PlaceholderFile file)	Performs the actual splitting of the file.
int	getNumFiles()	Returns the number of files.
String	globalInfo()	Returns a string describing the object.
String	numFilesTipText()	Returns the tip text for this property.
void	setNumFiles(int value)	Sets the number the files.

Methods inherited from class adams.flow.transformer.splitfile.AbstractFileSplitter

check, extensionTipText, getExtension, getNumDigits, getPrefix, nextFile, numDigitsTipText, prefixTipText, reset, setExtension, setNumDigits, setPrefix, split, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_NumFiles

protected int m_NumFiles

the number of files.

Constructor Detail

SplitByNumber

public SplitByNumber()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractFileSplitter

setNumFiles

public void setNumFiles(int value)

Sets the number the files.

Parameters:

value - the number

getNumFiles

public int getNumFiles()

Returns the number of files.

Returns:

the number

numFilesTipText

public String numFilesTipText()

Returns the tip text for this property.

Returns:

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

doSplit

protected void doSplit(PlaceholderFile file)

Performs the actual splitting of the file.

Specified by:

doSplit in class AbstractFileSplitter

Parameters:

file - the file to split