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

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

Method Detail

getOccurrences

Collection<OccurrenceIF> getOccurrences(String value)

INTERNAL: Gets all occurrences that have the specified value independent of datatype.

Returns:

A collection of OccurrenceIF objects.

getOccurrences

Collection<OccurrenceIF> getOccurrences(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

Collection<OccurrenceIF> getOccurrencesByPrefix(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

Collection<OccurrenceIF> getOccurrencesByPrefix(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

Iterator<OccurrenceIF> getValuesGreaterThanOrEqual(String value)

INTERNAL: Gets all occurrence values that are greather than or equal to the given value.

getValuesSmallerThanOrEqual

Iterator<OccurrenceIF> getValuesSmallerThanOrEqual(String value)

INTERNAL: Gets all occurrence values that are smaller than or equal to the given value.