Package net.ontopia.topicmaps.impl.rdbms

Class TopicMap

java.lang.Object
net.ontopia.persistence.proxy.AbstractRWPersistent
net.ontopia.topicmaps.impl.rdbms.TMObject
net.ontopia.topicmaps.impl.rdbms.TopicMap
All Implemented Interfaces:
PersistentIF, ReifiableIF, TMObjectIF, TopicMapIF
public class TopicMap extends TMObject implements TopicMapIF
INTERNAL: The rdbms topic map implementation.

  • Field Details

  • Constructor Details

    • TopicMap

      public TopicMap()

    • TopicMap

      public TopicMap(TransactionIF txn)

  • Method Details

    • detach

      public void detach()
      Specified by:
      detach in interface PersistentIF
      Specified by:
      detach in class AbstractRWPersistent

    • getBaseAddress

      public LocatorIF getBaseAddress()

    • setBaseAddress

      public void setBaseAddress(LocatorIF baseAddress)

    • getTitle

      public String getTitle()

    • setTitle

      public void setTitle(String title)

    • getComments

      public String getComments()

    • setComments

      public void setComments(String comments)

    • _p_getFieldCount

      public int _p_getFieldCount()
      Specified by:
      _p_getFieldCount in interface PersistentIF

    • getClassIndicator

      public String getClassIndicator()
      Description copied from class: TMObject
      INTERNAL: Returns the token that can be used to indicate the class of this instance. This indicator is currently only used by source locators.
      Specified by:
      getClassIndicator in class TMObject

    • 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
      Specified by:
      getObjectId in class TMObject
      Returns:
      string which is this object's id.

    • 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.

    • setTopicMap

      protected void setTopicMap(TopicMapIF topicmap)

    • 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.

    • setTransaction

      public void setTransaction(RDBMSTopicMapTransaction transaction)

    • 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

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

    • removeTopic

      protected 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

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

    • removeAssociation

      protected void removeAssociation(AssociationIF association)
      Removes an associations from the set of associations.

    • 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.

    • 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

    • 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.

    • getRolesByType

      public Collection<AssociationRoleIF> getRolesByType(TopicIF player, TopicIF rtype)

    • getRolesByType

      public Collection<AssociationRoleIF> getRolesByType(TopicIF player, TopicIF rtype, TopicIF atype)

    • getOccurrencesByType

      public Collection<OccurrenceIF> getOccurrencesByType(TopicIF topic, TopicIF type)

    • getTopicNamesByType

      public Collection<TopicNameIF> getTopicNamesByType(TopicIF topic, TopicIF type)

    • getAssocations

      public Collection<AssociationIF> getAssocations(TopicIF topic)

    • getAssociationsByType

      public Collection<AssociationIF> getAssociationsByType(TopicIF topic, TopicIF type)

    • 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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • syncAfterMerge

      public void syncAfterMerge(IdentityIF source, IdentityIF target)
      Specified by:
      syncAfterMerge in class AbstractRWPersistent