net.ontopia.topicmaps.core.index
Interface OccurrenceIndexIF

All Superinterfaces:
IndexIF
All Known Implementing Classes:
OccurrenceIndex, OccurrenceIndex

public interface OccurrenceIndexIF
extends IndexIF

INTERNAL: Index that holds information about occurrences in the topic map. The intention is to provide quick lookup of occurrences by value.

Since:
2.2

Method Summary
 java.util.Collection<OccurrenceIF> getOccurrences(java.lang.String value)
          INTERNAL: Gets all occurrences that have the specified value independent of datatype.
 java.util.Collection<OccurrenceIF> getOccurrences(java.lang.String value, LocatorIF datatype)
          INTERNAL: Gets all occurrences that have the specified value and datatype.
 java.util.Collection<OccurrenceIF> getOccurrencesByPrefix(java.lang.String prefix)
          INTERNAL: Gets all occurrences of any datatype that have a value starting with the specified prefix.
 java.util.Collection<OccurrenceIF> getOccurrencesByPrefix(java.lang.String prefix, LocatorIF datatype)
          INTERNAL: Gets all occurrences that have the specifed datatype and a value starting with the specified prefix.
 java.util.Iterator<OccurrenceIF> getValuesGreaterThanOrEqual(java.lang.String value)
          INTERNAL: Gets all occurrence values that are greather than or equal to the given value.
 java.util.Iterator<OccurrenceIF> getValuesSmallerThanOrEqual(java.lang.String value)
          INTERNAL: Gets all occurrence values that are smaller than or equal to the given value.
 

Method Detail

getOccurrences

java.util.Collection<OccurrenceIF> getOccurrences(java.lang.String value)
INTERNAL: Gets all occurrences that have the specified value independent of datatype.

Returns:
A collection of OccurrenceIF objects.

getOccurrences

java.util.Collection<OccurrenceIF> getOccurrences(java.lang.String value,
                                                  LocatorIF datatype)
INTERNAL: Gets all occurrences that have the specified value and datatype.

Returns:
A collection of OccurrenceIF objects.
Since:
4.0

getOccurrencesByPrefix

java.util.Collection<OccurrenceIF> getOccurrencesByPrefix(java.lang.String prefix)
INTERNAL: Gets all occurrences of any datatype that have a value starting with the specified prefix.

Returns:
A collection of OccurrenceIF objects.

getOccurrencesByPrefix

java.util.Collection<OccurrenceIF> getOccurrencesByPrefix(java.lang.String prefix,
                                                          LocatorIF datatype)
INTERNAL: Gets all occurrences that have the specifed datatype and a value starting with the specified prefix.

Returns:
A collection of OccurrenceIF objects.
Since:
4.0

getValuesGreaterThanOrEqual

java.util.Iterator<OccurrenceIF> getValuesGreaterThanOrEqual(java.lang.String value)
INTERNAL: Gets all occurrence values that are greather than or equal to the given value.


getValuesSmallerThanOrEqual

java.util.Iterator<OccurrenceIF> getValuesSmallerThanOrEqual(java.lang.String value)
INTERNAL: Gets all occurrence values that are smaller than or equal to the given value.



Copyright © 2000-2012 Ontopia.