org.semanticweb.owlapi.change

Class OWLOntologyChangeRecord

java.lang.Object

org.semanticweb.owlapi.change.OWLOntologyChangeRecord

All Implemented Interfaces:

Serializable

public class OWLOntologyChangeRecord
extends Object
implements Serializable

Associates an OWLOntologyID with ontology-less change data.
An OWLOntologyChangeRecord captures information about an OWLOntologyChange in a way that does not require a reference to an OWLOntology object. It does this by referencing an OWLOntologyID instead of referencing an OWLOntology. The primary reason for doing this is so that changes can be serialized and logged more easily. It should be kept in mind that OWLOntologyChangeRecord objects can represent changes for which there might be no in memory representation of a specific OWLOntology. This is also true if an OWLOntology object has its OWLOntologyID changed.
An OWLOntologyChange object contains two important pieces of information:

1. The OWLOntologyID that identifies the ontology that the change pertains to.
2. The OWLOntologyChangeData that describes the change specific data. For each kind of OWLOntologyChange there is a corresponding OWLOntologyChangeData class which captures the essential details that pertain to the change. The reason for this separation is that it allows change information to be captured where the context of the change (the ontology) is known via some other mechanism.

OWLOntologyChangeRecord objects are immutable.

Since:

3.3

Author:

Matthew Horridge, Stanford University, Bio-Medical Informatics Research Group

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OWLOntologyChangeRecord(OWLOntologyID ontologyID, OWLOntologyChangeData data) Constructs an OWLOntologyChangeRecord object which holds information about a change to a particular ontology identified by an OWLOntologyID object and also change details specified by the OWLOntologyChangeData object.

Method Summary

Modifier and Type	Method and Description
static OWLOntologyChangeRecord	createFromOWLOntologyChange(OWLOntologyChange change) A convenience method that creates an OWLOntologyChangeRecord by deriving data from an OWLOntologyChange object.
OWLOntologyChange	createOntologyChange(OWLOntologyManager manager) Creates an OWLOntologyChange from the OWLOntologyID and OWLOntologyChangeData associated with this OWLOntologyChangeRecord object.
boolean	equals(Object obj)
OWLOntologyChangeData	getData() Gets the OWLOntologyChangeData which is associated with this OWLOntologyChangeRecord.
String	getName()
OWLOntologyID	getOntologyID() Gets the OWLOntologyID that identifies the ontology associated with this change record.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OWLOntologyChangeRecord

public OWLOntologyChangeRecord(OWLOntologyID ontologyID,
                               OWLOntologyChangeData data)

Constructs an OWLOntologyChangeRecord object which holds information about a change to a particular ontology identified by an OWLOntologyID object and also change details specified by the OWLOntologyChangeData object.

Parameters:

ontologyID - The OWLOntologyID which identifies the ontology that the change was applied to.

data - The OWLOntologyChangeData that describes the particular details of the change.

Method Detail

createFromOWLOntologyChange

public static OWLOntologyChangeRecord createFromOWLOntologyChange(OWLOntologyChange change)

A convenience method that creates an OWLOntologyChangeRecord by deriving data from an OWLOntologyChange object.

Parameters:

change - The OWLOntologyChange object.

Returns:

instance of OWLOntologyChangeRecord

getOntologyID

public OWLOntologyID getOntologyID()

Gets the OWLOntologyID that identifies the ontology associated with this change record.

Returns:

The OWLOntologyID.

getData

public OWLOntologyChangeData getData()

Gets the OWLOntologyChangeData which is associated with this OWLOntologyChangeRecord.

Returns:

The OWLOntologyChangeData.

createOntologyChange

public OWLOntologyChange createOntologyChange(OWLOntologyManager manager)

Creates an OWLOntologyChange from the OWLOntologyID and OWLOntologyChangeData associated with this OWLOntologyChangeRecord object. The OWLOntology that is the target of the resulting OWLOntologyChange is derived from an OWLOntologyManager. The manager must contain an ontology that has an OWLOntologyID which is equal to the OWLOntologyID associated with this OWLOntologyChangeRecord object.

Parameters:

manager - The manager which will be used to obtain a reference to an OWLOntology object having the same OWLOntologyID as the OWLOntologyID associated with this OWLOntologyChangeRecord.

Returns:

The OWLOntologyChange object that is derived from this record's OWLOntologyID and OWLOntologyChangeData. The specific concrete subclass of the returned OWLOntologyChange will depend upon the specific concrete subclass of the OWLOntologyChangeData associated with this OWLOntologyChangeRecord.

Throws:

UnknownOWLOntologyException - if the specified manager does not contain an ontology which has an OWLOntologyID equal to the OWLOntologyID associated with this OWLOntologyChangeRecord.

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Returns:

a name for the object class