org.protempa.valueset

Class ValueSet

java.lang.Object

org.protempa.valueset.ValueSet

public final class ValueSet
extends Object

For specifying value sets.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
ValueSet(String id, String displayName, OrderedValue lowerBound, OrderedValue upperBound, SourceId sourceId)
ValueSet(String id, String displayName, ValueSetElement[] valueSetElements, boolean ordered, SourceId sourceId) Instantiates a new value set with the specified values (value set elements).
ValueSet(String id, String displayName, ValueSetElement[] valueSetElements, SourceId sourceId)

Method Summary

Modifier and Type	Method and Description
String	abbrevDisplayName(Value value) Returns an abbreviated display name for the specified value, if one is defined.
ValueSetBuilder	asBuilder()
String	displayName(Value value) Returns a display name for the specified value, if one is defined.
String	getDisplayName()
String	getId() Returns the value set's unique identifier.
OrderedValue	getLowerBound() Gets the lower bound of this value set, if specified.
SourceId	getSourceId() Returns the source of this value set.
OrderedValue	getUpperBound() Gets the upper bound of this value set, if specified.
ValueSetElement[]	getValueSetElements() Gets the elements of this value set, if specified.
boolean	isInValueSet(Value value) Returns whether the specified value is in the value set.
boolean	isOrdered()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ValueSet

public ValueSet(String id,
                String displayName,
                OrderedValue lowerBound,
                OrderedValue upperBound,
                SourceId sourceId)

ValueSet

public ValueSet(String id,
                String displayName,
                ValueSetElement[] valueSetElements,
                SourceId sourceId)

ValueSet

public ValueSet(String id,
                String displayName,
                ValueSetElement[] valueSetElements,
                boolean ordered,
                SourceId sourceId)

Instantiates a new value set with the specified values (value set elements).

Parameters:

valueSetElements - a ValueSetElement[]. No duplicate ValueSetElements are allowed.

Method Detail

getId

public String getId()

Returns the value set's unique identifier.

Returns:

a unique identifer String.

getDisplayName

public String getDisplayName()

getSourceId

public SourceId getSourceId()

Returns the source of this value set.

Returns:

a SourceId, guaranteed not null.

getValueSetElements

public ValueSetElement[] getValueSetElements()

Gets the elements of this value set, if specified. If the ordered property has value true, then the order in which the value set elements are returned is significant. If false, it is not.

Returns:

a ValueSetElement[]. Guaranteed not null.

isOrdered

public boolean isOrdered()

getLowerBound

public OrderedValue getLowerBound()

Gets the lower bound of this value set, if specified.

Returns:

a lower bound OrderedValue.

getUpperBound

public OrderedValue getUpperBound()

Gets the upper bound of this value set, if specified.

Returns:

an upper bound OrderedValue.

isInValueSet

public boolean isInValueSet(Value value)

Returns whether the specified value is in the value set.

Parameters:

value - a Value. Cannot be null.

Returns:

true or false.

displayName

public String displayName(Value value)

Returns a display name for the specified value, if one is defined.

Parameters:

value - a Value. Cannot be null.

Returns:

a String.

abbrevDisplayName

public String abbrevDisplayName(Value value)

Returns an abbreviated display name for the specified value, if one is defined.

Parameters:

value - a Value. Cannot be null.

Returns:

a String.

toString

public String toString()

Overrides:

toString in class Object

asBuilder

public ValueSetBuilder asBuilder()