net.ontopia.topicmaps.impl.basic
Class VariantName

java.lang.Object
  net.ontopia.topicmaps.impl.basic.TMObject
      net.ontopia.topicmaps.impl.basic.VariantName

All Implemented Interfaces:

Serializable, ReifiableIF, ScopedIF, TMObjectIF, VariantNameIF

public class VariantName
extends TMObject
implements VariantNameIF

INTERNAL: The basic variant name implementation.

See Also:

Serialized Form

Field Summary

protected LocatorIF	datatype
protected TopicIF	reifier
protected UniqueSet<TopicIF>	scope
protected String	value

Fields inherited from class net.ontopia.topicmaps.impl.basic.TMObject

MSG_NULL_ARGUMENT, sources

Method Summary

void	addTheme(TopicIF theme) PUBLIC: Add a topic to this scope.
protected void	fireEvent(String event, Object new_value, Object old_value) INTERNAL: Fires an event, so that listeners can be informed about the event.
LocatorIF	getDataType() PUBLIC: Gets the data type of this variant.
long	getLength() PUBLIC: Returns the length of the variant value.
LocatorIF	getLocator() PUBLIC: Returns a LocatorIF representation of the variant value.
Reader	getReader() PUBLIC: Returns a Reader that allows you to stream the string representation of this variant.
TopicIF	getReifier() PUBLIC: Returns the topic that reifies this object.
Collection<TopicIF>	getScope() PUBLIC: Returns the set of topics that are the stated scope of this object.
TopicIF	getTopic() PUBLIC: Gets the topic to which this variant name belongs.
TopicNameIF	getTopicName() PUBLIC: Gets the topic name to which this variant name belongs.
String	getValue() PUBLIC: Gets the string representation of this variant.
protected boolean	isConnected()
void	remove() PUBLIC: Removes the object from its parent.
void	removeTheme(TopicIF theme) PUBLIC: Remove a topic from this scope.
protected void	setDataType(LocatorIF datatype)
void	setLocator(LocatorIF locator) PUBLIC: Same as setValue(locator.getAddress(), DataTypes.TYPE_URI).
void	setReader(Reader value, long length, LocatorIF datatype) PUBLIC: Sets the value and the data type of this variant using a reader.
void	setReifier(TopicIF _reifier) PUBLIC: Sets the reifier of this object.
void	setValue(String value) PUBLIC: Same as setValue(value, DataTypes.TYPE_STRING).
void	setValue(String value, LocatorIF datatype) PUBLIC: Sets the value and the data type of this variant using a string.
String	toString()

Methods inherited from class net.ontopia.topicmaps.impl.basic.TMObject

addItemIdentifier, getItemIdentifiers, getObjectId, getTopicMap, isReadOnly, removeItemIdentifier

Methods inherited from class java.lang.Object

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

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

addItemIdentifier, getItemIdentifiers, getObjectId, getTopicMap, isReadOnly, removeItemIdentifier

Field Detail

reifier

protected TopicIF reifier

value

protected String value

scope

protected UniqueSet<TopicIF> scope

datatype

protected LocatorIF datatype

Method Detail

getTopic

public TopicIF getTopic()

Description copied from interface: VariantNameIF

PUBLIC: Gets the topic to which this variant name belongs.

Specified by:

getTopic in interface VariantNameIF

Returns:

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

getTopicName

public TopicNameIF getTopicName()

Description copied from interface: VariantNameIF

PUBLIC: Gets the topic name to which this variant name belongs. The topic name may be a direct parent or an ancestor.

Specified by:

getTopicName in interface VariantNameIF

Returns:

The topic name of which this is a variant; an object implementing TopicNameIF.

getDataType

public LocatorIF getDataType()

Description copied from interface: VariantNameIF

PUBLIC: Gets the data type of this variant.

Specified by:

getDataType in interface VariantNameIF

setDataType

protected void setDataType(LocatorIF datatype)

getValue

public String getValue()

Description copied from interface: VariantNameIF

PUBLIC: Gets the string representation of this variant. This method will return null if the length of the value exceeds the supported maximum size.

Specified by:

getValue in interface VariantNameIF

setValue

public void setValue(String value)

Description copied from interface: VariantNameIF

PUBLIC: Same as setValue(value, DataTypes.TYPE_STRING). This method is here primarily for backwards compatibility.

Specified by:

setValue in interface VariantNameIF

setValue

public void setValue(String value,
                     LocatorIF datatype)

Description copied from interface: VariantNameIF

PUBLIC: Sets the value and the data type of this variant using a string. The value must conform to the correct string representation according to the datatype.

Specified by:

setValue in interface VariantNameIF

getReader

public Reader getReader()

Description copied from interface: VariantNameIF

PUBLIC: Returns a Reader that allows you to stream the string representation of this variant. Values of all sizes are supported by this method.

Specified by:

getReader in interface VariantNameIF

setReader

public void setReader(Reader value,
                      long length,
                      LocatorIF datatype)

Description copied from interface: VariantNameIF

PUBLIC: Sets the value and the data type of this variant using a reader. The reader value must conform to the correct string representation according to the datatype.

Specified by:

setReader in interface VariantNameIF

getLocator

public LocatorIF getLocator()

Description copied from interface: VariantNameIF

PUBLIC: Returns a LocatorIF representation of the variant value. This method will return null if the value is not of type xsd:anyURI (same as DataType.TYPE_URI). This method is here primarily for backwards compatibility.

Specified by:

getLocator in interface VariantNameIF

setLocator

public void setLocator(LocatorIF locator)

Description copied from interface: VariantNameIF

PUBLIC: Same as setValue(locator.getAddress(), DataTypes.TYPE_URI). This method is here primarily for backwards compatibility.

Specified by:

setLocator in interface VariantNameIF

getLength

public long getLength()

Description copied from interface: VariantNameIF

PUBLIC: Returns the length of the variant value. The number of characters in the string representation is returned.

Specified by:

getLength in interface VariantNameIF

getScope

public Collection<TopicIF> getScope()

Description copied from interface: ScopedIF

PUBLIC: Returns the set of topics that are the stated scope of this object. Scoping topics inherited from parent objects are not included. There is no guarantee as to which order these topics are returned in.

Specified by:

getScope in interface ScopedIF

Returns:

A collection of TopicIF objects.

addTheme

public void addTheme(TopicIF theme)

Description copied from interface: ScopedIF

PUBLIC: Add a topic to this scope. (A topic used in a scope is also called a theme.) If the topic is already part of the scope the method call has no effect.

Specified by:

addTheme in interface ScopedIF

Parameters:

theme - A topic to be added to this scope; an object implementing TopicIF.

removeTheme

public void removeTheme(TopicIF theme)

Description copied from interface: ScopedIF

PUBLIC: Remove a topic from this scope. If the topic is not already in the scope this method has no effect. (A topic used in a scope is also called a theme.)

Specified by:

removeTheme in interface ScopedIF

Parameters:

theme - A topic to be removed from this scope; an object implementing TopicIF.

remove

public void remove()

Description copied from interface: TMObjectIF

PUBLIC: Removes the object from its parent.

Specified by:

remove in interface TMObjectIF

getReifier

public TopicIF getReifier()

Description copied from interface: ReifiableIF

PUBLIC: Returns the topic that reifies this object.

Specified by:

getReifier in interface ReifiableIF

setReifier

public void setReifier(TopicIF _reifier)

Description copied from interface: ReifiableIF

PUBLIC: Sets the reifier of this object.

Specified by:

setReifier in interface ReifiableIF

fireEvent

protected void fireEvent(String event,
                         Object new_value,
                         Object old_value)

Description copied from class: TMObject

INTERNAL: Fires an event, so that listeners can be informed about the event. This method is typically called when the object id modified.

Overrides:

fireEvent in class TMObject

isConnected

protected boolean isConnected()

Overrides:

isConnected in class TMObject

toString

public String toString()

Overrides:

toString in class Object