Package net.ontopia.topicmaps.impl.basic.index

Class ClassInstanceIndex

java.lang.Object
net.ontopia.topicmaps.impl.utils.AbstractIndex
net.ontopia.topicmaps.impl.utils.BasicIndex
net.ontopia.topicmaps.impl.basic.index.ClassInstanceIndex
All Implemented Interfaces:
ClassInstanceIndexIF, IndexIF, EventListenerIF
public class ClassInstanceIndex extends BasicIndex implements ClassInstanceIndexIF
INTERNAL: The basic dynamic class instance index implementation.

  • Field Details

  • Method Details

    • getTopics

      public Collection<TopicIF> getTopics(TopicIF topic_type)
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets all topics that are instances of the given type. Topic types are an abbreviated form of an association having roles for type and instance. This index provides optimized handling for topic types.
      Specified by:
      getTopics in interface ClassInstanceIndexIF
      Parameters:
      topic_type - The given type; an object implementing TopicIF.
      Returns:
      A collection of TopicIF objects; the instances of the type represented by the given topic.

    • getTopicNames

      public Collection<TopicNameIF> getTopicNames(TopicIF basename_type)
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets all topic names that are of the given type.
      Specified by:
      getTopicNames in interface ClassInstanceIndexIF
      Parameters:
      basename_type - The given type; an object implementing TopicIF.
      Returns:
      A collection of TopicNameIF objects; topic names with the type represented by the given topic.

    • getAllTopicNames

      public Collection<TopicNameIF> getAllTopicNames()
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets all topic names that are in the topic map.
      Specified by:
      getAllTopicNames in interface ClassInstanceIndexIF
      Returns:
      A collection of TopicNameIF objects

    • getAllVariantNames

      public Collection<VariantNameIF> getAllVariantNames()
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets all variant names that are in the topic map.
      Specified by:
      getAllVariantNames in interface ClassInstanceIndexIF
      Returns:
      A collection of VariantNameIF objects

    • getOccurrences

      public Collection<OccurrenceIF> getOccurrences(TopicIF occurrence_type)
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets all occurrences that are of the given type.
      Specified by:
      getOccurrences in interface ClassInstanceIndexIF
      Parameters:
      occurrence_type - The given type; an object implementing TopicIF.
      Returns:
      A collection of OccurrenceIF objects; occurrences with the type represented by the given topic.

    • getAllOccurrences

      public Collection<OccurrenceIF> getAllOccurrences()
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets all occurrences that are in the topic map.
      Specified by:
      getAllOccurrences in interface ClassInstanceIndexIF
      Returns:
      A collection of OccurrenceIF objects

    • getAssociations

      public Collection<AssociationIF> getAssociations(TopicIF association_type)
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets all associations that are of the given type.
      Specified by:
      getAssociations in interface ClassInstanceIndexIF
      Parameters:
      association_type - The given type; an object implementing TopicIF.
      Returns:
      A collection of AssociationIF objects; associations with the type represented by the given topic.

    • getAssociationRoles

      public Collection<AssociationRoleIF> getAssociationRoles(TopicIF association_role_type)
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets all association roles that are of the given type.
      Specified by:
      getAssociationRoles in interface ClassInstanceIndexIF
      Parameters:
      association_role_type - The given type; an object implementing TopicIF.
      Returns:
      A collection of AssociationRoleIF objects; association roles with the type represented by the given topic.

    • getAssociationRoles

      public Collection<AssociationRoleIF> getAssociationRoles(TopicIF association_role_type, TopicIF association_type)
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets all association roles that are of the given type and part of an association of given type.
      Specified by:
      getAssociationRoles in interface ClassInstanceIndexIF
      Parameters:
      association_role_type - The given role type; an object implementing TopicIF.
      association_type - The given association type; an object implementing TopicIF.
      Returns:
      A collection of AssociationRoleIF objects; association roles with the type represented by the given topic and part of an association with given type.

    • getTopicTypes

      public Collection<TopicIF> getTopicTypes()
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets all topics that are used as topic types.
      Specified by:
      getTopicTypes in interface ClassInstanceIndexIF
      Returns:
      A collection of TopicIF objects, each of which serves as a type for some topic.

    • getTopicNameTypes

      public Collection<TopicIF> getTopicNameTypes()
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets the topics that are used as topic name types.
      Specified by:
      getTopicNameTypes in interface ClassInstanceIndexIF
      Returns:
      A collection of TopicIF objects, each of which serves as a type for some topic name.

    • getOccurrenceTypes

      public Collection<TopicIF> getOccurrenceTypes()
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets the topics that are used as occurrence types.
      Specified by:
      getOccurrenceTypes in interface ClassInstanceIndexIF
      Returns:
      A collection of TopicIF objects, each of which serves as a type for some occurrence.

    • getAssociationTypes

      public Collection<TopicIF> getAssociationTypes()
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets the topics that are used as association types.
      Specified by:
      getAssociationTypes in interface ClassInstanceIndexIF
      Returns:
      A collection of TopicIF objects, each of which serves as a type for some association.

    • getAssociationRoleTypes

      public Collection<TopicIF> getAssociationRoleTypes()
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Gets the topics that are used as association role types.
      Specified by:
      getAssociationRoleTypes in interface ClassInstanceIndexIF
      Returns:
      A collection of TopicIF objects, each of which serves as a type for some association role.

    • usedAsTopicType

      public boolean usedAsTopicType(TopicIF topic)
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Returns true if the topic is used as a topic type somewhere.
      Specified by:
      usedAsTopicType in interface ClassInstanceIndexIF
      Parameters:
      topic - An object implementing TopicIF.
      Returns:
      Boolean: true if the given topic serves as a type for some topic; false otherwise.

    • usedAsTopicNameType

      public boolean usedAsTopicNameType(TopicIF topic)
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Returns true if the topic is used as an topic name type.
      Specified by:
      usedAsTopicNameType in interface ClassInstanceIndexIF
      Parameters:
      topic - An object implementing TopicIF.
      Returns:
      Boolean: true if the given topic serves as a type for some topic name; false otherwise.

    • usedAsOccurrenceType

      public boolean usedAsOccurrenceType(TopicIF topic)
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Returns true if the topic is used as an occurrence type.
      Specified by:
      usedAsOccurrenceType in interface ClassInstanceIndexIF
      Parameters:
      topic - An object implementing TopicIF.
      Returns:
      Boolean: true if the given topic serves as a type for some occurrence; false otherwise.

    • usedAsAssociationType

      public boolean usedAsAssociationType(TopicIF topic)
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Returns true if the topic is used as an association type.
      Specified by:
      usedAsAssociationType in interface ClassInstanceIndexIF
      Parameters:
      topic - An object implementing TopicIF.
      Returns:
      Boolean: true if the given topic serves as a type for some association; false otherwise.

    • usedAsAssociationRoleType

      public boolean usedAsAssociationRoleType(TopicIF topic)
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Returns true if the topic is used as an association role type.
      Specified by:
      usedAsAssociationRoleType in interface ClassInstanceIndexIF
      Parameters:
      topic - An object implementing TopicIF.
      Returns:
      Boolean: true if the given topic serves as a type for some association role; false otherwise.

    • usedAsType

      public boolean usedAsType(TopicIF topic)
      Description copied from interface: ClassInstanceIndexIF
      PUBLIC: Returns true if the topic is used as a type somewhere.
      Specified by:
      usedAsType in interface ClassInstanceIndexIF
      Parameters:
      topic - An object implementing TopicIF.
      Returns:
      Boolean: true if the given topic serves as a type for any topic map object; false otherwise.