AbstractTypingTopic (Ontopia)

java.lang.Object
- ontopoly.model.Topic
- - ontopoly.model.AbstractTypingTopic

Direct Known Subclasses:

AssociationType, IdentityType, NameType, OccurrenceType, RoleType, TopicType
```
public abstract class AbstractTypingTopic
extends Topic
```
INTERNAL: Common superclass for all typing topics, like association types, topic types, role types, etc. FIXME: Should there be another subtype for isHidden, isReadOnly etc?

Constructor Summary

Constructors
Constructor Description

AbstractTypingTopic(TopicIF topicIF, TopicMap tm)
Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract Collection<? extends FieldDefinition>`	`getDeclaredByFields()`	Returns the field definitions that are declared for this typing topic.
`abstract LocatorIF`	`getLocatorIF()`	Gets the LocatorIF for this typing topic.
`boolean`	`isHidden()`	Returns true if this typing topic is hidden.
`boolean`	`isReadOnly()`	Returns true if this typing topic is read-only.

Methods inherited from class ontopoly.model.Topic
addTopicType, copyCharacteristics, equals, findDependentObjects, getDependentObjects, getFieldInstances, getFieldInstances, getId, getMostSpecificTopicType, getName, getTopicIF, getTopicMap, getTopicTypes, hashCode, isAssociationType, isFieldDefinition, isInstanceOf, isInstanceOf, isNameType, isOccurrenceType, isOntologyTopic, isOntologyType, isPrivateSystemTopic, isPublicSystemTopic, isRoleType, isSystemTopic, isTopicMap, isTopicType, remove, removeTopicType, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AbstractTypingTopic
```
public AbstractTypingTopic(TopicIF topicIF,
                           TopicMap tm)
```
    Constructor.
    
    Parameters:
    
    topicIF - the TopicIF object associated with this topic.
    
    tm - the TopicMap this topic belongs to.
- Method Detail
  - getLocatorIF
```
public abstract LocatorIF getLocatorIF()
```
    Gets the LocatorIF for this typing topic. The locator is the PSI used by the ontology topic map model.p
    
    Returns:
    
    the LocatorIF for this typing topic.
  - isReadOnly
```
public boolean isReadOnly()
```
    Returns true if this typing topic is read-only. If the topic type is read-only it cannot be edited or deleted.
    
    Returns:
    
    true if read only is turned on.
  - isHidden
```
public boolean isHidden()
```
    Returns true if this typing topic is hidden. NOTE: this feature is not yet supported.
    
    Returns:
    
    true if hidden is turned on.
  - getDeclaredByFields
```
public abstract Collection<? extends FieldDefinition> getDeclaredByFields()
```
    Returns the field definitions that are declared for this typing topic.
    
    Returns:
    
    a list of FieldDefinitions.