jigcell.compare.transform
Class InputTransform

java.lang.Object
  javax.swing.TransferHandler
      jigcell.compare.impl.Transferer
          jigcell.compare.impl.DataSource
              jigcell.compare.data.DataGenerator
                  jigcell.compare.data.EditableDataGenerator
                      jigcell.compare.data.ProgrammableDataGenerator
                          jigcell.compare.transform.Transform
                              jigcell.compare.transform.InputTransform

All Implemented Interfaces:

java.awt.datatransfer.Transferable, java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, IDataGenerator, IDataSource, IEditableDataGenerator, IProgrammableDataGenerator, IReadableDataSource, IWriteableDataSource, IResultantTransform, ITransform

public class InputTransform
extends Transform
implements IResultantTransform

Allows selection of a transform to create a transform chain. Also serves as a distinguished execution checkpoint.

This code is licensed under the DARPA BioCOMP Open Source License. See LICENSE for more details.

Author:

Nicholas Allen

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class jigcell.compare.data.EditableDataGenerator

EditableDataGenerator.EditableDataGeneratorDelegate

Nested classes/interfaces inherited from interface jigcell.compare.IDataSource

IDataSource.Option

Field Summary

protected static java.lang.String	MESSAGE_RESULTNAMEEDITERROR Error message when an attempt is made to edit the result name when the result name is not editable
static java.lang.String	OPTION_RESULTNAMEEDIT Attribute for whether the result name this transform uses can be edited
static java.lang.String	OPTION_RUNNABLE Attribute for whether this transform is permitted to run

Fields inherited from class jigcell.compare.transform.Transform

allowContextInsertion, allowContextRemoval, container, context

Fields inherited from class jigcell.compare.data.ProgrammableDataGenerator

allowDescriptionQuery, callStack, listenerList

Fields inherited from class jigcell.compare.data.DataGenerator

COMPARATOR_NAME, DESCRIPTION_READ, SEPARATOR_ESCAPE, SPECIAL_CHARS

Fields inherited from class jigcell.compare.impl.DataSource

OPTIONS_LOCK, SEPARATOR_PAIR, SEPARATOR_PART, SEPARATORS

Fields inherited from class jigcell.compare.impl.Transferer

CSV_FOOTER, CSV_LINEPOSTPEND, CSV_LINEPREPEND, CSV_LINESEPARATOR, HTML_FOOTER, HTML_HEADPOSTPEND, HTML_HEADPREPEND, HTML_HEADSEPARATOR, HTML_LINEPOSTPEND, HTML_LINEPREPEND, HTML_LINESEPARATOR

Fields inherited from class javax.swing.TransferHandler

COPY, COPY_OR_MOVE, MOVE, NONE

Fields inherited from interface jigcell.compare.transform.IResultantTransform

ATTRIBUTE_RESULTNAME

Fields inherited from interface jigcell.compare.transform.ITransform

OPTION_ANNOTATION, OPTION_COMPATIBLE, OPTION_NEXTSTATEMENT, OPTION_PREVIOUSSTATEMENT, OPTION_TRANSFORM, PROPERTY_TRANSFORM_EDIT, RESOURCE_TRANSFORMS

Fields inherited from interface jigcell.compare.IProgrammableDataGenerator

METHOD_GENERATE, OPTION_COMPARE, OPTION_INPUTTYPECHECKER, OPTION_OUTPUTTYPECHECKER

Fields inherited from interface jigcell.compare.IDataGenerator

ATTRIBUTE_COMMENT, ATTRIBUTE_GUID, PROPERTY_GENERATOR_EDIT, RESOURCE_GENERATORS

Fields inherited from interface jigcell.compare.IReadableDataSource

OPTION_READDESCRIPTION, OPTION_READICON

Fields inherited from interface jigcell.compare.IDataSource

OPTION_NAME

Fields inherited from interface jigcell.compare.IWriteableDataSource

OPTION_WRITEDESCRIPTION, OPTION_WRITEICON

Constructor Summary

InputTransform()

Method Summary

boolean	getAllowResultNameEditing() Whether result name editing is allowed.
ITypeChecker	getOutputTypeChecker() Type checker that can validate the output from this generator.
java.lang.String	getResultName() The name of the result to publish or null if this transform does not publish a result.
boolean	isRunnable() Whether this transform can be executed.
boolean	isRunnableSet() Whether the runnable flag is set for this transform.
void	propertyChange(java.beans.PropertyChangeEvent e)
protected void	setAllowResultNameEditing(boolean allow) Sets whether result name editing is allowed.
void	setResultName(java.lang.String resultName) Sets the result name to publish.
void	setResultName(java.lang.String resultName, boolean lock) Sets the result name to publish.
void	setRunnable(boolean runnable) Sets whether the transform is runnable.

Methods inherited from class jigcell.compare.transform.Transform

clear, copy, evaluate, evaluate, flush, getAllowContextInsertion, getAllowContextRemoval, getAnnotation, getCompatibleTransforms, getContainer, getDependencies, getEvaluationContext, getNextStatement, getPreviousElement, getPreviousStatement, getSource, getTransformForGenerator, hasNextStatement, hasPreviousStatement, initializeSource, isReorderable, setAllowContextInsertion, setAllowContextRemoval, setAnnotation, setCompatibleTransforms, setContainer, setEvaluationContext, setNextStatement, setPreviousStatement

Methods inherited from class jigcell.compare.data.ProgrammableDataGenerator

addEvaluationListener, createCustomizer, fireEvaluationError, fireEvaluationError, fireEvaluationStart, fireEvaluationStop, getAllowDescriptionQuery, getCallStack, getElement, getElement, getEvaluationLock, getInputTypeChecker, getInterface, isCached, peekElement, peekInterface, removeEvaluationListener, setAllowDescriptionQuery, setInputTypeChecker, setInterfaceClass, setOutputTypeChecker, updateInterface

Methods inherited from class jigcell.compare.data.EditableDataGenerator

getPredictedCompatibility, getPredictedCompatibility, isSet, setAttribute, setComment, setElement, setElement, setOption, setState, write

Methods inherited from class jigcell.compare.data.DataGenerator

clone, compareByName, copy, generateGUID, getAttribute, getComment, getCopiedFrom, getName, getPredictedContents, getTransferData, isCopy, isCopyRelated, read, setCopyName, setName, toString

Methods inherited from class jigcell.compare.impl.DataSource

addOption, addPropertyChangeListener, addPropertyChangeListener, configure, getOption, getOptions, getOptionType, getPropertyChangeListeners, getPropertyChangeListeners, getReadDescriptionOption, getReadIconOption, getState, getWriteDescriptionOption, getWriteIconOption, persistSource, removePropertyChangeListener, removePropertyChangeListener, setOptions, setOptionType, setReadDescriptionOption, setReadIconOption, setWriteDescriptionOption, setWriteIconOption, unpersistSource

Methods inherited from class jigcell.compare.impl.Transferer

addExtension, addFlavor, createCSVTable, createFormattedTable, createHTMLTable, getExceptionRecorder, getExpectedClasses, getExpectedClasses, getExpectedClasses, getFlavors, getFlavors, getPreferredExtensions, getPreferredExtensions, getTransferClass, getTransferDataFlavors, getTransferFlavor, isDataFlavorSupported, transfer

Methods inherited from class javax.swing.TransferHandler

canImport, createTransferable, exportAsDrag, exportDone, exportToClipboard, getCopyAction, getCutAction, getPasteAction, getSourceActions, getVisualRepresentation, importData

Methods inherited from class java.lang.Object

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

Methods inherited from interface jigcell.compare.transform.ITransform

clear, flush, getAnnotation, getCompatibleTransforms, getContainer, getDependencies, getEvaluationContext, getNextStatement, getPreviousStatement, hasNextStatement, hasPreviousStatement, isReorderable, setCompatibleTransforms, setContainer, setEvaluationContext, setNextStatement, setPreviousStatement

Methods inherited from interface jigcell.compare.IProgrammableDataGenerator

addEvaluationListener, getCallStack, getElement, getEvaluationLock, getInputTypeChecker, getInterface, peekElement, removeEvaluationListener

Methods inherited from interface jigcell.compare.IEditableDataGenerator

setComment, setCopyName, setElement, setName

Methods inherited from interface jigcell.compare.IDataGenerator

copy, getAttribute, getComment, getCopiedFrom, getElement, isCached, isCopy, isCopyRelated, setAttribute

Methods inherited from interface jigcell.compare.IReadableDataSource

getPredictedContents, getReadDescriptionOption, getReadIconOption, read, setReadDescriptionOption, setReadIconOption

Methods inherited from interface jigcell.compare.IDataSource

addOption, clone, configure, getName, getOption, getState, setOption, setState

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface jigcell.compare.IWriteableDataSource

getPredictedCompatibility, getPredictedCompatibility, getWriteDescriptionOption, getWriteIconOption, setWriteDescriptionOption, setWriteIconOption, write

Field Detail

OPTION_RESULTNAMEEDIT

public static final java.lang.String OPTION_RESULTNAMEEDIT

Attribute for whether the result name this transform uses can be edited

See Also:

Constant Field Values

OPTION_RUNNABLE

public static final java.lang.String OPTION_RUNNABLE

Attribute for whether this transform is permitted to run

See Also:

Constant Field Values

MESSAGE_RESULTNAMEEDITERROR

protected static final java.lang.String MESSAGE_RESULTNAMEEDITERROR

Error message when an attempt is made to edit the result name when the result name is not editable

See Also:

Constant Field Values

Constructor Detail

InputTransform

public InputTransform()

Method Detail

getAllowResultNameEditing

public boolean getAllowResultNameEditing()

Whether result name editing is allowed.

getOutputTypeChecker

public ITypeChecker getOutputTypeChecker()

Type checker that can validate the output from this generator.

Specified by:

getOutputTypeChecker in interface IProgrammableDataGenerator

Overrides:

getOutputTypeChecker in class ProgrammableDataGenerator

getResultName

public java.lang.String getResultName()

The name of the result to publish or null if this transform does not publish a result.

Specified by:

getResultName in interface IResultantTransform

isRunnable

public boolean isRunnable()

Whether this transform can be executed.

Specified by:

isRunnable in interface ITransform

Overrides:

isRunnable in class Transform

isRunnableSet

public boolean isRunnableSet()

Whether the runnable flag is set for this transform.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Overrides:

propertyChange in class ProgrammableDataGenerator

setResultName

public void setResultName(java.lang.String resultName)

Sets the result name to publish.

Parameters:

resultName - Result name

setResultName

public void setResultName(java.lang.String resultName,
                          boolean lock)

Sets the result name to publish.

Parameters:

resultName - Result name

lock - Whether users should be prevented from changing this name

setRunnable

public void setRunnable(boolean runnable)

Sets whether the transform is runnable.

Parameters:

runnable - Whether the transform is runnable

setAllowResultNameEditing

protected void setAllowResultNameEditing(boolean allow)

Sets whether result name editing is allowed.

Parameters:

allow - Allowed