net.ontopia.topicmaps.impl.rdbms

Class VariantName

java.lang.Object

net.ontopia.persistence.proxy.AbstractRWPersistent

net.ontopia.topicmaps.impl.rdbms.TMObject

net.ontopia.topicmaps.impl.rdbms.VariantName

All Implemented Interfaces:

PersistentIF, NameIF, ReifiableIF, ScopedIF, TMObjectIF, VariantNameIF

public class VariantName
extends TMObject
implements VariantNameIF

INTERNAL: The rdbms variant name implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_INDICATOR
protected static String[]	fields
protected static int	LF_datatype
protected static int	LF_hashcode
protected static int	LF_length
protected static int	LF_name
protected static int	LF_reifier
protected static int	LF_scope
protected static int	LF_value

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

LF_sources, LF_topicmap

Fields inherited from class net.ontopia.persistence.proxy.AbstractRWPersistent

id, MASKS, txn, values

Fields inherited from interface net.ontopia.topicmaps.core.VariantNameIF

EVENT_ADD_THEME, EVENT_ADDED, EVENT_REMOVE_THEME, EVENT_REMOVED, EVENT_SET_DATATYPE, EVENT_SET_VALUE

Fields inherited from interface net.ontopia.topicmaps.core.ReifiableIF

EVENT_SET_REIFIER

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

EVENT_ADD_ITEMIDENTIFIER, EVENT_REMOVE_ITEMIDENTIFIER, MSG_NULL_ARGUMENT

Constructor Summary

Constructors

Constructor and Description
VariantName()
VariantName(TransactionIF txn)

Method Summary

Modifier and Type	Method and Description
protected void	_addTheme(TopicIF theme, boolean validate)
int	_p_getFieldCount()
protected void	_removeTheme(TopicIF theme, boolean validate)
void	addTheme(TopicIF theme) PUBLIC: Add a topic to this scope.
void	detach()
String	getClassIndicator() INTERNAL: Returns the token that can be used to indicate the class of this instance.
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.
String	getObjectId() PUBLIC: Gets the id of this object.
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 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.
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.
protected void	setTopicMap(TopicMap topicmap)
protected void	setTopicName(TopicNameIF name) INTERNAL: Set the name that the variant name belongs to.
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.
void	syncAfterMerge(IdentityIF source, IdentityIF target)
String	toString()

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

addItemIdentifier, fireEvent, getItemIdentifiers, getLongId, getTopicMap, isReadOnly, removeItemIdentifier, transactionChanged

Methods inherited from class net.ontopia.persistence.proxy.AbstractRWPersistent

_p_getIdentity, _p_getTransaction, _p_getType, _p_setIdentity, _p_setTransaction, _p_toString, clearAll, detachCollectionField, detachField, executeQuery, getValue, isDeleted, isDirty, isDirty, isDirtyFlushed, isDirtyFlushed, isInDatabase, isLoaded, isNewObject, isPersistent, isTransient, loadCollectionField, loadField, loadFieldNoCheck, loadValue, nextDirty, nextDirty, nextDirtyFlushed, nextDirtyFlushed, setDeleted, setDirty, setDirtyFlushed, setInDatabase, setNewObject, setPersistent, setValue, syncFieldsAfterMerge, unsetValue, valueAdded, valueChanged, valueRemoved

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, getTopicMap, isReadOnly, removeItemIdentifier

Field Detail

CLASS_INDICATOR

public static final String CLASS_INDICATOR

See Also:

Constant Field Values

LF_name

protected static final int LF_name

See Also:

Constant Field Values

LF_scope

protected static final int LF_scope

See Also:

Constant Field Values

LF_datatype

protected static final int LF_datatype

See Also:

Constant Field Values

LF_length

protected static final int LF_length

See Also:

Constant Field Values

LF_hashcode

protected static final int LF_hashcode

See Also:

Constant Field Values

LF_value

protected static final int LF_value

See Also:

Constant Field Values

LF_reifier

protected static final int LF_reifier

See Also:

Constant Field Values

fields

protected static final String[] fields

Constructor Detail

VariantName

public VariantName()

VariantName

public VariantName(TransactionIF txn)

Method Detail

detach

public void detach()

Specified by:

detach in interface PersistentIF

Specified by:

detach in class AbstractRWPersistent

_p_getFieldCount

public int _p_getFieldCount()

Specified by:

_p_getFieldCount in interface PersistentIF

getClassIndicator

public String getClassIndicator()

Description copied from class: TMObject

INTERNAL: Returns the token that can be used to indicate the class of this instance. This indicator is currently only used by source locators.

Specified by:

getClassIndicator in class TMObject

getObjectId

public String getObjectId()

Description copied from interface: TMObjectIF

PUBLIC: Gets the id of this object. The object id is part of the topic map id space, and must be unique. The object id is not significant (or unique) outside the current topic map. The object id is immutable. The object id is thus stable through this object's lifetime.

Specified by:

getObjectId in interface TMObjectIF

Specified by:

getObjectId in class TMObject

Returns:

string which is this object's id.

remove

public void remove()

Description copied from interface: TMObjectIF

PUBLIC: Removes the object from its parent.

Specified by:

remove in interface TMObjectIF

getTopic

public TopicIF getTopic()

Description copied from interface: NameIF

PUBLIC: Gets the topic to which this name belongs.

Specified by:

getTopic in interface NameIF

Returns:

The topic named by this 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.

setTopicName

protected void setTopicName(TopicNameIF name)

INTERNAL: Set the name that the variant name belongs to. [parent]

setTopicMap

protected void setTopicMap(TopicMap topicmap)

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 NameIF

Specified by:

getValue in interface VariantNameIF

Returns:

A string which is the value of this topic name.

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 NameIF

Specified by:

setValue in interface VariantNameIF

Parameters:

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

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.

_addTheme

protected void _addTheme(TopicIF theme,
                         boolean validate)

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.

_removeTheme

protected void _removeTheme(TopicIF theme,
                            boolean validate)

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

toString

public String toString()

Overrides:

toString in class Object

syncAfterMerge

public void syncAfterMerge(IdentityIF source,
                           IdentityIF target)

Specified by:

syncAfterMerge in class AbstractRWPersistent