org.protempa

Class PropertyDefinition

java.lang.Object

org.protempa.PropertyDefinition

All Implemented Interfaces:

Serializable

public final class PropertyDefinition
extends Object
implements Serializable

Defines a property of a proposition definition.

Author:

Andrew Post

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PropertyDefinition(String propId, String id, String displayName, ValueType valueType, String valueSetId, String declaringPropId)
PropertyDefinition(String propId, String id, String displayName, ValueType valueType, String valueSetId, String declaringPropId, Attribute[] attributes) Initializes the property definition with a displayName, a value type and a value set.

Method Summary

Modifier and Type	Method and Description
Attribute	getAttribute(String name)
Attribute[]	getAttributes()
String	getDeclaringPropId()
String	getDisplayName() Returns the property's displayName.
String	getId() Returns the property's id, which is unique in combination with a proposition id.
String	getPropId()
String	getValueSetId() Returns the property's value set (for nominal and ordinal values).
ValueType	getValueType() Returns the property's value type.
boolean	hasAttribute(String name)
boolean	isInherited()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyDefinition

public PropertyDefinition(String propId,
                          String id,
                          String displayName,
                          ValueType valueType,
                          String valueSetId,
                          String declaringPropId)

PropertyDefinition

public PropertyDefinition(String propId,
                          String id,
                          String displayName,
                          ValueType valueType,
                          String valueSetId,
                          String declaringPropId,
                          Attribute[] attributes)

Initializes the property definition with a displayName, a value type and a value set.

Parameters:

id - an unique id String. Cannot be null.

displayName - a displayName String. If null, the displayName field is set to the value of the id field.

valueType - a ValueType. Cannot be null.

valueSetId - the unique id of this property's ValueSet.

See Also:

ValueType#isCompatible(org.protempa.valueset.ValueSet)

Method Detail

getPropId

public String getPropId()

getId

public String getId()

Returns the property's id, which is unique in combination with a proposition id.

Returns:

the id String. Guaranteed not null.

getDisplayName

public String getDisplayName()

Returns the property's displayName. Guaranteed not null.

Returns:

a String.

getValueType

public ValueType getValueType()

Returns the property's value type.

Returns:

a ValueType.

getValueSetId

public String getValueSetId()

Returns the property's value set (for nominal and ordinal values).

Returns:

the EnumeratedValueSet, or null if none is defined.

getDeclaringPropId

public String getDeclaringPropId()

isInherited

public boolean isInherited()

getAttributes

public Attribute[] getAttributes()

getAttribute

public Attribute getAttribute(String name)

hasAttribute

public boolean hasAttribute(String name)

toString

public String toString()

Overrides:

toString in class Object