net.ontopia.topicmaps.core.index
Interface ClassInstanceIndexIF

All Superinterfaces:

IndexIF

All Known Implementing Classes:

ClassInstanceIndex, ClassInstanceIndex

public interface ClassInstanceIndexIF
extends IndexIF

PUBLIC: Interface implemented by objects providing quick lookup facilities to find topics used as types, and the instances of those types, within a topic map.

Method Summary

java.util.Collection<AssociationRoleIF>	getAssociationRoles(TopicIF association_role_type) PUBLIC: Gets all association roles that are of the given type.
java.util.Collection<TopicIF>	getAssociationRoleTypes() PUBLIC: Gets the topics that are used as association role types.
java.util.Collection<AssociationIF>	getAssociations(TopicIF association_type) PUBLIC: Gets all associations that are of the given type.
java.util.Collection<TopicIF>	getAssociationTypes() PUBLIC: Gets the topics that are used as association types.
java.util.Collection<OccurrenceIF>	getOccurrences(TopicIF occurrence_type) PUBLIC: Gets all occurrences that are of the given type.
java.util.Collection<TopicIF>	getOccurrenceTypes() PUBLIC: Gets the topics that are used as occurrence types.
java.util.Collection<TopicNameIF>	getTopicNames(TopicIF name_type) PUBLIC: Gets all topic names that are of the given type.
java.util.Collection<TopicIF>	getTopicNameTypes() PUBLIC: Gets the topics that are used as topic name types.
java.util.Collection<TopicIF>	getTopics(TopicIF topic_type) PUBLIC: Gets all topics that are instances of the given type.
java.util.Collection<TopicIF>	getTopicTypes() PUBLIC: Gets all topics that are used as topic types.
boolean	usedAsAssociationRoleType(TopicIF topic) PUBLIC: Returns true if the topic is used as an association role type.
boolean	usedAsAssociationType(TopicIF topic) PUBLIC: Returns true if the topic is used as an association type.
boolean	usedAsOccurrenceType(TopicIF topic) PUBLIC: Returns true if the topic is used as an occurrence type.
boolean	usedAsTopicNameType(TopicIF topic) PUBLIC: Returns true if the topic is used as an topic name type.
boolean	usedAsTopicType(TopicIF topic) PUBLIC: Returns true if the topic is used as a topic type somewhere.
boolean	usedAsType(TopicIF topic) PUBLIC: Returns true if the topic is used as a type somewhere.

Method Detail

getTopics

java.util.Collection<TopicIF> getTopics(TopicIF topic_type)

PUBLIC: Gets all topics that are instances of the given type. Topic types are an abbreviated form of an association having roles for type and instance. This index provides optimized handling for topic types.

Parameters:

topic_type - The given type; an object implementing TopicIF.

Returns:

A collection of TopicIF objects; the instances of the type represented by the given topic.

getTopicNames

java.util.Collection<TopicNameIF> getTopicNames(TopicIF name_type)

PUBLIC: Gets all topic names that are of the given type.

Parameters:

name_type - The given type; an object implementing TopicIF.

Returns:

A collection of TopicNameIF objects; topic names with the type represented by the given topic.

Since:

3.0

getOccurrences

java.util.Collection<OccurrenceIF> getOccurrences(TopicIF occurrence_type)

PUBLIC: Gets all occurrences that are of the given type.

Parameters:

occurrence_type - The given type; an object implementing TopicIF.

Returns:

A collection of OccurrenceIF objects; occurrences with the type represented by the given topic.

getAssociations

java.util.Collection<AssociationIF> getAssociations(TopicIF association_type)

PUBLIC: Gets all associations that are of the given type.

Parameters:

association_type - The given type; an object implementing TopicIF.

Returns:

A collection of AssociationIF objects; associations with the type represented by the given topic.

getAssociationRoles

java.util.Collection<AssociationRoleIF> getAssociationRoles(TopicIF association_role_type)

PUBLIC: Gets all association roles that are of the given type.

Parameters:

association_role_type - The given type; an object implementing TopicIF.

Returns:

A collection of AssociationRoleIF objects; association roles with the type represented by the given topic.

getTopicTypes

java.util.Collection<TopicIF> getTopicTypes()

PUBLIC: Gets all topics that are used as topic types.

Returns:

A collection of TopicIF objects, each of which serves as a type for some topic.

getTopicNameTypes

java.util.Collection<TopicIF> getTopicNameTypes()

PUBLIC: Gets the topics that are used as topic name types.

Returns:

A collection of TopicIF objects, each of which serves as a type for some topic name.

Since:

3.0

getOccurrenceTypes

java.util.Collection<TopicIF> getOccurrenceTypes()

PUBLIC: Gets the topics that are used as occurrence types.

Returns:

A collection of TopicIF objects, each of which serves as a type for some occurrence.

getAssociationTypes

java.util.Collection<TopicIF> getAssociationTypes()

PUBLIC: Gets the topics that are used as association types.

Returns:

A collection of TopicIF objects, each of which serves as a type for some association.

getAssociationRoleTypes

java.util.Collection<TopicIF> getAssociationRoleTypes()

PUBLIC: Gets the topics that are used as association role types.

Returns:

A collection of TopicIF objects, each of which serves as a type for some association role.

usedAsTopicType

boolean usedAsTopicType(TopicIF topic)

PUBLIC: Returns true if the topic is used as a topic type somewhere.

Parameters:

topic - An object implementing TopicIF.

Returns:

Boolean: true if the given topic serves as a type for some topic; false otherwise.

usedAsTopicNameType

boolean usedAsTopicNameType(TopicIF topic)

PUBLIC: Returns true if the topic is used as an topic name type.

Parameters:

topic - An object implementing TopicIF.

Returns:

Boolean: true if the given topic serves as a type for some topic name; false otherwise.

Since:

3.0

usedAsOccurrenceType

boolean usedAsOccurrenceType(TopicIF topic)

PUBLIC: Returns true if the topic is used as an occurrence type.

Parameters:

topic - An object implementing TopicIF.

Returns:

Boolean: true if the given topic serves as a type for some occurrence; false otherwise.

usedAsAssociationType

boolean usedAsAssociationType(TopicIF topic)

PUBLIC: Returns true if the topic is used as an association type.

Parameters:

topic - An object implementing TopicIF.

Returns:

Boolean: true if the given topic serves as a type for some association; false otherwise.

usedAsAssociationRoleType

boolean usedAsAssociationRoleType(TopicIF topic)

PUBLIC: Returns true if the topic is used as an association role type.

Parameters:

topic - An object implementing TopicIF.

Returns:

Boolean: true if the given topic serves as a type for some association role; false otherwise.

usedAsType

boolean usedAsType(TopicIF topic)

PUBLIC: Returns true if the topic is used as a type somewhere.

Parameters:

topic - An object implementing TopicIF.

Returns:

Boolean: true if the given topic serves as a type for any topic map object; false otherwise.