jigcell.compare.transform
Class TransformEvaluationTransform

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.TransformEvaluationTransform

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, ITransform, ITransformContextListener

public class TransformEvaluationTransform
extends Transform
implements ITransformContextListener

A transform that evaluates another named transform.

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

static java.lang.String	ATTRIBUTE_TRANSFORMNAME Attribute for the name of the transform to evaluate
protected static java.lang.String	NAME_TRANSFORM Display name for this transform
static java.lang.String	OPTION_KNOWNTRANSFORMS Option for transforms that this transform knows it can invoke

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.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

TransformEvaluationTransform()
Creates a new transform to evaluate another transform.

TransformEvaluationTransform(java.lang.String transformName)
Creates a new transform to evaluate another transform.

Method Summary

protected IDataElement	evaluate() Evaluates the associated element.
ITransformAnnotation	getAnnotation() An annotation object for this generator.
static java.lang.Object	getCustomizableInstances() Generates an instance.
IDataGeneratorList	getDependencies() The dependencies of this transform. Additionally, a transform is considered dependent on the previous, next, children, and parent transforms. This function may return any subset of dependencies with the same transitive closure as the full set. A null result may be used to indicate that no dependencies exist.
java.util.Set	getKnownTransforms() The transforms known to this transform.
protected ITransform	getReferencedTransform() The transform to invoke.
java.lang.String	getTransformName() The name of the transform to execute.
boolean	isRunnable() Whether this transform can be executed.
void	setEvaluationContext(ITransformContext context) Sets the runtime context for performing an evaluation.
protected void	setKnownTransforms(java.util.Set transforms) Sets the transforms known to this transform.
void	setTransformName(java.lang.String transformName) Sets the name of the transform to execute.
void	transformAdded(ITransformContext context, ITransform transform, java.lang.String name) Notification that a transform was added to a context.
void	transformRemoved(ITransformContext context, ITransform transform, java.lang.String name) Notification that a transform was removed from a context.

Methods inherited from class jigcell.compare.transform.Transform

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

Methods inherited from class jigcell.compare.data.ProgrammableDataGenerator

addEvaluationListener, createCustomizer, fireEvaluationError, fireEvaluationError, fireEvaluationStart, fireEvaluationStop, getAllowDescriptionQuery, getCallStack, getElement, getElement, getEvaluationLock, getInputTypeChecker, getInterface, getOutputTypeChecker, isCached, peekElement, peekInterface, propertyChange, 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.IProgrammableDataGenerator

addEvaluationListener, getCallStack, getElement, getEvaluationLock, getInputTypeChecker, getInterface, getOutputTypeChecker, 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

ATTRIBUTE_TRANSFORMNAME

public static final java.lang.String ATTRIBUTE_TRANSFORMNAME

Attribute for the name of the transform to evaluate

See Also:

Constant Field Values

OPTION_KNOWNTRANSFORMS

public static final java.lang.String OPTION_KNOWNTRANSFORMS

Option for transforms that this transform knows it can invoke

See Also:

Constant Field Values

NAME_TRANSFORM

protected static final java.lang.String NAME_TRANSFORM

Display name for this transform

See Also:

Constant Field Values

Constructor Detail

TransformEvaluationTransform

public TransformEvaluationTransform()

Creates a new transform to evaluate another transform.

TransformEvaluationTransform

public TransformEvaluationTransform(java.lang.String transformName)

Creates a new transform to evaluate another transform.

Parameters:

transformName - Name of transform to evaluate

Method Detail

getCustomizableInstances

public static java.lang.Object getCustomizableInstances()

Generates an instance.

getAnnotation

public ITransformAnnotation getAnnotation()

An annotation object for this generator.

Specified by:

getAnnotation in interface ITransform

Overrides:

getAnnotation in class Transform

getDependencies

public IDataGeneratorList getDependencies()

The dependencies of this transform. Additionally, a transform is considered dependent on the previous, next, children, and parent transforms. This function may return any subset of dependencies with the same transitive closure as the full set. A null result may be used to indicate that no dependencies exist.

Specified by:

getDependencies in interface ITransform

Overrides:

getDependencies in class Transform

getKnownTransforms

public java.util.Set getKnownTransforms()

The transforms known to this transform.

getTransformName

public java.lang.String getTransformName()

The name of the transform to execute.

isRunnable

public boolean isRunnable()

Whether this transform can be executed.

Specified by:

isRunnable in interface ITransform

Overrides:

isRunnable in class Transform

setEvaluationContext

public void setEvaluationContext(ITransformContext context)

Sets the runtime context for performing an evaluation.

Specified by:

setEvaluationContext in interface ITransform

Overrides:

setEvaluationContext in class Transform

Parameters:

context - Evaluation context

setTransformName

public void setTransformName(java.lang.String transformName)

Sets the name of the transform to execute.

Parameters:

transformName - Transform name

transformAdded

public void transformAdded(ITransformContext context,
                           ITransform transform,
                           java.lang.String name)

Notification that a transform was added to a context.

Specified by:

transformAdded in interface ITransformContextListener

Parameters:

context - Context

transform - Transform

name - Name transform is registering with

transformRemoved

public void transformRemoved(ITransformContext context,
                             ITransform transform,
                             java.lang.String name)

Notification that a transform was removed from a context.

Specified by:

transformRemoved in interface ITransformContextListener

Parameters:

context - Context

transform - Transform

name - Name transform registered with

evaluate

protected IDataElement evaluate()

Evaluates the associated element.

Overrides:

evaluate in class Transform

getReferencedTransform

protected ITransform getReferencedTransform()

The transform to invoke. Returns null if the transform to run is not specified or found.

setKnownTransforms

protected void setKnownTransforms(java.util.Set transforms)

Sets the transforms known to this transform.

Parameters:

transforms - Transforms