Package net.ontopia.topicmaps.impl.utils

Class SnapshotTMObject

java.lang.Object
net.ontopia.topicmaps.impl.utils.SnapshotTMObject
All Implemented Interfaces:
TMObjectIF
Direct Known Subclasses:
SnapshotOccurrence, SnapshotTopic, SnapshotTopicName, SnapshotVariantName
public abstract class SnapshotTMObject extends Object implements TMObjectIF
INTERNAL:

  • Field Details

  • Constructor Details

    • SnapshotTMObject

      public SnapshotTMObject()

  • Method Details

    • getObjectId

      public String getObjectId()
      Description copied from interface: TMObjectIF
      PUBLIC: Gets the id of this object. The object id is part of the topic map id space, and must be unique. The object id is not significant (or unique) outside the current topic map. The object id is immutable. The object id is thus stable through this object's lifetime.
      Specified by:
      getObjectId in interface TMObjectIF
      Returns:
      string which is this object's id.

    • isReadOnly

      public boolean isReadOnly()
      Description copied from interface: TMObjectIF
      PUBLIC: Returns true if this object is read-only, otherwise false.
      Specified by:
      isReadOnly in interface TMObjectIF
      Returns:
      read-only (true) or not read-only (false).

    • getTopicMap

      public TopicMapIF getTopicMap()
      Description copied from interface: TMObjectIF
      PUBLIC: Gets the topic map that this object belongs to. If the object has been removed from its topic map or not added to a topic map yet this will be null.
      Specified by:
      getTopicMap in interface TMObjectIF
      Returns:
      A topic map; an object implementing TopicMapIF.

    • getItemIdentifiers

      public Collection<LocatorIF> getItemIdentifiers()
      Description copied from interface: TMObjectIF
      PUBLIC: Gets the item identifiers of this object. These locators are pointers back to the locations from where this object originated.

      The purpose is to enable the engine to detect when references to external objects refer to objects that are already present within the system, such as topic maps which are already loaded.

      Specified by:
      getItemIdentifiers in interface TMObjectIF
      Returns:
      A collection of LocatorIF objects addressing the item.

    • addItemIdentifier

      public void addItemIdentifier(LocatorIF locator) throws ConstraintViolationException
      Description copied from interface: TMObjectIF
      PUBLIC: Adds the given item identifier to the set of item item identifiers for this object.
      Specified by:
      addItemIdentifier in interface TMObjectIF
      Parameters:
      locator - The item identifier to be added; an object implementing LocatorIF.
      Throws:
      ConstraintViolationException - Thrown if another object in the same topic map already has the given item identifier.

    • removeItemIdentifier

      public void removeItemIdentifier(LocatorIF locator)
      Description copied from interface: TMObjectIF
      PUBLIC: Removes the given item identifier from the set of item identifiers. If this object does not have the given item identifier the call has no effect.
      Specified by:
      removeItemIdentifier in interface TMObjectIF
      Parameters:
      locator - The item identifier to be removed; an object implementing LocatorIF.

    • remove

      public void remove()
      Description copied from interface: TMObjectIF
      PUBLIC: Removes the object from its parent.
      Specified by:
      remove in interface TMObjectIF