|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An index of all ScopedObject (Association, TopicName, Occurrence and Variant) instances in the indexed TopicMap. This index provides methods to retrieve all of the ScopedObject instances in the TopicMap with a particular Topic or set of Topics in their scope, and to retrieve all of the Topics used in the scope of one or more ScopedObjects in the TopicMap.
Method Summary | |
java.util.Collection |
getScopedObjectsByScopingTopic(Topic scopingTopic)
Returns all ScopedObject instances where the specified Topic is one of the themes in the scope of the ScopedObject. |
java.util.Collection |
getScopedObjectsByScopingTopics(Topic[] scopingTopics,
boolean matchAll)
Returns all ScopedObject instances where some or all of the specified Topics are in the scope of the ScopedObject. |
java.util.Collection |
getScopingTopics()
Returns all Topic instances which are present in the scope of one or more ScopedObject instances in the indexed TopicMap. |
Methods inherited from interface org.tmapi.index.Index |
close, getFlags, isOpen, open, reindex |
Methods inherited from interface org.tmapi.core.TopicMapSystem.ConfigurableHelperObject |
configure |
Method Detail |
public java.util.Collection getScopingTopics()
null
.
public java.util.Collection getScopedObjectsByScopingTopic(Topic scopingTopic)
null
.
scopingTopic
- the Topic that must be in the scope of each
returned ScopedObject.
If scopingTopic is null
a collection containing
all ScopedObjects that have no scope will be returned.
public java.util.Collection getScopedObjectsByScopingTopics(Topic[] scopingTopics, boolean matchAll)
null
.
scopingTopics
- the Topics which must be in the scope of
each returned ScopedObject instance
(MUST NOT be null
).matchAll
- if true
, then only those ScopedObjects
where all of the Topics in scopingTopics
are present in the scope will be returned, otherwise
all ScopedObjects where one or more of the Topics
specified in scopingTopics
are present in
the scope will be returned.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |