Package adams.flow.transformer

Class ArrayCombinations

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.transformer.AbstractTransformer

adams.flow.transformer.ArrayCombinations

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

public class ArrayCombinations
extends AbstractTransformer

Turns an array of any type into a sequence of array combinations of given size.

Input/output:
- accepts:
adams.flow.core.Unknown[]
- generates:
adams.flow.core.Unknown


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
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: ArrayCombinations
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-length <int> (property: length)
    the r in nCr
    default: 1
    minimum: 1
 

-subsets <COMBINATIONS|PERMUTATIONS> (property: subsets)
    combinations or permutations.
    default: COMBINATIONS
 

Version:

$Revision$

Author:

Dale (dale at cs dot waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArrayCombinations.SubsetsType	Defines whether to do combinations or permutations.

Field Summary

Fields

Modifier and Type	Field	Description
static String	BACKUP_ELEMENTS	the key for storing the current counter in the backup.
protected List	m_Elements	the remaining elements of the array that still need to be broadcasted.
protected int	m_Length	number of elements in subarray,
protected ArrayCombinations.SubsetsType	m_Subsets	the subset type.

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Constructors

Constructor	Description
ArrayCombinations()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
protected Hashtable<String,Object>	backupState()	Backs up the current state of the actor before update the variables.
protected Object[]	combine(Object o, Object[] arr)
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the flow item.
protected Vector<Object[]>	genCombinations(Object[] in, int num)
Class[]	generates()	Returns the class of objects that it generates.
int	getLength()	Get length.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
ArrayCombinations.SubsetsType	getSubsets()	combinations or permutations.
String	globalInfo()	Returns a string describing the object.
boolean	hasPendingOutput()	Checks whether there is pending output to be collected after executing the flow item.
String	lengthTipText()	Returns the tip text for this property.
Token	output()	Returns the generated token.
protected void	pruneBackup()	Removes entries from the backup.
protected Object[]	remove(Object[] obj, int pos)
protected Object[]	removeUpToIncluding(Object[] obj, int pos)
protected void	reset()	Resets the scheme.
protected void	restoreState(Hashtable<String,Object> state)	Restores the state of the actor before the variables got updated.
void	setLength(int len)	Set length.
void	setSubsets(ArrayCombinations.SubsetsType value)	Choose combinations or permutations.
String	subsetsTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.AbstractTransformer

currentInput, execute, hasInput, input, postExecute, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

BACKUP_ELEMENTS

public static final String BACKUP_ELEMENTS

the key for storing the current counter in the backup.

See Also:

Constant Field Values

m_Length

protected int m_Length

number of elements in subarray,

m_Elements

protected List m_Elements

the remaining elements of the array that still need to be broadcasted.

m_Subsets

protected ArrayCombinations.SubsetsType m_Subsets

the subset type.

Constructor Detail

ArrayCombinations

public ArrayCombinations()

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 AbstractActor

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface Actor

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setSubsets

public void setSubsets(ArrayCombinations.SubsetsType value)

Choose combinations or permutations.

Parameters:

value - the action

getSubsets

public ArrayCombinations.SubsetsType getSubsets()

combinations or permutations.

Returns:

the action

subsetsTipText

public String subsetsTipText()

Returns the tip text for this property.

Returns:

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

setLength

public void setLength(int len)

Set length.

Parameters:

len - length

getLength

public int getLength()

Get length.

Returns:

length

lengthTipText

public String lengthTipText()

Returns the tip text for this property.

Returns:

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

pruneBackup

protected void pruneBackup()

Removes entries from the backup.

Overrides:

pruneBackup in class AbstractActor

See Also:

AbstractActor.reset()

backupState

protected Hashtable<String,Object> backupState()

Backs up the current state of the actor before update the variables.

Overrides:

backupState in class AbstractTransformer

Returns:

the backup

See Also:

AbstractActor.updateVariables(), AbstractActor.restoreState(Hashtable)

restoreState

protected void restoreState(Hashtable<String,Object> state)

Restores the state of the actor before the variables got updated.

Overrides:

restoreState in class AbstractTransformer

Parameters:

state - the backup of the state to restore from

See Also:

AbstractActor.updateVariables(), AbstractActor.backupState()

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractActor

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

adams.flow.core.Unknown[].class

generates

public Class[] generates()

Returns the class of objects that it generates.

Returns:

adams.flow.core.Unknown.class

output

public Token output()

Returns the generated token.

Specified by:

output in interface OutputProducer

Overrides:

output in class AbstractTransformer

Returns:

the generated token

hasPendingOutput

public boolean hasPendingOutput()

Checks whether there is pending output to be collected after executing the flow item.

Specified by:

hasPendingOutput in interface OutputProducer

Overrides:

hasPendingOutput in class AbstractTransformer

Returns:

true if there is pending output

remove

protected Object[] remove(Object[] obj,
                          int pos)

removeUpToIncluding

protected Object[] removeUpToIncluding(Object[] obj,
                                       int pos)

combine

protected Object[] combine(Object o,
                           Object[] arr)

genCombinations

protected Vector<Object[]> genCombinations(Object[] in,
                                           int num)

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message