org.tm4j.topicmap.index.basic
Interface OccurrenceTypesIndex

All Superinterfaces:

Index

public interface OccurrenceTypesIndex

extends Index

This interface provides mechanisms dealing with member types, the topics defining the types of occurrences.

Since:

0.7.0

Author:

Kal Ahmed

Method Summary

java.util.Collection	getOccurrencesOfType(Topic type) Returns the occurrences which are typed by type and any topics merged with type.
java.util.Collection	getOccurrencesOfType(Topic type, boolean includeMergedTopics) Returns the occurrences which are typed by type.
java.util.Collection	getOccurrenceTypes() Returns the topics which define the type of one or more occurrences in the topic map.

Methods inherited from interface org.tm4j.topicmap.index.Index

close, isOpen, open, reindex

Method Detail

getOccurrencesOfType

public java.util.Collection getOccurrencesOfType(Topic type)

Returns the occurrences which are typed by type and any topics merged with type.

Parameters:

type - The topic which types all of the occurremces returned.

Returns:

An unmodifiable Collection containing those Occurrences for which type or a topic merged with type defines the occurrence type.

getOccurrencesOfType

public java.util.Collection getOccurrencesOfType(Topic type,
                                                 boolean includeMergedTopics)

Returns the occurrences which are typed by type. If includeMergedTopics is true then the returned collection also includes all Occurrences which are typed by topics merged with type.

Parameters:

type - the type to query for

includeMergedTopics -

Returns:

an unmodifiable Collection of Occurrence instances.

getOccurrenceTypes

public java.util.Collection getOccurrenceTypes()

Returns the topics which define the type of one or more occurrences in the topic map.

Returns:

An unmodifiable Collection containing those Topics which are the type of at least one occurrence in the topic map indexed.