net.ontopia.topicmaps.schema.impl.osl
Class ScopeSpecification

java.lang.Object
  net.ontopia.topicmaps.schema.impl.osl.ScopeSpecification

public class ScopeSpecification
extends java.lang.Object

INTERNAL: Represents a specification of a particular class of scopes. Used by many constraint objects to represent their allowed scopes.

Field Summary

protected int	match
static int	MATCH_EXACT INTERNAL: Means that the scope match must be exact.
static int	MATCH_SUBSET INTERNAL: Means that the allowed scope can be a subset of the specified scope.
static int	MATCH_SUPERSET INTERNAL: Means that the allowed scope can be a superset of the specified scope.
protected java.util.Collection	topicMatchers

Constructor Summary

ScopeSpecification()

Method Summary

void	addThemeMatcher(TMObjectMatcherIF matcher) INTERNAL: Add a new allowed theme.
int	getMatch() INTERNAL: Returns a value indicating the match policy used.
java.util.Collection	getThemeMatchers() INTERNAL: Returns the matchers of the allowed themes.
boolean	matches(TMObjectIF object) INTERNAL: Matches the specified scope against that of a topic map object (which must implement ScopedIF).
void	removeThemeMatcher(TMObjectMatcherIF matcher) INTERNAL: Removes a topic matcher from the set of allowed themes.
void	setMatch(int match) INTERNAL: Sets the match policy used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MATCH_EXACT

public static final int MATCH_EXACT

INTERNAL: Means that the scope match must be exact.

See Also:

Constant Field Values

MATCH_SUPERSET

public static final int MATCH_SUPERSET

INTERNAL: Means that the allowed scope can be a superset of the specified scope.

See Also:

Constant Field Values

MATCH_SUBSET

public static final int MATCH_SUBSET

INTERNAL: Means that the allowed scope can be a subset of the specified scope.

See Also:

Constant Field Values

topicMatchers

protected java.util.Collection topicMatchers

match

protected int match

Constructor Detail

ScopeSpecification

public ScopeSpecification()

Method Detail

getMatch

public int getMatch()

INTERNAL: Returns a value indicating the match policy used. The MATCH_* constants contain the allowed values.

setMatch

public void setMatch(int match)

INTERNAL: Sets the match policy used. The MATCH_* constants contain the allowed values.

addThemeMatcher

public void addThemeMatcher(TMObjectMatcherIF matcher)

INTERNAL: Add a new allowed theme.

getThemeMatchers

public java.util.Collection getThemeMatchers()

INTERNAL: Returns the matchers of the allowed themes.

Returns:

A collection of TMObjectMatcherIF objects.

removeThemeMatcher

public void removeThemeMatcher(TMObjectMatcherIF matcher)

INTERNAL: Removes a topic matcher from the set of allowed themes.

matches

public boolean matches(TMObjectIF object)

INTERNAL: Matches the specified scope against that of a topic map object (which must implement ScopedIF).