org.tm4j.topicmap.index.basic
Interface AssociationTypesIndex

All Superinterfaces:
Index

public interface AssociationTypesIndex
extends Index

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

Since:
0.7.0
Author:
Kal Ahmed

Method Summary
 java.util.Collection getAssociationsOfType(Topic type)
          Returns the associations which are typed by type.
 java.util.Collection getAssociationsOfType(Topic type, boolean includeMergedTopics)
          Returns the associations typed by type and, if includeMergedTopics is true, the associations typed by any topics that are merged with type.
 java.util.Collection getAssociationTypes()
          Returns the topics which define the type of one or more associations in the topic map.
 
Methods inherited from interface org.tm4j.topicmap.index.Index
close, isOpen, open, reindex
 

Method Detail

getAssociationsOfType

public java.util.Collection getAssociationsOfType(Topic type,
                                                  boolean includeMergedTopics)
Returns the associations typed by type and, if includeMergedTopics is true, the associations typed by any topics that are merged with type.

Parameters:
type - The type of the returned associations
includeMergedTopics - if true, then associations typed by topics merged with type are also returned.
Returns:
An unmodifiable Collection of Associations
Since:
0.9.5

getAssociationsOfType

public java.util.Collection getAssociationsOfType(Topic type)
Returns the associations which are typed by type.

Parameters:
type - The topic which types all of the associations returned.
Returns:
An unmodifiable Collection containing those Associations for which type defines the association type.

getAssociationTypes

public java.util.Collection getAssociationTypes()
Returns the topics which define the type of one or more associations in the topic map.

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