org.kuali.rice.krms.api.engine
Class Term

java.lang.Object
  org.kuali.rice.krms.api.engine.Term

All Implemented Interfaces:

Comparable<Term>

public final class Term
extends Object
implements Comparable<Term>

Identifies a (hopefully) resolvable Term. For resolution in the TermResolutionEngine, The appropriate TermResolver will be selected by matching the TermSpecification and parameters of the Term with the output and parameter names of the TermResolver.

Author:

gilesp

Constructor Summary

Term(TermSpecification specification)

Term(TermSpecification specification, Map<String,String> parameters)
This constructs a Term, which is a named piece of data that is usually obtainable through the TermResolutionEngine

Method Summary

int	compareTo(Term o)
boolean	equals(Object obj)
Map<String,String>	getParameters()
Map<String,String>	getProperties()
TermSpecification	getSpecification()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Term

public Term(TermSpecification specification)

Term

public Term(TermSpecification specification,
            Map<String,String> parameters)

This constructs a Term, which is a named piece of data that is usually obtainable through the TermResolutionEngine

Parameters:

specification - the specification (which maps a Term to a resolver) for this Term

parameters - an optional map of properties that may be used to allow a single TermResolver to resolve multiple Terms

Method Detail

getSpecification

public TermSpecification getSpecification()

getProperties

public Map<String,String> getProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(Term o)

Specified by:

compareTo in interface Comparable<Term>

getParameters

public Map<String,String> getParameters()

Returns:

an unmodifiable Map of parameters specified on this Term. Guaranteed non-null.

toString

public String toString()

Overrides:

toString in class Object