jigcell.compare.transform
Class ConstantTransform

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

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 ConstantTransform
extends Transform
implements IResultantTransform

Transform for testing and use as a stub. A fixed input for other transforms.

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 javax.swing.JComponent	displayComponent Information to display for transform interface
protected IDataElement	value Value to generate

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

ConstantTransform()
Creates a new transform with constant value.

ConstantTransform(IDataElement value)
Creates a new transform with constant value.

Method Summary

protected void	copy(boolean shallow, IDataGenerator target) Copies state for this generator.
protected IDataElement	evaluate(IDataElement input) Evaluates the transform.
static java.lang.Object	getCustomizableInstances() Generates an instance.
javax.swing.JComponent	getDisplayComponent() The component that will be displayed in the transform interface.
java.lang.String	getResultName() The name of the result to publish or null if this transform does not publish a result.
IDataElement	getValue() The value this transform will generate.
void	setAnnotation(ITransformAnnotation annotation) Sets the annotation data for this transform.
void	setDisplayComponent(javax.swing.JComponent displayComponent) Sets the information to display in the transform interface.
void	setValue(IDataElement value) Sets the value this transform will generate.

Methods inherited from class jigcell.compare.transform.Transform

clear, evaluate, flush, getAllowContextInsertion, getAllowContextRemoval, getAnnotation, getCompatibleTransforms, getContainer, getDependencies, getEvaluationContext, getNextStatement, getPreviousElement, getPreviousStatement, getSource, getTransformForGenerator, hasNextStatement, hasPreviousStatement, initializeSource, isReorderable, isRunnable, setAllowContextInsertion, setAllowContextRemoval, 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, 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.transform.ITransform

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

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

value

protected IDataElement value

Value to generate

displayComponent

protected javax.swing.JComponent displayComponent

Information to display for transform interface

Constructor Detail

ConstantTransform

public ConstantTransform()

Creates a new transform with constant value.

ConstantTransform

public ConstantTransform(IDataElement value)

Creates a new transform with constant value.

Parameters:

value - Value

Method Detail

getCustomizableInstances

public static java.lang.Object getCustomizableInstances()

Generates an instance.

getDisplayComponent

public javax.swing.JComponent getDisplayComponent()

The component that will be displayed in the transform interface.

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

getValue

public IDataElement getValue()

The value this transform will generate.

setAnnotation

public void setAnnotation(ITransformAnnotation annotation)

Sets the annotation data for this transform.

Overrides:

setAnnotation in class Transform

Parameters:

annotation - Annotation

setDisplayComponent

public void setDisplayComponent(javax.swing.JComponent displayComponent)

Sets the information to display in the transform interface.

Parameters:

displayComponent - Display component

setValue

public void setValue(IDataElement value)

Sets the value this transform will generate.

Parameters:

value - Value

copy

protected void copy(boolean shallow,
                    IDataGenerator target)

Copies state for this generator.

Overrides:

copy in class Transform

Parameters:

shallow - Whether the copy is shallow

target - Generator to copy to

evaluate

protected IDataElement evaluate(IDataElement input)

Evaluates the transform.

Overrides:

evaluate in class Transform

Parameters:

input - Transform input