Package net.ontopia.topicmaps.core.index

Interface NameIndexIF

All Superinterfaces:
IndexIF
All Known Implementing Classes:
NameIndex, NameIndex
public interface NameIndexIF extends IndexIF
PUBLIC: Index that holds information about the names of topics in the topic map. The intention is to provide quick lookup of objects by name.

  • Method Details

    • getTopicNames

      Collection<TopicNameIF> getTopicNames(String name_value)
      PUBLIC: Gets all topic names that have the given name value (in any scope).
      Parameters:
      name_value - A string; the value of a topic name.
      Returns:
      A collection of TopicNameIF objects with the given name value.

    • getTopicNames

      Collection<TopicNameIF> getTopicNames(String value, TopicIF topicNameType)
      PUBLIC: Gets all topic names that have the given name value (in any scope) and topicNameType.
      Parameters:
      value - A string; the value of a topic name
      topicNameType - A TopicIF; the type of a topic name
      Returns:
      A collection of TopicNameIF objects with the given name value and type.
      Since:
      5.4.0

    • getVariants

      Collection<VariantNameIF> getVariants(String value)
      INTERNAL: Gets all variants that have the specified value independent of datatype.
      Returns:
      A collection of VariantNameIF objects.

    • getVariants

      Collection<VariantNameIF> getVariants(String value, LocatorIF datatype)
      INTERNAL: Gets all variants that have the specified value and datatype.
      Returns:
      A collection of VariantNameIF objects.
      Since:
      4.0