org.tmapi.index.core
Interface AssociationRolesIndex

All Superinterfaces:

Index, TopicMapSystem.ConfigurableHelperObject

public interface AssociationRolesIndex

extends Index

An index of the AssociationRole in the indexed TopicMap. This index provides methods to retrieve AssociationRole instances by their type and to retrieve the collection of all Topics which define the type of one or more AssociationRole instances in the indexed TopicMap.

Method Summary

java.util.Collection	getAssociationRolesByType(Topic type) Returns all AssociationRole instances typed by the Topic type in the indexed Topic Map The return value may be an empty Collection but must never be null.
java.util.Collection	getAssociationRoleTypes() Returns all Topic instances used to type AssociationRole instances in the indexed TopicMap The return value may be an empty Collection but must never be null.

Methods inherited from interface org.tmapi.index.Index

close, getFlags, isOpen, open, reindex

Methods inherited from interface org.tmapi.core.TopicMapSystem.ConfigurableHelperObject

configure

Method Detail

getAssociationRoleTypes

public java.util.Collection getAssociationRoleTypes()

Returns all Topic instances used to type AssociationRole instances in the indexed TopicMap The return value may be an empty Collection but must never be null.

Returns:

a Collection of Topic instances.

getAssociationRolesByType

public java.util.Collection getAssociationRolesByType(Topic type)

Returns all AssociationRole instances typed by the Topic type in the indexed Topic Map The return value may be an empty Collection but must never be null.

Parameters:

type - The type of the AssociationRole instances to be returned. If type is null a collection containing all untyped AssociationRoles will be returned

Returns:

a Collection of AssociationRole instances.