Package adams.flow.sink.sequenceplotter

Class SimplePruning

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.sink.sequenceplotter.AbstractSequencePostProcessor

adams.flow.sink.sequenceplotter.SimplePruning

All Implemented Interfaces:

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

Direct Known Subclasses:

AligningSequences

public class SimplePruning
extends AbstractSequencePostProcessor

Simply prunes the sequences at the head if they exceed a pre-defined size limit.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-limit <int> (property: limit)
    The size limit for sequences; use -1 for unlimited.
    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_Limit	the size limit for sequences.

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
SimplePruning()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
int	getLimit()	Returns the size limit.
String	globalInfo()	Returns a string describing the object.
String	limitTipText()	Returns the tip text for this property.
boolean	postProcess(XYSequenceContainerManager manager, String plotName)	Post-processes the sequences.
void	setLimit(int value)	Sets the size limit.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, 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_Limit

protected int m_Limit

the size limit for sequences.

Constructor Detail

SimplePruning

public SimplePruning()

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 AbstractOptionHandler

setLimit

public void setLimit(int value)

Sets the size limit.

Parameters:

value - the limit

getLimit

public int getLimit()

Returns the size limit.

Returns:

the limit

limitTipText

public String limitTipText()

Returns the tip text for this property.

Returns:

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

postProcess

public boolean postProcess(XYSequenceContainerManager manager,
                           String plotName)

Post-processes the sequences.

Specified by:

postProcess in class AbstractSequencePostProcessor

Parameters:

manager - the sequence manager

plotName - the plot that was modified

Returns:

true if any sequence was modified