|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TopicIF
PUBLIC: This interface is implemented by objects representing topics in the topic map model.
Note that topic identity is a difficult area, since it depends on the availability of information from outside the topic map. In a nutshell, topics represent addressable subjects, but addressable subjects may be the same even if their locators are very different. In general, the determination of equality between addressable subjects cannot be fully guaranteed, and applications using this API will need to be aware of their limitations and capabilities in this respect - and that other topic map applications they communicate with may have lesser or greater powers to determine subject identity.
Field Summary | |
---|---|
static String |
EVENT_ADD_OCCURRENCE
|
static String |
EVENT_ADD_SUBJECTIDENTIFIER
|
static String |
EVENT_ADD_SUBJECTLOCATOR
|
static String |
EVENT_ADD_TOPICNAME
|
static String |
EVENT_ADD_TYPE
|
static String |
EVENT_ADDED
|
static String |
EVENT_MODIFIED
|
static String |
EVENT_REMOVE_OCCURRENCE
|
static String |
EVENT_REMOVE_SUBJECTIDENTIFIER
|
static String |
EVENT_REMOVE_SUBJECTLOCATOR
|
static String |
EVENT_REMOVE_TOPICNAME
|
static String |
EVENT_REMOVE_TYPE
|
static String |
EVENT_REMOVED
|
Fields inherited from interface net.ontopia.topicmaps.core.TMObjectIF |
---|
EVENT_ADD_ITEMIDENTIFIER, EVENT_REMOVE_ITEMIDENTIFIER |
Method Summary | |
---|---|
void |
addSubjectIdentifier(LocatorIF subject_identifier)
PUBLIC: Adds the given subject identifier to the set of subject identifiers for this topic. |
void |
addSubjectLocator(LocatorIF subject_locator)
PUBLIC: Adds the given subject locator to the set of subject locators for this topic. |
void |
addType(TopicIF type)
PUBLIC: Adds a type to this topic. |
Collection<AssociationIF> |
getAssociations()
PUBLIC: Gets the associations that have roles played by this topic. |
Collection<AssociationIF> |
getAssociationsByType(TopicIF type)
PUBLIC: Gets the associations that have roles played by this topic, where the association is of specified type. |
Collection<OccurrenceIF> |
getOccurrences()
PUBLIC: Gets the occurrences of this topic. |
Collection<OccurrenceIF> |
getOccurrencesByType(TopicIF type)
PUBLIC: Gets the occurrences of this topic with a specified type. |
ReifiableIF |
getReified()
PUBLIC: Returns the topic map object that this topic reifies. |
Collection<AssociationRoleIF> |
getRoles()
PUBLIC: Gets the association roles played by this topic. |
Collection<AssociationRoleIF> |
getRolesByType(TopicIF roletype)
PUBLIC: Gets the association roles of the specifed type played by this topic. |
Collection<AssociationRoleIF> |
getRolesByType(TopicIF roletype,
TopicIF assoc_type)
PUBLIC: Gets the association roles of the specifed type played by this topic. |
Collection<LocatorIF> |
getSubjectIdentifiers()
PUBLIC: Gets the subject identitifers of this topic. |
Collection<LocatorIF> |
getSubjectLocators()
PUBLIC: Gets the subject locators of this topic. |
Collection<TopicNameIF> |
getTopicNames()
PUBLIC: Gets the names of this topic. |
Collection<TopicNameIF> |
getTopicNamesByType(TopicIF type)
PUBLIC: Gets the topic names of this topic with a specified type. |
Collection<TopicIF> |
getTypes()
PUBLIC: Gets the types that this topic is an instance of. |
void |
merge(TopicIF topic)
EXPERIMENTAL: Merges the characteristics of one topic into another topic. |
void |
removeSubjectIdentifier(LocatorIF subject_identifier)
PUBLIC: Removes the given subject identifier from the set of subject identifiers for this topic. |
void |
removeSubjectLocator(LocatorIF subject_locator)
PUBLIC: Removes the given subject locator from the set of subject locators for this topic. |
void |
removeType(TopicIF type)
PUBLIC: Removes a type from this topic. |
Methods inherited from interface net.ontopia.topicmaps.core.TMObjectIF |
---|
addItemIdentifier, getItemIdentifiers, getObjectId, getTopicMap, isReadOnly, remove, removeItemIdentifier |
Field Detail |
---|
static final String EVENT_ADDED
static final String EVENT_MODIFIED
static final String EVENT_REMOVED
static final String EVENT_ADD_TYPE
static final String EVENT_REMOVE_TYPE
static final String EVENT_ADD_SUBJECTLOCATOR
static final String EVENT_REMOVE_SUBJECTLOCATOR
static final String EVENT_ADD_SUBJECTIDENTIFIER
static final String EVENT_REMOVE_SUBJECTIDENTIFIER
static final String EVENT_ADD_TOPICNAME
static final String EVENT_REMOVE_TOPICNAME
static final String EVENT_ADD_OCCURRENCE
static final String EVENT_REMOVE_OCCURRENCE
Method Detail |
---|
Collection<LocatorIF> getSubjectLocators()
void addSubjectLocator(LocatorIF subject_locator) throws ConstraintViolationException
subject_locator
- A locator for the subject locator to be added;
an object implementing LocatorIF.
ConstraintViolationException
- Thrown if the topic map
already has a topic with this subject locator.void removeSubjectLocator(LocatorIF subject_locator)
subject_locator
- A locator for the subject locator to be removed;
an object implementing LocatorIF.Collection<LocatorIF> getSubjectIdentifiers()
void addSubjectIdentifier(LocatorIF subject_identifier) throws ConstraintViolationException
subject_identifier
- A locator for the subject identifier to be added;
an object implementing LocatorIF.
ConstraintViolationException
- Thrown if the topic map
already has a topic with this addressable subject.void removeSubjectIdentifier(LocatorIF subject_identifier)
subject_identifier
- A locator for the subject identifier to be removed;
an object implementing LocatorIF.Collection<TopicIF> getTypes()
void addType(TopicIF type)
type
- The additional type; an object implementing TopicIF.void removeType(TopicIF type)
type
- The type to be removed; an object implementing TopicIF.Collection<TopicNameIF> getTopicNames()
Collection<TopicNameIF> getTopicNamesByType(TopicIF type)
Collection<OccurrenceIF> getOccurrences()
Collection<OccurrenceIF> getOccurrencesByType(TopicIF type)
Collection<AssociationRoleIF> getRoles()
Collection<AssociationRoleIF> getRolesByType(TopicIF roletype)
Collection<AssociationRoleIF> getRolesByType(TopicIF roletype, TopicIF assoc_type)
Collection<AssociationIF> getAssociations()
Collection<AssociationIF> getAssociationsByType(TopicIF type)
void merge(TopicIF topic)
topic
- topicIF; the source topic. This is empty after the
operation and is removed from the topic map.
throws
- ConstraintViolationException if the two topics
have different values for the 'subject' property, since if they
do they cannot represent the same subject. If this exception is
thrown both topics remain untouched.ReifiableIF getReified()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |