jigcell.compare.objective
Interface IDimensionWeightObjective

All Superinterfaces:

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

All Known Implementing Classes:

WOSSObjective

public interface IDimensionWeightObjective
extends IDataGenerator

A data generator supporting the concept of editable dimension 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_DEFAULTDIMENSIONWEIGHT Attribute key for the current dimension weight default
static java.lang.String	ATTRIBUTE_DIMENSIONWEIGHTS Attribute key for the user specified dimension weights
static java.lang.String	DIMENSIONWEIGHT_0 Default dimension weight of 0.0
static java.lang.String	DIMENSIONWEIGHT_1 Default dimension weight of 1.0
static java.lang.String	OPTION_DEFAULTDIMENSIONWEIGHTS Option for all supported dimension 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	getDefaultDimensionWeight() The dimension weight default.
java.util.List	getDefaultDimensionWeights() Valid dimension weight defaults.
IDataElement	getDimensionWeights() The dimension weights.
void	setDefaultDimensionWeight(java.lang.String weight) Sets the dimension weights.
void	setDimensionWeights(IDataElement weights) Sets the suggested dimension 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_DEFAULTDIMENSIONWEIGHT

static final java.lang.String ATTRIBUTE_DEFAULTDIMENSIONWEIGHT

Attribute key for the current dimension weight default

See Also:

Constant Field Values

ATTRIBUTE_DIMENSIONWEIGHTS

static final java.lang.String ATTRIBUTE_DIMENSIONWEIGHTS

Attribute key for the user specified dimension weights

See Also:

Constant Field Values

DIMENSIONWEIGHT_0

static final java.lang.String DIMENSIONWEIGHT_0

Default dimension weight of 0.0

See Also:

Constant Field Values

DIMENSIONWEIGHT_1

static final java.lang.String DIMENSIONWEIGHT_1

Default dimension weight of 1.0

See Also:

Constant Field Values

OPTION_DEFAULTDIMENSIONWEIGHTS

static final java.lang.String OPTION_DEFAULTDIMENSIONWEIGHTS

Option for all supported dimension weight defaults

See Also:

Constant Field Values

Method Detail

getDefaultDimensionWeight

java.lang.String getDefaultDimensionWeight()

The dimension weight default.

getDefaultDimensionWeights

java.util.List getDefaultDimensionWeights()

Valid dimension weight defaults.

getDimensionWeights

IDataElement getDimensionWeights()

The dimension weights.

setDefaultDimensionWeight

void setDefaultDimensionWeight(java.lang.String weight)

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

Parameters:

weight - Dimension weight default

setDimensionWeights

void setDimensionWeights(IDataElement weights)

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

Parameters:

weights - Dimension weights