|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents the topic map variant name construct.
A variant name is qualified by zero or more
parameters, each of which is a topic. This
class uses the ScopedObject
interface
to managed the parameters.
A variant name may either reference an external
resource (via the resource property) or
contain inline string data (in the value
property). A Variant with value will return
null
for resource and vice-versa.
Method Summary | |
Topic |
getReifier()
Returns the Topic that reifies this variant name. |
Locator |
getResource()
Returns the resource reference locator associated with this variant. |
java.util.Set |
getScope()
Returns the topics which define the parameters of this Variant. |
TopicName |
getTopicName()
Returns the TopicName to which this variant belongs. |
java.lang.String |
getValue()
Returns the data string associated with this variant. |
void |
remove()
Removes this Variant from the collection of Variants managed by the parent TopicName object. |
void |
setResource(Locator loc)
Sets the resource reference for this variant. |
void |
setValue(java.lang.String value)
Sets the resource data string for this variant. |
Methods inherited from interface org.tmapi.core.ScopedObject |
addScopingTopic, removeScopingTopic |
Methods inherited from interface org.tmapi.core.TopicMapObject |
addSourceLocator, equals, getObjectId, getSourceLocators, getTopicMap, hashCode, removeSourceLocator |
Method Detail |
public TopicName getTopicName()
public java.lang.String getValue()
null
if the variant does not have a value data string.public void setValue(java.lang.String value)
null
.
public Locator getResource()
null
if this variant does not have a resource reference.public void setResource(Locator loc)
null
.
public Topic getReifier()
null
if the variant name is not reified.public void remove() throws TMAPIException
remove
in interface TopicMapObject
TMAPIException
- if the object cannot be removed from the container. Derived
interfaces may define specific circumstances under which a subclass of TMAPIException
must be raised.
Implementations MUST NOT use a TMAPIException to
wrap a failure raised in the underlying engine - such errors must always be wrapped in a
TMAPIRuntimeException.public java.util.Set getScope()
null
.
getScope
in interface ScopedObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |