jigcell.compare.objective
Interface IRelationalObjective

All Superinterfaces:
java.lang.Cloneable, IDataGenerator, IDataSource, IReadableDataSource, java.awt.datatransfer.Transferable
All Known Implementing Classes:
BooleanRelationalObjective

public interface IRelationalObjective
extends IDataGenerator

A data generator supporting the concept of relational comparisons.

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_RELATION
          Attribute key for the currently selected relation
static java.lang.String OPTION_RELATIONS
          Option for all supported relations
static java.lang.String RELATION_EQUALITY
          Default relation of equality
static java.lang.String RELATION_GREATERTHAN
          Default relation of greater than
static java.lang.String RELATION_GREATERTHANEQUAL
          Default relation of greater than or equal
static java.lang.String RELATION_INEQUALITY
          Default relation of inequality
static java.lang.String RELATION_LESSTHAN
          Default relation of less than
static java.lang.String RELATION_LESSTHANEQUAL
          Default relation of less then or equal
 
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 getRelation()
          The relation.
 java.util.List getRelations()
          The valid relations
 void setRelation(java.lang.String relation)
          Sets the suggested relation.
 
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_RELATION

static final java.lang.String ATTRIBUTE_RELATION
Attribute key for the currently selected relation

See Also:
Constant Field Values

OPTION_RELATIONS

static final java.lang.String OPTION_RELATIONS
Option for all supported relations

See Also:
Constant Field Values

RELATION_EQUALITY

static final java.lang.String RELATION_EQUALITY
Default relation of equality

See Also:
Constant Field Values

RELATION_GREATERTHAN

static final java.lang.String RELATION_GREATERTHAN
Default relation of greater than

See Also:
Constant Field Values

RELATION_GREATERTHANEQUAL

static final java.lang.String RELATION_GREATERTHANEQUAL
Default relation of greater than or equal

See Also:
Constant Field Values

RELATION_INEQUALITY

static final java.lang.String RELATION_INEQUALITY
Default relation of inequality

See Also:
Constant Field Values

RELATION_LESSTHAN

static final java.lang.String RELATION_LESSTHAN
Default relation of less than

See Also:
Constant Field Values

RELATION_LESSTHANEQUAL

static final java.lang.String RELATION_LESSTHANEQUAL
Default relation of less then or equal

See Also:
Constant Field Values
Method Detail

getRelation

java.lang.String getRelation()
The relation.


getRelations

java.util.List getRelations()
The valid relations


setRelation

void setRelation(java.lang.String relation)
Sets the suggested relation. Implementations should act on this reasonably.

Parameters:
relation - Relation