Package net.ontopia.topicmaps.core.events

Interface TopicMapListenerIF

All Known Implementing Classes:
AbstractTopicMapListener
public interface TopicMapListenerIF
PUBLIC: Event callback interface for topic map objects. Register listeners with the static methods in TopicMapEvents. See the same class for more information about the event system. Note that this interface is generic and may accommodate objects other than topics in the future. Which object the listener will receive callbacks from depends on which registration method in TopicMapEventswas used for the listener.

NOTE: The objects received through this callback interface are not normal topic map objects, since they do not belong to any topic map transaction. Instead, the objects received are minimal snapshots, and what information the snapshots contain will depend on the callback method they were received through. See the documention of each method to see what the constraints are.

Since:
3.1

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    objectAdded(TMObjectIF snapshot)
    PUBLIC: Callback method called when a topic map object has been added to the topic map.
    void
    objectModified(TMObjectIF snapshot)
    PUBLIC: Callback method called when a topic map object has been modified.
    void
    objectRemoved(TMObjectIF snapshot)
    PUBLIC: Callback method called when a topic map object has been removed from the topic map.

  • Method Details

    • objectAdded

      void objectAdded(TMObjectIF snapshot)
      PUBLIC: Callback method called when a topic map object has been added to the topic map. The callback will be made after the transaction has been committed.

      The snapshot of a TMObjectIF given as the first argument is very minimal as it only holds the object ID of the topic map object. To get more information about the object, look it up in your own transaction using the object ID.

    • objectModified

      void objectModified(TMObjectIF snapshot)
      PUBLIC: Callback method called when a topic map object has been modified. The callback will be made after the transaction has been committed.

      The snapshot of a TMObjectIF given as the first argument is very minimal as it only holds the object ID of the topic map object. To get more information about the object, look it up in your own transaction using the object ID.

      Since:
      3.4.3

    • objectRemoved

      void objectRemoved(TMObjectIF snapshot)
      PUBLIC: Callback method called when a topic map object has been removed from the topic map. The callback will be made after the transaction has been committed.

      The snapshot of a TMObjectIF given as the first argument will contain a snapshot view of the topic map object at the time the object was removed from the topic map. If the snapshot object was a topic then it will include all directly contained information, except association roles, at the time when the topic was removed through the method TopicMapIF.removeTopic(TopicIF). The data included are: the object ID, the topic types, all topic names and their complete data including their variant names, all occurrences and all their complete data. Note that any topic references in this snapshot will only be stubs and thus only contain the topic's object ID.