Package net.ontopia.topicmaps.impl.basic

Class TopicMap

java.lang.Object
net.ontopia.topicmaps.impl.basic.TMObject
net.ontopia.topicmaps.impl.basic.TopicMap
All Implemented Interfaces:
Serializable, ReifiableIF, TMObjectIF, TopicMapIF, EventListenerIF, EventManagerIF
public class TopicMap extends TMObject implements TopicMapIF, EventManagerIF
INTERNAL: The basic topic map implementation.
See Also:

  • Field Details

  • Method Details

    • 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
      Overrides:
      getTopicMap in class TMObject
      Returns:
      A topic map; an object implementing TopicMapIF.

    • getStore

      public TopicMapStoreIF getStore()
      Description copied from interface: TopicMapIF
      PUBLIC: Gets the store to which the topic map's transaction is connected.
      Specified by:
      getStore in interface TopicMapIF

    • getTransaction

      public TopicMapTransactionIF getTransaction()

    • getBuilder

      public TopicMapBuilderIF getBuilder()
      Description copied from interface: TopicMapIF
      PUBLIC: Gets a topic map builder for use with this transaction.
      Specified by:
      getBuilder in interface TopicMapIF
      Returns:
      An object implementing TopicMapBuilderIF

    • getIndex

      public Object getIndex(String name)
      Description copied from interface: TopicMapIF
      PUBLIC: Gets an index by name. An index is usually named by the IndexIF subinterface that it implements. All indexes are kept up-to-date at all times.

      Specified by:
      getIndex in interface TopicMapIF
      Parameters:
      name - A string; the index name, i.e.g the interface that it implements.
      Returns:
      An instance implementing the index interface.

    • getSubjectIdentityCache

      protected SubjectIdentityCache getSubjectIdentityCache()

    • setSubjectIdentityCache

      protected void setSubjectIdentityCache(SubjectIdentityCache sicache)

    • getTopics

      public Collection<TopicIF> getTopics()
      Description copied from interface: TopicMapIF
      PUBLIC: Gets all topics in this topic map. No specific order is guaranteed.
      Specified by:
      getTopics in interface TopicMapIF
      Returns:
      A collection of TopicIF objects.

    • addTopic

      public void addTopic(TopicIF _topic)
      Adds a topic to the set of topics.

    • removeTopic

      public void removeTopic(TopicIF _topic)
      Removes a topic from the set of topics.

    • getAssociations

      public Collection<AssociationIF> getAssociations()
      Description copied from interface: TopicMapIF
      PUBLIC: Gets all associations in this topic map. No specific order is guaranteed.
      Specified by:
      getAssociations in interface TopicMapIF
      Returns:
      A collection of AssociationIF objects.

    • addAssociation

      public void addAssociation(AssociationIF _association)
      Adds an association to the set of associations.

    • removeAssociation

      public void removeAssociation(AssociationIF _association)
      Removes an associations from the set of associations.

    • remove

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

    • clear

      public void clear()
      Description copied from interface: TopicMapIF
      PUBLIC: Clears the topic map by removing all topics and associations.
      Specified by:
      clear in interface TopicMapIF

    • getObjectById

      public TMObjectIF getObjectById(String object_id)
      Description copied from interface: TopicMapIF
      PUBLIC: Gets the topic map object that has the given object id, from this topic map. If there is no object with that object id in this topic map, then null is returned.
      Specified by:
      getObjectById in interface TopicMapIF
      Parameters:
      object_id - A string; the object id of the object to get.
      Returns:
      A topic map object; an object implementing TMObjectIF.

    • getObjectByItemIdentifier

      public TMObjectIF getObjectByItemIdentifier(LocatorIF locator)
      Description copied from interface: TopicMapIF
      PUBLIC: Gets the topic map object that has the given item identifier (given as a LocatorIF object), from this topic map. If there is no object with the given locator in this topic map, null is returned.
      Specified by:
      getObjectByItemIdentifier in interface TopicMapIF
      Parameters:
      locator - The given locator; an object implementing LocatorIF.
      Returns:
      A topic map object; an object implementing TMObjectIF.

    • getTopicBySubjectLocator

      public TopicIF getTopicBySubjectLocator(LocatorIF locator)
      Description copied from interface: TopicMapIF
      PUBLIC: Gets the topic in this topic map that represents the given addressable subject (locator given as a LocatorIF object). If there is no topic that represents the given addressable subject in this topic map, null is returned.
      Specified by:
      getTopicBySubjectLocator in interface TopicMapIF
      Parameters:
      locator - The given locator; an object implementing LocatorIF.
      Returns:
      A topic; an object implementing TopicIF.

    • getTopicBySubjectIdentifier

      public TopicIF getTopicBySubjectIdentifier(LocatorIF locator)
      Description copied from interface: TopicMapIF
      PUBLIC: Gets the topic that has the specified subject identifier, given as a locator. If there is no topic that has that subject identifier in this topic map, null is returned.
      Specified by:
      getTopicBySubjectIdentifier in interface TopicMapIF
      Parameters:
      locator - The given locator; an object implementing LocatorIF.
      Returns:
      A topic; an object implementing TopicIF.

    • getReifier

      public TopicIF getReifier()
      Description copied from interface: ReifiableIF
      PUBLIC: Returns the topic that reifies this object.
      Specified by:
      getReifier in interface ReifiableIF

    • setReifier

      public void setReifier(TopicIF _reifier)
      Description copied from interface: ReifiableIF
      PUBLIC: Sets the reifier of this object.
      Specified by:
      setReifier in interface ReifiableIF

    • fireEvent

      protected void fireEvent(String event, Object new_value, Object old_value)
      Description copied from class: TMObject
      INTERNAL: Fires an event, so that listeners can be informed about the event. This method is typically called when the object id modified.
      Overrides:
      fireEvent in class TMObject

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • addListener

      public void addListener(EventListenerIF listener, String event)
      Description copied from interface: EventManagerIF
      INTERNAL: Register the listener as a listener for the event.
      Specified by:
      addListener in interface EventManagerIF

    • removeListener

      public void removeListener(EventListenerIF listener, String event)
      Description copied from interface: EventManagerIF
      INTERNAL: Unregister the listener as a listener for the event.
      Specified by:
      removeListener in interface EventManagerIF

    • processEvent

      public void processEvent(Object object, String event, Object new_value, Object old_value)
      Description copied from interface: EventListenerIF
      INTERNAL: A method that receives notification when an event has been triggered.
      Specified by:
      processEvent in interface EventListenerIF