jigcell.compare.transform
Interface ITransform

All Superinterfaces:

java.lang.Cloneable, IDataGenerator, IDataSource, IEditableDataGenerator, IProgrammableDataGenerator, IReadableDataSource, IWriteableDataSource, java.awt.datatransfer.Transferable

All Known Subinterfaces:

IResultantTransform, ITransformContainer

All Known Implementing Classes:

BoxTransformContainer, BuddingYeastScanTransform, ConstantTransform, DispatchedTransformHelper, DispatchedTransformTemplate, ExtremaTestTransform, FileTransform, GenericScanTransform, InputTransform, JigCellRunManagerTransform, MethodDispatcherTests.DispatchedTransform, ReadFromFileTransform, ScriptEvaluationTransform, SelectColumnsTransform, Transform, TransformContainer, TransformEvaluationTransform, TransformHelper, TransformTemplate, WildtypeScanTransform, WriteToFileTransform

public interface ITransform
extends IProgrammableDataGenerator

A DataGenerator that performs a part of a transform evaluation.

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

Author:

Nicholas Allen

Nested Class Summary

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

IDataSource.Option

Field Summary

static java.lang.String	OPTION_ANNOTATION Option for the annotation record
static java.lang.String	OPTION_COMPATIBLE Attribute for the list of transforms compatible with this generator
static java.lang.String	OPTION_NEXTSTATEMENT Option for the next statement of this transform
static java.lang.String	OPTION_PREVIOUSSTATEMENT Option for the previous statement of this transform
static java.lang.String	OPTION_TRANSFORM Attribute key for the transform
static java.lang.String	PROPERTY_TRANSFORM_EDIT Property key for notifications that a transform has changed
static java.lang.String	RESOURCE_TRANSFORMS Resource key for the list of available transform functions

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

Method Summary

void	clear() Destroys all work done by this generator.
void	flush() Destroys all work leading into this generator.
ITransformAnnotation	getAnnotation() An annotation object for this generator.
IDataGeneratorList	getCompatibleTransforms() The transforms compatible with this statement.
ITransformContainer	getContainer() The container of this transform.
IDataGeneratorList	getDependencies() The dependencies of this transform.
ITransformContext	getEvaluationContext() The runtime context for performing an evaluation.
ITransform	getNextStatement() The next generator in the sequence of transforms.
ITransform	getPreviousStatement() The previous generator in the sequence of transforms.
boolean	hasNextStatement() Whether this transform has a next statement.
boolean	hasPreviousStatement() Whether this transform has a previous statement.
boolean	isReorderable() Whether the evaluation of this transform has no indirect dependencies.
boolean	isRunnable() Whether this transform can be executed.
void	setCompatibleTransforms(IDataGeneratorList transforms) Sets the transforms compatible with this statement.
void	setContainer(ITransformContainer container) Sets the container of this transform.
void	setEvaluationContext(ITransformContext context) Sets the runtime context for performing an evaluation.
void	setNextStatement(ITransform generator) The next generator in the sequence of transforms.
void	setPreviousStatement(ITransform generator) Sets the previous generator in the sequence of transforms.

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

OPTION_ANNOTATION

static final java.lang.String OPTION_ANNOTATION

Option for the annotation record

See Also:

Constant Field Values

OPTION_COMPATIBLE

static final java.lang.String OPTION_COMPATIBLE

Attribute for the list of transforms compatible with this generator

See Also:

Constant Field Values

OPTION_NEXTSTATEMENT

static final java.lang.String OPTION_NEXTSTATEMENT

Option for the next statement of this transform

See Also:

Constant Field Values

OPTION_PREVIOUSSTATEMENT

static final java.lang.String OPTION_PREVIOUSSTATEMENT

Option for the previous statement of this transform

See Also:

Constant Field Values

OPTION_TRANSFORM

static final java.lang.String OPTION_TRANSFORM

Attribute key for the transform

See Also:

Constant Field Values

PROPERTY_TRANSFORM_EDIT

static final java.lang.String PROPERTY_TRANSFORM_EDIT

Property key for notifications that a transform has changed

See Also:

Constant Field Values

RESOURCE_TRANSFORMS

static final java.lang.String RESOURCE_TRANSFORMS

Resource key for the list of available transform functions

See Also:

Constant Field Values

Method Detail

clear

void clear()

Destroys all work done by this generator.

Specified by:

clear in interface IEditableDataGenerator

flush

void flush()

Destroys all work leading into this generator.

getAnnotation

ITransformAnnotation getAnnotation()

An annotation object for this generator.

getCompatibleTransforms

IDataGeneratorList getCompatibleTransforms()

The transforms compatible with this statement.

getContainer

ITransformContainer getContainer()

The container of this transform.

getDependencies

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.

getEvaluationContext

ITransformContext getEvaluationContext()

The runtime context for performing an evaluation.

getNextStatement

ITransform getNextStatement()

The next generator in the sequence of transforms.

getPreviousStatement

ITransform getPreviousStatement()

The previous generator in the sequence of transforms.

hasNextStatement

boolean hasNextStatement()

Whether this transform has a next statement.

hasPreviousStatement

boolean hasPreviousStatement()

Whether this transform has a previous statement.

isReorderable

boolean isReorderable()

Whether the evaluation of this transform has no indirect dependencies.

isRunnable

boolean isRunnable()

Whether this transform can be executed.

setCompatibleTransforms

void setCompatibleTransforms(IDataGeneratorList transforms)

Sets the transforms compatible with this statement.

Parameters:

transforms - Compatible transforms

setContainer

void setContainer(ITransformContainer container)

Sets the container of this transform.

Parameters:

container - Container

setEvaluationContext

void setEvaluationContext(ITransformContext context)

Sets the runtime context for performing an evaluation.

Parameters:

context - Evaluation context

setNextStatement

void setNextStatement(ITransform generator)

The next generator in the sequence of transforms.

Parameters:

generator - Next generator

setPreviousStatement

void setPreviousStatement(ITransform generator)

Sets the previous generator in the sequence of transforms.

Parameters:

generator - Previous generator