gov.nasa.arc.brahms.vm.api.common
Interface IRelationTuple

All Superinterfaces:

ITuple

public interface IRelationTuple
extends ITuple

IRelationTuple is a wrapper interface for a relation based tuple specifying the state represented by an IStatement (IBelief or IFact). The state of a relation tuple specifies the relationship between two concepts through a specific relation defined for one of the concepts (object relation object).

Version:

9 August 2001

Author:

Ron van Hoof

See Also:

ITuple

Method Summary

IRelation	getRelation() Returns the relation defining the type of relationship between the left hand side and right hand side concepts.
IConcept	getRhsConcept() Returns the right hand side concept that is related to the left hand side concept through the IRelation specified by this tuple.
int	getTruthValue() Returns the truth value of the relationship between the two concepts.
boolean	isRhsUnknown() Indicates if the rhs value is the value 'unknown'.

Methods inherited from interface gov.nasa.arc.brahms.vm.api.common.ITuple

getLhsConcept, getLhsObject

Method Detail

getRelation

IRelation getRelation()
                      throws ExternalException

Returns the relation defining the type of relationship between the left hand side and right hand side concepts.

Returns:

IRelation the relation between the two concepts

Throws:

ExternalException - if an internal error occurs

getRhsConcept

IConcept getRhsConcept()
                       throws ExternalException

Returns the right hand side concept that is related to the left hand side concept through the IRelation specified by this tuple.

Returns:

IConcept the right hand side concept

Throws:

ExternalException - if rhs is unknown or if an internal error occurs

isRhsUnknown

boolean isRhsUnknown()
                     throws ExternalException

Indicates if the rhs value is the value 'unknown'. If not the rhs value must be an IConcept that can be retrieved using the method getRhsConcept.

Returns:

true if the rhs is unknown, false if it is a concept.

Throws:

ExternalException

getTruthValue

int getTruthValue()
                  throws ExternalException

Returns the truth value of the relationship between the two concepts.

Returns:

int TRUE if the relationship is true, FALSE it is is false, UNKNOWN if it is unknown.

Throws:

ExternalException - if an internal error occurs

See Also:

ITruthValue.TRUE, ITruthValue.FALSE, ITruthValue.UNKNOWN