Package net.ontopia.topicmaps.core

Interface TopicMapBuilderIF

All Known Implementing Classes:
RemoteTopicMapBuilder, TopicMapBuilder, TopicMapBuilder
public interface TopicMapBuilderIF
PUBLIC: A helper for building topic map object structures.

The builder creates topic map objects.

  • Field Details

  • Method Details

    • getTopicMap

      TopicMapIF getTopicMap()
      PUBLIC: Returns the topic map to which this builder belongs.
      Returns:
      An object implementing TopicMapIF.
      Since:
      4.0

    • makeTopic

      TopicIF makeTopic()
      PUBLIC: Makes a new topic for the current topic map.
      Returns:
      An object implementing TopicIF, and belonging to the given topic map.

    • makeTopic

      TopicIF makeTopic(TopicIF topic_type)
      PUBLIC: Makes a new topic of the given type for the current topic map.
      Parameters:
      topic_type - The type of the created topic, an object implementing TopicIF.
      Returns:
      An object implementing TopicIF, and belonging to the current topic map.
      Since:
      1.3.2

    • makeTopic

      TopicIF makeTopic(Collection<TopicIF> topic_types)
      PUBLIC: Makes a new topic of the given types for the current topic map.
      Parameters:
      topic_types - A collection of topics defining the type of the created topic, all objects implementing TopicIF.
      Returns:
      An object implementing TopicIF, and belonging to the current topic map.
      Since:
      1.3.2

    • makeTopicName

      TopicNameIF makeTopicName(TopicIF topic, String value)
      PUBLIC: Makes a new untyped topic name with the given value for the given topic.
      Parameters:
      topic - A topic; an object implementing TopicIF.
      value - A string which is the value of the topic name.
      Returns:
      An object implementing TopicNameIF, having the given value, and belonging to the given topic.

    • makeTopicName

      TopicNameIF makeTopicName(TopicIF topic, TopicIF bntype, String value)
      PUBLIC: Makes a new topic name with the given type and value for the given topic.
      Parameters:
      topic - A topic; an object implementing TopicIF.
      bntype - The type of the created topic name; an object implementing TopicIF.
      value - A string which is the value of the topic name.
      Returns:
      An object implementing TopicNameIF, having the given value, and belonging to the given topic.
      Since:
      3.0

    • makeVariantName

      VariantNameIF makeVariantName(TopicNameIF name, String value, Collection<TopicIF> scope)
      PUBLIC: Makes a new variant name with the specified name value for the specified topic name in the given scope.
      Parameters:
      name - The given topic name; an object implmenting TopicNameIF.
      value - A string which is the value of the variant name.
      scope - The scope in which this variant name is applicable.
      Returns:
      An object implementing VariantNameIF.
      Since:
      4.0

    • makeVariantName

      VariantNameIF makeVariantName(TopicNameIF name, LocatorIF locator, Collection<TopicIF> scope)
      PUBLIC: Makes a new variant name with the given locator for the specified topic name in the given scope.
      Parameters:
      name - The given topic name; an object implmenting TopicNameIF.
      locator - The locator for the variant name.
      scope - The scope in which this variant name is applicable.
      Returns:
      An object implementing VariantNameIF.
      Since:
      4.0

    • makeVariantName

      VariantNameIF makeVariantName(TopicNameIF name, String value, LocatorIF datatype, Collection<TopicIF> scope)
      PUBLIC: Makes a new variant name with the specified name value and datatype for the specified name in the given scope.
      Parameters:
      name - The given topic name; an object implmenting TopicNameIF.
      value - A string which is the value of the variant name.
      datatype - The datatype of the value
      scope - The scope in which this variant name is applicable.
      Returns:
      An object implementing VariantNameIF.
      Since:
      4.0

    • makeVariantName

      VariantNameIF makeVariantName(TopicNameIF name, Reader value, long length, LocatorIF datatype, Collection<TopicIF> scope)
      PUBLIC: Makes a new variant name with the specified name value reader and datatype for the specified topic name in the given scope.
      Parameters:
      name - The given topic name; an object implmenting TopicNameIF.
      value - A reader which contains the value of the variant name.
      length - The length of the reader value.
      datatype - The datatype of the value
      scope - The scope in which this variant name is applicable.
      Returns:
      An object implementing VariantNameIF.
      Since:
      4.0

    • makeOccurrence

      OccurrenceIF makeOccurrence(TopicIF topic, TopicIF occurs_type, String value)
      PUBLIC: Makes a new internal occurrence with the given type and value for the given topic.
      Parameters:
      topic - The given topic; an object implementing TopicIF.
      occurs_type - The type of the created occurrence; an object implementing TopicIF.
      value - The value of the occurrence;
      Returns:
      An object implementing OccurrenceIF, having the given type and value, and belonging to the given topic.

    • makeOccurrence

      OccurrenceIF makeOccurrence(TopicIF topic, TopicIF occurs_type, String value, LocatorIF datatype)
      PUBLIC: Makes a new internal occurrence with the given type and value for the given topic.
      Parameters:
      topic - The given topic; an object implementing TopicIF.
      occurs_type - The type of the created occurrence; an object implementing TopicIF.
      value - The value of the occurrence;
      datatype - The datatype of the value.
      Returns:
      An object implementing OccurrenceIF, having the given type and value, and belonging to the given topic.
      Since:
      4.0

    • makeOccurrence

      OccurrenceIF makeOccurrence(TopicIF topic, TopicIF occurs_type, Reader value, long length, LocatorIF datatype)
      PUBLIC: Makes a new internal occurrence with the given type and value for the given topic.
      Parameters:
      topic - The given topic; an object implementing TopicIF.
      occurs_type - The type of the created occurrence; an object implementing TopicIF.
      value - The reader that contains the value of the occurrence;
      length - The length of the reader value.
      datatype - The datatype of the value.
      Returns:
      An object implementing OccurrenceIF, having the given type and value, and belonging to the given topic.
      Since:
      4.0

    • makeOccurrence

      OccurrenceIF makeOccurrence(TopicIF topic, TopicIF occurs_type, LocatorIF locator)
      PUBLIC: Makes a new external occurrence with the given type and locator for the given topic.
      Parameters:
      topic - The given topic; an object implementing TopicIF.
      occurs_type - The role type of the created occurrence; an object implementing TopicIF.
      locator - The locator of the occurrence; an object implementing LocatorIF.
      Returns:
      An object implementing OccurrenceIF, having the given type and locator, and belonging to the given topic.

    • makeAssociation

      AssociationIF makeAssociation(TopicIF assoc_type)
      PUBLIC: Makes a new association with the given type in the current topic map.
      Parameters:
      assoc_type - The association type; an object implementing TopicIF.
      Returns:
      An object implementing AssociationIF, having the given type, and belonging to the current topic map.

    • makeAssociation

      AssociationIF makeAssociation(TopicIF assoc_type, TopicIF role_type, TopicIF player)
      PUBLIC: Makes a new unary association with the given type in the current topic map.
      Parameters:
      assoc_type - The association type; an object implementing TopicIF.
      role_type - The role type of the first role.
      player - The player of the first role.
      Returns:
      An object implementing AssociationIF, having the given type, a single role and belonging to the current topic map.
      Since:
      4.0

    • makeAssociationRole

      AssociationRoleIF makeAssociationRole(AssociationIF assoc, TopicIF role_type, TopicIF player)
      PUBLIC: Makes a new association role with the given type and player for the specified association.
      Parameters:
      assoc - The given association; an object implementing AssociationIF.
      role_type - The given type; an object implementing TopicIF.
      player - The given role player; an object implementing TopicIF.
      Returns:
      An object implementing AssociationRoleIF, of the given type, and belonging to the given association.
      Since:
      1.3