org.tmapi.core
Interface Scoped

All Superinterfaces:

Construct

All Known Subinterfaces:

Association, DatatypeAware, Name, Occurrence, Variant

public interface Scoped
extends Construct

Indicates that a statement (Topic Maps construct) has a scope. Associations, Occurrences, Names, and Variants are scoped.

Version:

$Rev: 124 $ - $Date: 2009-10-01 19:21:27 +0200 (Do, 01 Okt 2009) $

Author:

The TMAPI Project

Method Summary

void	addTheme(Topic theme) Adds a topic to the scope.
java.util.Set<Topic>	getScope() Returns the topics which define the scope.
void	removeTheme(Topic theme) Removes a topic from the scope.

Methods inherited from interface org.tmapi.core.Construct

addItemIdentifier, equals, getId, getItemIdentifiers, getParent, getTopicMap, hashCode, remove, removeItemIdentifier

Method Detail

getScope

java.util.Set<Topic> getScope()

Returns the topics which define the scope. An empty set represents the unconstrained scope. The return value may be empty but must never be null.

Returns:

An unmodifiable set of Topics which define the scope.

addTheme

void addTheme(Topic theme)
              throws ModelConstraintException

Adds a topic to the scope.

Parameters:

theme - The topic which should be added to the scope.

Throws:

ModelConstraintException - If the theme is null.

removeTheme

void removeTheme(Topic theme)

Removes a topic from the scope.

Parameters:

theme - The topic which should be removed from the scope.