org.protempa.proposition

Class TemporalProposition

java.lang.Object

org.protempa.proposition.AbstractProposition

org.protempa.proposition.TemporalProposition

All Implemented Interfaces:

Proposition, PropositionCheckedVisitable, PropositionVisitable

Direct Known Subclasses:

Context, Event, TemporalParameter

public abstract class TemporalProposition
extends AbstractProposition

A proposition with a valid timestamp or interval.

Author:

Andrew Post

Field Summary

Fields

Modifier and Type	Field and Description
protected static IntervalFactory	INTERVAL_FACTORY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TemporalProposition() Here only for use by deserialization.

Method Summary

Modifier and Type	Method and Description
String	getFinishFormattedLong() Returns the latest valid time of this proposition as a long string.
String	getFinishFormattedMedium() Returns the earliest valid time of this proposition as a medium-length string.
String	getFinishFormattedShort() Returns the earliest valid time of this proposition as a short string.
Interval	getInterval() The range of time over which this parameter's value is true.
String	getLengthFormattedLong()
String	getLengthFormattedMedium()
String	getLengthFormattedShort()
String	getStartFormattedLong() Returns the earliest valid time of this proposition as a long string.
String	getStartFormattedMedium() Returns the earliest valid time of this proposition as a medium-length string.
String	getStartFormattedShort() Returns the earliest valid time of this proposition as a short string.
boolean	isEqual(Object other) Determines if the specified object is a Proposition and has the same field values as this proposition.
protected void	readTemporalProposition(ObjectInputStream s) Called while deserializing a temporal proposition.
protected void	setInterval(Interval interval) Sets the valid interval.
String	toString()
protected void	writeTemporalProposition(ObjectOutputStream s) Called while serializing a temporal proposition.

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.visitor.PropositionVisitable

accept

Methods inherited from interface org.protempa.proposition.visitor.PropositionCheckedVisitable

acceptChecked

Field Detail

INTERVAL_FACTORY

protected static final IntervalFactory INTERVAL_FACTORY

Constructor Detail

TemporalProposition

protected TemporalProposition()

Here only for use by deserialization. Do not use this for any other reason!

Method Detail

getInterval

public final Interval getInterval()

The range of time over which this parameter's value is true.

Returns:

an Interval.

setInterval

protected void setInterval(Interval interval)

Sets the valid interval.

Parameters:

interval - an Interval.

getStartFormattedLong

public final String getStartFormattedLong()

Returns the earliest valid time of this proposition as a long string.

Returns:

a String.

getLengthFormattedLong

public final String getLengthFormattedLong()

getLengthFormattedMedium

public final String getLengthFormattedMedium()

getLengthFormattedShort

public final String getLengthFormattedShort()

getFinishFormattedLong

public final String getFinishFormattedLong()

Returns the latest valid time of this proposition as a long string.

Returns:

a String.

getStartFormattedMedium

public final String getStartFormattedMedium()

Returns the earliest valid time of this proposition as a medium-length string.

Returns:

a String.

getFinishFormattedMedium

public final String getFinishFormattedMedium()

Returns the earliest valid time of this proposition as a medium-length string.

Returns:

a String.

getStartFormattedShort

public final String getStartFormattedShort()

Returns the earliest valid time of this proposition as a short string.

Returns:

a String.

getFinishFormattedShort

public final String getFinishFormattedShort()

Returns the earliest valid time of this proposition as a short string.

Returns:

a String.

isEqual

public boolean isEqual(Object other)

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 AbstractProposition

Parameters:

other - an Object.

Returns:

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

toString

public String toString()

Overrides:

toString in class AbstractProposition

writeTemporalProposition

protected void writeTemporalProposition(ObjectOutputStream s)
                                 throws IOException

Called while serializing a temporal proposition. It optimizes for when the temporal proposition's interval is a SimpleInterval.

Parameters:

s - an ObjectOutputStream.

Throws:

IOException - when an error occurs during serialization.

readTemporalProposition

protected void readTemporalProposition(ObjectInputStream s)
                                throws IOException,
                                       ClassNotFoundException

Called while deserializing a temporal proposition.

Parameters:

s - an ObjectInputStream.

Throws:

IOException - input/output error during deserialization.

ClassNotFoundException - class of a serialized object cannot be found.