org.tm4j.topicmap.index.basic
Interface MemberTypesIndex

All Superinterfaces:

Index

public interface MemberTypesIndex

extends Index

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

Since:

0.7.0

Author:

Kal Ahmed

Method Summary

java.util.Collection	getMembersOfType(Topic type) Returns the members which are typed by type.
java.util.Collection	getMembersOfType(Topic type, boolean includeMergedTopics) Returns the members which are typed by the topic type.
java.util.Collection	getMemberTypes() Returns the topics which define the type of one or more members in the topic map.

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

close, isOpen, open, reindex

Method Detail

getMembersOfType

public java.util.Collection getMembersOfType(Topic type)

Returns the members which are typed by type.

Parameters:

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

Returns:

An unmodifiable Collection containing those Members for which type defines the member type.

getMembersOfType

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

Returns the members which are typed by the topic type. If includeMergedTopics is true, the returned Collection also includes all members typed by any topic that is merged with type.

Parameters:

type - the member type to query for

includeMergedTopics - if true, then the return set includes all Members that are typed by a topic merged with type.

Returns:

an unmodifiable Collection of Member instances

getMemberTypes

public java.util.Collection getMemberTypes()

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

Returns:

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