jigcell.compare.objective
Interface IObjective

All Superinterfaces:

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

All Known Implementing Classes:

BooleanRelationalObjective, BuddingYeastPhenotypeObjective, GenericPhenotypeObjective, MetricObjective, MinkowskiObjective, Objective, ObjectiveHelper, ObjectiveTemplate, ScriptEvaluationObjective, WOSSObjective

public interface IObjective
extends IProgrammableDataGenerator

A DataGenerator that takes a functional expression and a collection of data to produce an element.

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_OBJECTIVE Option for the objective function
static java.lang.String	PROPERTY_OBJECTIVE_EDIT Property key for notifications that a function has changed
static java.lang.String	RESOURCE_OBJECTIVES Resource key for the list of available objective 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.
IDataGeneratorList	getData() The set of data used.
java.lang.String	getFunction() The function used for the objective computation.
void	setData(IDataGeneratorList data) Sets the collection of data to draw from.
void	setFunction(java.lang.String function) Sets the function used to compute the objective.

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_OBJECTIVE

static final java.lang.String OPTION_OBJECTIVE

Option for the objective function

See Also:

Constant Field Values

PROPERTY_OBJECTIVE_EDIT

static final java.lang.String PROPERTY_OBJECTIVE_EDIT

Property key for notifications that a function has changed

See Also:

Constant Field Values

RESOURCE_OBJECTIVES

static final java.lang.String RESOURCE_OBJECTIVES

Resource key for the list of available objective functions

See Also:

Constant Field Values

Method Detail

clear

void clear()

Destroys all work done by this generator.

Specified by:

clear in interface IEditableDataGenerator

getData

IDataGeneratorList getData()

The set of data used.

getFunction

java.lang.String getFunction()

The function used for the objective computation.

setData

void setData(IDataGeneratorList data)

Sets the collection of data to draw from. The objective will never modify this data.

Parameters:

data - Data

setFunction

void setFunction(java.lang.String function)

Sets the function used to compute the objective.

Parameters:

function - Textual description of a function