org.protempa.proposition

Class AbstractProposition

java.lang.Object

org.protempa.proposition.AbstractProposition

All Implemented Interfaces:

Proposition, PropositionCheckedVisitable, PropositionVisitable

Direct Known Subclasses:

Constant, TemporalProposition

public abstract class AbstractProposition
extends Object
implements Proposition

Abstract class for implementing the various kinds of propositions.

Author:

Andrew Post

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractProposition() Here only for use by deserialization of Serializable subclasses of this class.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener l) Adds a PropertyChangeListener to the listener list.
void	addReference(String name, UniqueId ref)
boolean	equals(Object o)
Date	getCreateDate() Gets the timestamp this proposition was created in the source system, or for derived propositions, the timestamp it was created through the temporal abstraction process.
Date	getDeleteDate() Gets the timestamp this proposition was deleted from the source system, or for derived propositions, the timestamp it was invalidated due to data changes.
Date	getDownloadDate() Gets the timestamp this proposition was downloaded from the source system.
String	getId() Gets this proposition's data type.
Value	getProperty(String name) Gets the value of the specified property.
String[]	getPropertyNames() Get the property names for the proposition
String[]	getReferenceNames() Get the reference names for the proposition
List<UniqueId>	getReferences(String name) Gets the global unique identifiers for the propositions that have the specified 1:N relationship with this proposition.
SourceSystem	getSourceSystem() Returns the data source type of the Proposition.
UniqueId	getUniqueId() Gets this proposition's global unique identifier.
Date	getUpdateDate() Gets the timestamp when this proposition was last updated in the source system, or for derived propositions, the timestamp it was last updated through the temporal abstraction process.
int	hashCode()
protected void	initializeAbstractProposition(String id, UniqueId uniqueId) Assigns fields specified in the constructor.
protected void	initializeProperties()
protected void	initializePropertyChangeSupport()
protected void	initializeReferences()
boolean	isEqual(Object other) Determines if the specified object is a Proposition and has the same field values as this proposition.
protected void	readAbstractProposition(ObjectInputStream s)
void	removePropertyChangeListener(PropertyChangeListener l) Removes a PropertyChangeListener from the listener list.
void	setCreateDate(Date createDate) Sets the date this proposition was created according to the source system from which it was obtained, or for derived propositions, the date it was created through the temporal abstraction process.
void	setDeleteDate(Date deleteDate) Sets the timestamp this proposition was deleted from the source system.
void	setDownloadDate(Date downloadDate) Sets the date this proposition was downloaded from the source system.
void	setProperty(String name, Value value)
void	setReferences(String name, List<UniqueId> refs)
void	setSourceSystem(SourceSystem sourceSystem)
void	setUpdateDate(Date updateDate) Sets the timestamp this proposition was last updated according to the source system from which it was obtained, or for derived propositions, the date it was last updated through the temporal abstraction process.
String	toString()
protected void	writeAbstractProposition(ObjectOutputStream s)

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

Constructor Detail

AbstractProposition

protected AbstractProposition()

Here only for use by deserialization of Serializable subclasses of this class. Do not call this for any other reason because id and uniqueId are left uninitialized! Subclasses that are serializable should implement a readObject method that calls readAbstractProposition(java.io.ObjectInputStream).

Method Detail

initializeAbstractProposition

protected final void initializeAbstractProposition(String id,
                                                   UniqueId uniqueId)

Assigns fields specified in the constructor. This is pulled into a method so that deserialization can initialize those fields correctly.

Parameters:

id - the proposition id.

uniqueId - the proposition's unique id.

initializeProperties

protected void initializeProperties()

initializeReferences

protected void initializeReferences()

initializePropertyChangeSupport

protected void initializePropertyChangeSupport()

getId

public String getId()

Description copied from interface: Proposition

Gets this proposition's data type.

Specified by:

getId in interface Proposition

Returns:

the identification String for the type of data represented by this proposition.

setProperty

public final void setProperty(String name,
                              Value value)

getProperty

public final Value getProperty(String name)

Description copied from interface: Proposition

Gets the value of the specified property.

Specified by:

getProperty in interface Proposition

Parameters:

name - the name String of a valid property. Cannot be null.

Returns:

the Value of the specified property.

getPropertyNames

public final String[] getPropertyNames()

Description copied from interface: Proposition

Get the property names for the proposition

Specified by:

getPropertyNames in interface Proposition

Returns:

an array containing the names of all the properties contained

getSourceSystem

public SourceSystem getSourceSystem()

Description copied from interface: Proposition

Returns the data source type of the Proposition.

Specified by:

getSourceSystem in interface Proposition

Returns:

a SourceSystem.

setSourceSystem

public void setSourceSystem(SourceSystem sourceSystem)

getUniqueId

public final UniqueId getUniqueId()

Description copied from interface: Proposition

Gets this proposition's global unique identifier.

Specified by:

getUniqueId in interface Proposition

Returns:

a UniqueIdentifier.

setReferences

public final void setReferences(String name,
                                List<UniqueId> refs)

addReference

public final void addReference(String name,
                               UniqueId ref)

getReferences

public final List<UniqueId> getReferences(String name)

Description copied from interface: Proposition

Gets the global unique identifiers for the propositions that have the specified 1:N relationship with this proposition.

Specified by:

getReferences in interface Proposition

Parameters:

name - the name of the relationship. Cannot be null.

Returns:

a List of global unique identifiers. Guaranteed not null.

See Also:

to get the propositions with the specified relationship.

getReferenceNames

public final String[] getReferenceNames()

Description copied from interface: Proposition

Get the reference names for the proposition

Specified by:

getReferenceNames in interface Proposition

Returns:

an array containing the names of all the references contained

addPropertyChangeListener

public final void addPropertyChangeListener(PropertyChangeListener l)

Description copied from interface: Proposition

Adds a PropertyChangeListener to the listener list. The listener is registered for all bound properties of this class (none at present). If listener is null, no exception is thrown and no action is performed.

Specified by:

addPropertyChangeListener in interface Proposition

Parameters:

l - the PropertyChangeListener to be added.

removePropertyChangeListener

public final void removePropertyChangeListener(PropertyChangeListener l)

Description copied from interface: Proposition

Removes a PropertyChangeListener from the listener list. This method should be used to remove PropertyChangeListeners that were registered for all bound properties of this class. If listener is null, no exception is thrown and no action is performed.

Specified by:

removePropertyChangeListener in interface Proposition

Parameters:

l - the PropertyChangeListener to be removed

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

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

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 Object

writeAbstractProposition

protected void writeAbstractProposition(ObjectOutputStream s)
                                 throws IOException

Throws:

IOException

readAbstractProposition

protected void readAbstractProposition(ObjectInputStream s)
                                throws IOException,
                                       ClassNotFoundException

Throws:

IOException

ClassNotFoundException

getCreateDate

public final Date getCreateDate()

Description copied from interface: Proposition

Gets the timestamp this proposition was created in the source system, or for derived propositions, the timestamp it was created through the temporal abstraction process. A null value means the create timestamp was not recorded, or the source system did not have an accurate created timestamp. Returned values may be in the future, if that is what the source system provided. Protempa does not use this timestamp in any fashion to control how propositions are used in computing temporal abstractions.

Specified by:

getCreateDate in interface Proposition

Returns:

a timestamp, or null.

setCreateDate

public final void setCreateDate(Date createDate)

Sets the date this proposition was created according to the source system from which it was obtained, or for derived propositions, the date it was created through the temporal abstraction process. If the source system does not maintain accurate create timestamps or does not provide a create timestamp, you may set it to null. Protempa implements no validation checking for future timestamps. Protempa does not use the create timestamp in any fashion to control how propositions are used in computing temporal abstractions. The default value is null.

Parameters:

createDate - a timestamp, or null.

getUpdateDate

public final Date getUpdateDate()

Description copied from interface: Proposition

Gets the timestamp when this proposition was last updated in the source system, or for derived propositions, the timestamp it was last updated through the temporal abstraction process. Used to determine when a proposition has been updated. A null value means that the proposition's value has not been updated. When a source system does not provide accurate update timestamps, a data source backend may set this value to the downloaded timestamp to ensure that Protempa does not miss an update.

Specified by:

getUpdateDate in interface Proposition

Returns:

a timestamp, or null.

setUpdateDate

public final void setUpdateDate(Date updateDate)

Sets the timestamp this proposition was last updated according to the source system from which it was obtained, or for derived propositions, the date it was last updated through the temporal abstraction process. If the source system does not maintain accurate update timestamps, set it to the downloaded timestamp. It's permissible to set the update timestamp equal to the create timestamp when creating a proposition. It's also permissible to set the update timestamp when creating a proposition and leave the create timestamp null, for example, if the source system cannot distinguish between created and updated records. Protempa may ignore propositions with an update timestamp set in the future. The default value is null.

Parameters:

updateDate - a timestamp, or null.

getDownloadDate

public final Date getDownloadDate()

Description copied from interface: Proposition

Gets the timestamp this proposition was downloaded from the source system. If this proposition was derived, gets the date it was derived. A null value means the proposition was not downloaded from a source system, or the source system did not provide an accurate downloaded timestamp. Protempa does not use this timestamp in any fashion to control how propositions are used in computing temporal abstractions.

Specified by:

getDownloadDate in interface Proposition

Returns:

a timestamp, null.

setDownloadDate

public final void setDownloadDate(Date downloadDate)

Sets the date this proposition was downloaded from the source system. If this proposition was derived, sets the date it was derived. Set the download date to null if the source system did not provide a download date or it is inaccurate. The default value is null.

Parameters:

downloadDate - a date, or null.

getDeleteDate

public Date getDeleteDate()

Description copied from interface: Proposition

Gets the timestamp this proposition was deleted from the source system, or for derived propositions, the timestamp it was invalidated due to data changes. Used to determine when to delete or invalidate a proposition. A null value means the proposition should not be deleted. Any non-null timestamp will cause the proposition to be deleted, even a timestamp in the future. A data source backend may set this timestamp to the downloaded timestamp if it knows a proposition should be deleted but the source system does not provide an accurate delete timestamp.

Specified by:

getDeleteDate in interface Proposition

Returns:

a timestamp, or null.

setDeleteDate

public void setDeleteDate(Date deleteDate)

Sets the timestamp this proposition was deleted from the source system. If this proposition was derived, sets the date it was invalidated by data changes. Set to null to indicate that this proposition has not been deleted. If you know that a proposition should be deleted but the source system does not maintain accurate delete timestamps, set it to the query/read timestamp. The default value is null. Any non-null timestamp will cause Protempa to delete the proposition, even if the timestamp is in the future.

Parameters:

deleteDate - a timestamp, or null.