ptolemy.data.ontologies

Class ConceptToken

java.lang.Object

ptolemy.data.Token

ptolemy.data.ObjectToken

ptolemy.data.ontologies.ConceptToken

All Implemented Interfaces:

PartiallyOrderedToken

public class ConceptToken
extends ObjectToken
implements PartiallyOrderedToken

A token that contains an ontology concept. Concepts are partially ordered immutable values that belong to an ontology. Most of the functionality of this token class is is simply inherited from Concept. Concept

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Ben Lickly

Pt.AcceptedRating:

Red (blickly)

Pt.ProposedRating:

Red (blickly)

Field Summary

Fields inherited from class ptolemy.data.ObjectToken

_class, _value, NULL

Fields inherited from class ptolemy.data.Token

NIL

Constructor Summary

Constructors

Constructor and Description
ConceptToken(Concept c) Create a ConceptToken from a given Concept.

Method Summary

Modifier and Type	Method and Description
Concept	conceptValue() Return the concept encapsulated by this token.
ConceptType	getType() Return the type of this token.
BooleanToken	isEqualTo(Token rightArgument) Compare this ConceptToken to the given argument, and return true if they refer to the same concept in the same lattice.
BooleanToken	isLessThan(PartiallyOrderedToken rightArgument) Check whether the value of this token is strictly less than that of the argument token.
java.lang.String	toString() Return the value of this concept token as a string.

Methods inherited from class ptolemy.data.ObjectToken

_isCloseTo, _isEqualTo, convert, equals, getValue, getValueClass, hashCode, isCloseTo, object

Methods inherited from class ptolemy.data.Token

add, addReverse, divide, divideReverse, isCloseTo, isNil, modulo, moduloReverse, multiply, multiplyReverse, notSupportedConversionMessage, notSupportedIncomparableConversionMessage, notSupportedIncomparableMessage, notSupportedMessage, notSupportedNullNilStringMessage, one, pow, subtract, subtractReverse, zero, zeroReturnType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConceptToken

public ConceptToken(Concept c)
             throws IllegalActionException

Create a ConceptToken from a given Concept.

Parameters:

c - The given Concept

Throws:

IllegalActionException - Thrown if there is a problem creating the ConceptTolen object.

Method Detail

conceptValue

public Concept conceptValue()

Return the concept encapsulated by this token.

Returns:

The concept value.

getType

public ConceptType getType()

Return the type of this token.

Overrides:

getType in class ObjectToken

Returns:

ConceptType.CONCEPT

isEqualTo

public BooleanToken isEqualTo(Token rightArgument)

Compare this ConceptToken to the given argument, and return true if they refer to the same concept in the same lattice. If either is null, return false.

Overrides:

isEqualTo in class ObjectToken

Parameters:

rightArgument - The argument.

Returns:

true if the values are the same Concept, or false otherwise.

isLessThan

public BooleanToken isLessThan(PartiallyOrderedToken rightArgument)
                        throws IllegalActionException

Check whether the value of this token is strictly less than that of the argument token. Note that ontologies are only partial orders, so !(a < b) does not imply (a ≥ b).

Specified by:

isLessThan in interface PartiallyOrderedToken

Parameters:

rightArgument - The token on greater than side of the inequality.

Returns:

BooleanToken.TRUE, if this token is less than the argument token. BooleanToken.FALSE, otherwise.

Throws:

IllegalActionException - If the argument token and this token are of incomparable types, or are concepts from different ontologies.

toString

public java.lang.String toString()

Return the value of this concept token as a string.

Overrides:

toString in class ObjectToken

Returns:

The name of the concept contained by this token as a string value.