Package net.ontopia.topicmaps.core

Interface ScopedIF

All Superinterfaces:

TMObjectIF

All Known Subinterfaces:

AssociationIF, MAssociation, MOccurrence, MOccurrenceWithoutTopic, MTopicName, MTopicNameWithoutTopic, MVariantName, OccurrenceIF, TopicNameIF, VariantNameIF

All Known Implementing Classes:

Association, Association, DynamicAssociation, Occurrence, Occurrence, PhantomAssociation, ReadOnlyAssociation, ReadOnlyOccurrence, ReadOnlyTopicName, ReadOnlyVariantName, SnapshotOccurrence, SnapshotTopicName, SnapshotVariantName, TopicName, TopicName, VariantName, VariantName

public interface ScopedIF
extends TMObjectIF

PUBLIC: Implemented by topic map objects that have scope. This interface is implemented by AssociationIF, TopicIF, TopicNameIF, VariantNameIF (through inheritance from TopicNameIF), OccurrenceIF and TopicMapIF.

The scope of an object is used to model its validity, effectivity or relevance in a specific context. A scope is a set of topics, and is present on all objects which may have it. Scoping in topic maps is only significant for topic characteristic assignments, and is inherited from parent objects.

Field Summary

Fields inherited from interface net.ontopia.topicmaps.core.TMObjectIF

EVENT_ADD_ITEMIDENTIFIER, EVENT_REMOVE_ITEMIDENTIFIER, MSG_NULL_ARGUMENT

Method Summary

Modifier and Type	Method	Description
void	addTheme(TopicIF theme)	PUBLIC: Add a topic to this scope.
Collection<TopicIF>	getScope()	PUBLIC: Returns the set of topics that are the stated scope of this object.
void	removeTheme(TopicIF theme)	PUBLIC: Remove a topic from this scope.

Methods inherited from interface net.ontopia.topicmaps.core.TMObjectIF

addItemIdentifier, getItemIdentifiers, getObjectId, getTopicMap, isReadOnly, remove, removeItemIdentifier

Method Details

getScope

Collection<TopicIF> getScope()

PUBLIC: Returns the set of topics that are the stated scope of this object. Scoping topics inherited from parent objects are not included. There is no guarantee as to which order these topics are returned in.

Returns:

A collection of TopicIF objects.

addTheme

void addTheme(TopicIF theme)

PUBLIC: Add a topic to this scope. (A topic used in a scope is also called a theme.) If the topic is already part of the scope the method call has no effect.

Parameters:

theme - A topic to be added to this scope; an object implementing TopicIF.

removeTheme

void removeTheme(TopicIF theme)

PUBLIC: Remove a topic from this scope. If the topic is not already in the scope this method has no effect. (A topic used in a scope is also called a theme.)

Parameters:

theme - A topic to be removed from this scope; an object implementing TopicIF.