net.ontopia.topicmaps.core

Interface NameIF

All Superinterfaces:

TMObjectIF

All Known Subinterfaces:

MTopicName, MTopicNameWithoutTopic, MVariantName, TopicNameIF, VariantNameIF

All Known Implementing Classes:

ReadOnlyTopicName, ReadOnlyVariantName, SnapshotTopicName, SnapshotVariantName, TopicName, TopicName, VariantName, VariantName

public interface NameIF
extends TMObjectIF

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 and Description
TopicIF	getTopic() PUBLIC: Gets the topic to which this name belongs.
String	getValue() PUBLIC: Gets the value of this name.
void	setValue(String name) PUBLIC: Sets the value of this topic name.

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

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

Method Detail

getTopic

TopicIF getTopic()

PUBLIC: Gets the topic to which this name belongs.

Returns:

The topic named by this name; an object implementing TopicIF.

getValue

String getValue()

PUBLIC: Gets the value of this name. This corresponds to the content of the 'baseNameString' element in XTM 1.0, as a string. Where this method is implemented by an object implementing VariantNameIF, the contents of the 'variantName' element are returned instead.

Returns:

A string which is the value of this topic name.

setValue

void setValue(String name)

PUBLIC: Sets the value of this topic name. This corresponds to the content of the 'baseNameString' element in XTM 1.0, as a string. Where this method is implemented by an object implementing VariantNameIF, the contents of the 'variantName' element are returned instead.

Parameters:

name - A string which is the value of this topic name.