org.protempa.proposition.value

Class OrdinalValue

java.lang.Object

org.protempa.proposition.value.OrdinalValue

All Implemented Interfaces:

Serializable, OrderedValue, Value, ValueVisitable

public final class OrdinalValue
extends Object
implements OrderedValue, Serializable

Represents ordinal string values. This currently is non-functional.

Author:

Andrew Post

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	accept(ValueVisitor valueVisitor) Performs some processing on a value.
OrdinalValueBuilder	asBuilder()
ValueComparator	compare(Value o) Compares this value and another according to the defined order, or checks this number value for membership in a value list.
boolean	equals(Object obj)
String	getFormatted() Returns a string representing this value for display purposes.
int	getIndex()
ValueType	getType() Returns this object's type, guaranteed not null.
String	getValue() Returns the value.
int	hashCode()
OrdinalValue	replace() Returns a value from a cache that is equal to this one, if such a value exists.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

replace

public OrdinalValue replace()

Description copied from interface: Value

Returns a value from a cache that is equal to this one, if such a value exists. Otherwise, it returns itself.

Specified by:

replace in interface Value

Returns:

a Value for which #equals(Value) is true.

getFormatted

public String getFormatted()

Description copied from interface: Value

Returns a string representing this value for display purposes.

Specified by:

getFormatted in interface Value

Returns:

a String. Guaranteed not null.

getType

public ValueType getType()

Description copied from interface: Value

Returns this object's type, guaranteed not null.

Specified by:

getType in interface Value

Returns:

a ValueType.

getValue

public String getValue()

Returns the value.

Returns:

a String.

getIndex

public int getIndex()

compare

public ValueComparator compare(Value o)

Compares this value and another according to the defined order, or checks this number value for membership in a value list.

Specified by:

compare in interface Value

Parameters:

o - a Value.

Returns:

If the provided value is an OrdinalValue, returns ValueComparator.GREATER_THAN, ValueComparator.LESS_THAN or ValueComparator.EQUAL_TO depending on whether this value is numerically greater than, less than or equal to the value provided as argument. If the provided value is a ValueList, returns ValueComparator.IN if this object is a member of the list, or ValueComparator.NOT_IN if not. Otherwise, returns ValueComparator.UNKNOWN.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

accept

public void accept(ValueVisitor valueVisitor)

Description copied from interface: ValueVisitable

Performs some processing on a value.

Specified by:

accept in interface ValueVisitable

toString

public String toString()

Overrides:

toString in class Object

asBuilder

public OrdinalValueBuilder asBuilder()

Specified by:

asBuilder in interface OrderedValue

Specified by:

asBuilder in interface Value