Package net.ontopia.topicmaps.core.index

Interface ScopeIndexIF

All Superinterfaces:
IndexIF
All Known Implementing Classes:
ScopeIndex, ScopeIndex
public interface ScopeIndexIF extends IndexIF
PUBLIC: Implemented by objects holding information about topics used as themes in scopes, and about topic map objects that have scope. The intention is to provide quick lookup of such information.

  • Method Details

    • getTopicNames

      Collection<TopicNameIF> getTopicNames(TopicIF theme)
      PUBLIC: Gets all topic names that have the given topic in their direct scope.
      Parameters:
      theme - The given topic.
      Returns:
      A collection of TopicNameIF objects; the topic names that have the given topic in their direct scope.

    • getVariants

      Collection<VariantNameIF> getVariants(TopicIF theme)
      PUBLIC: Gets all variant names that have the given topic in their direct scope. Note that 'variant' does not have a 'scope' child element, but only a 'parameters' child element, which is considered by the engine to be the same as a scope in practice.
      Parameters:
      theme - The given topic.
      Returns:
      A collection of VariantNameIF objects; the variant names that have the given topic in their parameters.

    • getOccurrences

      Collection<OccurrenceIF> getOccurrences(TopicIF theme)
      PUBLIC: Gets all occurrences that have the given topic in their direct scope.
      Parameters:
      theme - The given topic.
      Returns:
      A collection of OccurrenceIF objects; the occurrences that have the given topic in their direct scope.

    • getAssociations

      Collection<AssociationIF> getAssociations(TopicIF theme)
      PUBLIC: Gets all associations that have the given topic in their direct scope.
      Parameters:
      theme - The given topic.
      Returns:
      A collection of AssociationIF objects; the associations that have the given topic in their direct scope.

    • getTopicNameThemes

      Collection<TopicIF> getTopicNameThemes()
      PUBLIC: Gets the set of all topics that are used in the direct scope of at least one topic name.
      Returns:
      A collection of TopicIF objects.

    • getVariantThemes

      Collection<TopicIF> getVariantThemes()
      PUBLIC: Gets the set of all topics that are used in the direct scope of at least one variant name.
      Returns:
      A collection of TopicIF objects.

    • getOccurrenceThemes

      Collection<TopicIF> getOccurrenceThemes()
      PUBLIC: Gets the set of all topics that are used in the direct scope of at least one occurrence.
      Returns:
      A collection of TopicIF objects.

    • getAssociationThemes

      Collection<TopicIF> getAssociationThemes()
      PUBLIC: Gets the set of all topics that are used in the direct scope of at least one association.
      Returns:
      A collection of TopicIF objects.

    • usedAsTopicNameTheme

      boolean usedAsTopicNameTheme(TopicIF topic)
      PUBLIC: Returns true if the topic has been used in the direct scope of at least one topic name.

    • usedAsVariantTheme

      boolean usedAsVariantTheme(TopicIF topic)
      PUBLIC: Returns true if the topic has been used in the direct scope of at least one variant name.

    • usedAsOccurrenceTheme

      boolean usedAsOccurrenceTheme(TopicIF topic)
      PUBLIC: Returns true if the topic has been used in the direct scope of at least one occurrence.

    • usedAsAssociationTheme

      boolean usedAsAssociationTheme(TopicIF topic)
      PUBLIC: Returns true if the topic has been used in the direct scope of at least one association.

    • usedAsTheme

      boolean usedAsTheme(TopicIF topic)
      PUBLIC: Returns true if the topic has been used in a direct scope somewhere in the topic map.