ClassInstanceIndexIF (Ontopia)

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Collection<OccurrenceIF>`	`getAllOccurrences()` PUBLIC: Gets all occurrences that are in the topic map.
`Collection<TopicNameIF>`	`getAllTopicNames()` PUBLIC: Gets all topic names that are in the topic map.
`Collection<VariantNameIF>`	`getAllVariantNames()` PUBLIC: Gets all variant names that are in the topic map.
`Collection<AssociationRoleIF>`	`getAssociationRoles(TopicIF association_role_type)` PUBLIC: Gets all association roles that are of the given type.
`Collection<AssociationRoleIF>`	`getAssociationRoles(TopicIF association_role_type, TopicIF association_type)` PUBLIC: Gets all association roles that are of the given type and part of an association of given type.
`Collection<TopicIF>`	`getAssociationRoleTypes()` PUBLIC: Gets the topics that are used as association role types.
`Collection<AssociationIF>`	`getAssociations(TopicIF association_type)` PUBLIC: Gets all associations that are of the given type.
`Collection<TopicIF>`	`getAssociationTypes()` PUBLIC: Gets the topics that are used as association types.
`Collection<OccurrenceIF>`	`getOccurrences(TopicIF occurrence_type)` PUBLIC: Gets all occurrences that are of the given type.
`Collection<TopicIF>`	`getOccurrenceTypes()` PUBLIC: Gets the topics that are used as occurrence types.
`Collection<TopicNameIF>`	`getTopicNames(TopicIF name_type)` PUBLIC: Gets all topic names that are of the given type.
`Collection<TopicIF>`	`getTopicNameTypes()` PUBLIC: Gets the topics that are used as topic name types.
`Collection<TopicIF>`	`getTopics(TopicIF topic_type)` PUBLIC: Gets all topics that are instances of the given type.
`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
```
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
```
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
  - getAllTopicNames
```
Collection<TopicNameIF> getAllTopicNames()
```
    PUBLIC: Gets all topic names that are in the topic map.
    
    Returns:
    
    A collection of TopicNameIF objects
    
    Since:
    
    5.4.0
  - getAllVariantNames
```
Collection<VariantNameIF> getAllVariantNames()
```
    PUBLIC: Gets all variant names that are in the topic map.
    
    Returns:
    
    A collection of VariantNameIF objects
    
    Since:
    
    5.4.0
  - getOccurrences
```
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.
  - getAllOccurrences
```
Collection<OccurrenceIF> getAllOccurrences()
```
    PUBLIC: Gets all occurrences that are in the topic map.
    
    Returns:
    
    A collection of OccurrenceIF objects
    
    Since:
    
    5.4.0
  - getAssociations
```
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
```
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.
  - getAssociationRoles
```
Collection<AssociationRoleIF> getAssociationRoles(TopicIF association_role_type,
                                                  TopicIF association_type)
```
    PUBLIC: Gets all association roles that are of the given type and part of an association of given type.
    
    Parameters:
    
    association_role_type - The given role type; an object implementing TopicIF.
    
    association_type - The given association type; an object implementing TopicIF.
    
    Returns:
    
    A collection of AssociationRoleIF objects; association roles with the type represented by the given topic and part of an association with given type.
  - getTopicTypes
```
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
```
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
```
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
```
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
```
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.

Interface ClassInstanceIndexIF

Method Summary

Method Detail

getTopics

getTopicNames

getAllTopicNames

getAllVariantNames

getOccurrences

getAllOccurrences

getAssociations

getAssociationRoles

getAssociationRoles

getTopicTypes

getTopicNameTypes

getOccurrenceTypes

getAssociationTypes

getAssociationRoleTypes

usedAsTopicType

usedAsTopicNameType

usedAsOccurrenceType

usedAsAssociationType

usedAsAssociationRoleType

usedAsType