org.protempa.proposition

Interface LocalUniqueId

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

DefaultLocalUniqueId, ProviderBasedLocalUniqueId

public interface LocalUniqueId
extends Cloneable, Serializable

A unique identifier for a proposition retrieved from a data source backend. The identifier must be unique for all propositions with a given proposition id retrieved from the same data source backend. For any proposition, the identifier must be the same every time it is retrieved from the data source backend. The combination of this identifier and a SourceId must uniquely identify a proposition across all data source backends. The interface extends Cloneable because UniqueIdentifier's constructor clones the instance of it that is passed in. It extends Serializable so that unique identifiers can be serialized along with Propositions.

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
LocalUniqueId	clone() Makes a shallow copy of this instance.
String	getId() Gets a string identifier that is unique to a proposition for all propositions with its proposition id.
int	getNumericalId() Gets a number that is to unique to the proposition for all propositions for a keyid with the same proposition id.

Method Detail

getId

String getId()

Gets a string identifier that is unique to a proposition for all propositions with its proposition id. This string must be the same every time the proposition is accessed from the data source backend.

Returns:

string representation of this unique identifier.

getNumericalId

int getNumericalId()

Gets a number that is to unique to the proposition for all propositions for a keyid with the same proposition id. This number must be the same every time the proposition is accessed from the data source backend. If no such number can be constructed from the data in the data source, then you may return the same number for every proposition, but keep in mind that some query results handlers rely on a number to distinguish instances of data with the same value recorded at the same time. Such query results handlers may treat propositions with the same proposition id and numerical local unique id as duplicates.

Returns:

a numerical value unique to propositions with this id.

clone

LocalUniqueId clone()

Makes a shallow copy of this instance.

Returns:

a LocalUniqueId that is equal to this instance.