jigcell.compare.objective
Interface IElementWeightObjective

All Superinterfaces:

java.lang.Cloneable, IDataGenerator, IDataSource, IReadableDataSource, java.awt.datatransfer.Transferable

All Known Implementing Classes:

MinkowskiObjective, WOSSObjective

public interface IElementWeightObjective
extends IDataGenerator

A data generator supporting the concept of editable element weights.

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	ATTRIBUTE_DEFAULTELEMENTWEIGHT Attribute key for the current element weight default
static java.lang.String	ATTRIBUTE_ELEMENTWEIGHTS Attribute key for the user specified element weights
static java.lang.String	ELEMENTWEIGHT_0 Default element weight of 0.0
static java.lang.String	ELEMENTWEIGHT_1 Default element weight of 1.0
static java.lang.String	OPTION_DEFAULTELEMENTWEIGHTS Option for all supported element weight defaults

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

Method Summary

java.lang.String	getDefaultElementWeight() The element weight default.
java.util.List	getDefaultElementWeights() Valid element weight defaults.
IDataElement	getElementWeights() The element weights.
void	setDefaultElementWeight(java.lang.String weight) Sets the element weights.
void	setElementWeights(IDataElement weights) Sets the suggested element weights.

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

Field Detail

ATTRIBUTE_DEFAULTELEMENTWEIGHT

static final java.lang.String ATTRIBUTE_DEFAULTELEMENTWEIGHT

Attribute key for the current element weight default

See Also:

Constant Field Values

ATTRIBUTE_ELEMENTWEIGHTS

static final java.lang.String ATTRIBUTE_ELEMENTWEIGHTS

Attribute key for the user specified element weights

See Also:

Constant Field Values

ELEMENTWEIGHT_0

static final java.lang.String ELEMENTWEIGHT_0

Default element weight of 0.0

See Also:

Constant Field Values

ELEMENTWEIGHT_1

static final java.lang.String ELEMENTWEIGHT_1

Default element weight of 1.0

See Also:

Constant Field Values

OPTION_DEFAULTELEMENTWEIGHTS

static final java.lang.String OPTION_DEFAULTELEMENTWEIGHTS

Option for all supported element weight defaults

See Also:

Constant Field Values

Method Detail

getDefaultElementWeight

java.lang.String getDefaultElementWeight()

The element weight default.

getDefaultElementWeights

java.util.List getDefaultElementWeights()

Valid element weight defaults.

getElementWeights

IDataElement getElementWeights()

The element weights.

setDefaultElementWeight

void setDefaultElementWeight(java.lang.String weight)

Sets the element weights. Implementations should act on this reasonably.

Parameters:

weight - Element weight default

setElementWeights

void setElementWeights(IDataElement weights)

Sets the suggested element weights. Implementations should act on this reasonably.

Parameters:

weights - Element weights