org.protempa.proposition

Class PrimitiveParameter

java.lang.Object

org.protempa.proposition.AbstractProposition

org.protempa.proposition.TemporalProposition

org.protempa.proposition.TemporalParameter

org.protempa.proposition.PrimitiveParameter

All Implemented Interfaces:

Serializable, Parameter, Proposition, PropositionCheckedVisitable, PropositionVisitable

public final class PrimitiveParameter
extends TemporalParameter
implements Serializable

A raw data parameter with a timestamp (or other position value). A primitive parameter has a parameter id, attribute id, timestamp, and value. A single parameter type can have multiple attributes. Each attribute is represented by an unique parameter id and attribute id combination.

Author:

Andrew Post

See Also:

Serialized Form

Field Summary

Fields inherited from class org.protempa.proposition.TemporalProposition

INTERVAL_FACTORY

Constructor Summary

Constructors

Constructor and Description
PrimitiveParameter(String id, UniqueId uniqueId) Creates a parameter with an identification string.

Method Summary

Modifier and Type	Method and Description
void	accept(PropositionVisitor propositionVisitor) Performs some processing on a proposition.
void	acceptChecked(PropositionCheckedVisitor propositionCheckedVisitor) Performs some processing on a proposition that might throw a checked exception.
Granularity	getGranularity() Returns the granularity of this parameter's timestamp.
Long	getPosition() Returns this parameter's timestamp (or other kind of position value).
String	getPositionFormattedLong() Returns this parameter's timestamp as a long formatted string.
String	getPositionFormattedMedium() Returns this parameter's timestamp as a medium-length formatted string.
String	getPositionFormattedShort() Returns this parameter's timestamp as a short formatted string.
boolean	isEqual(Object o) Determines if the specified object is a Proposition and has the same field values as this proposition.
void	setGranularity(Granularity granularity) Sets the granularity of this parameter's timestamp.
void	setPosition(Long pos) Sets this parameter's timestamp (or other kind of position value).
String	toString()

Methods inherited from class org.protempa.proposition.TemporalParameter

getValue, getValueFormatted, readTemporalParameter, setValue, writeTemporalParameter

Methods inherited from class org.protempa.proposition.TemporalProposition

getFinishFormattedLong, getFinishFormattedMedium, getFinishFormattedShort, getInterval, getLengthFormattedLong, getLengthFormattedMedium, getLengthFormattedShort, getStartFormattedLong, getStartFormattedMedium, getStartFormattedShort, readTemporalProposition, setInterval, writeTemporalProposition

Methods inherited from class org.protempa.proposition.AbstractProposition

addPropertyChangeListener, addReference, equals, getCreateDate, getDeleteDate, getDownloadDate, getId, getProperty, getPropertyNames, getReferenceNames, getReferences, getSourceSystem, getUniqueId, getUpdateDate, hashCode, initializeAbstractProposition, initializeProperties, initializePropertyChangeSupport, initializeReferences, readAbstractProposition, removePropertyChangeListener, setCreateDate, setDeleteDate, setDownloadDate, setProperty, setReferences, setSourceSystem, setUpdateDate, writeAbstractProposition

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.protempa.proposition.Proposition

addPropertyChangeListener, getCreateDate, getDeleteDate, getDownloadDate, getId, getProperty, getPropertyNames, getReferenceNames, getReferences, getSourceSystem, getUniqueId, getUpdateDate, removePropertyChangeListener

Constructor Detail

PrimitiveParameter

public PrimitiveParameter(String id,
                          UniqueId uniqueId)

Creates a parameter with an identification string.

Parameters:

id - an identification string. If passed null, an id string of "" will be used.

uniqueId - a UniqueId that uniquely identifies this parameter.

Method Detail

getPosition

public Long getPosition()

Returns this parameter's timestamp (or other kind of position value). A null value means the timestamp is unknown.

Returns:

a Long.

setPosition

public void setPosition(Long pos)

Sets this parameter's timestamp (or other kind of position value).

Parameters:

pos - a long.

getGranularity

public Granularity getGranularity()

Returns the granularity of this parameter's timestamp.

Returns:

a Granularity object.

setGranularity

public void setGranularity(Granularity granularity)

Sets the granularity of this parameter's timestamp.

Parameters:

granularity - a Granularity object.

getPositionFormattedLong

public String getPositionFormattedLong()

Returns this parameter's timestamp as a long formatted string.

Returns:

a String.

getPositionFormattedMedium

public String getPositionFormattedMedium()

Returns this parameter's timestamp as a medium-length formatted string.

Returns:

a String.

getPositionFormattedShort

public String getPositionFormattedShort()

Returns this parameter's timestamp as a short formatted string.

Returns:

a String.

toString

public String toString()

Overrides:

toString in class TemporalParameter

isEqual

public boolean isEqual(Object o)

Description copied from interface: Proposition

Determines if the specified object is a Proposition and has the same field values as this proposition.

Specified by:

isEqual in interface Proposition

Overrides:

isEqual in class TemporalParameter

Parameters:

o - an Object.

Returns:

true if the specified object is a Proposition and has the same field values, false otherwise.

accept

public void accept(PropositionVisitor propositionVisitor)

Description copied from interface: PropositionVisitable

Performs some processing on a proposition.

Specified by:

accept in interface PropositionVisitable

acceptChecked

public void acceptChecked(PropositionCheckedVisitor propositionCheckedVisitor)
                   throws ProtempaException

Description copied from interface: PropositionCheckedVisitable

Performs some processing on a proposition that might throw a checked exception.

Specified by:

acceptChecked in interface PropositionCheckedVisitable

Throws:

ProtempaException