net.ontopia.topicmaps.impl.rdbms
Class TopicName

java.lang.Object
  net.ontopia.persistence.proxy.AbstractRWPersistent
      net.ontopia.topicmaps.impl.rdbms.TMObject
          net.ontopia.topicmaps.impl.rdbms.TopicName

All Implemented Interfaces:

PersistentIF, ReifiableIF, ScopedIF, TMObjectIF, TopicNameIF, TypedIF

public class TopicName
extends TMObject
implements TopicNameIF

INTERNAL: The rdbms topic name implementation.

Field Summary

static java.lang.String	CLASS_INDICATOR
protected static java.lang.String[]	fields
protected static int	LF_reifier
protected static int	LF_scope
protected static int	LF_topic
protected static int	LF_type
protected static int	LF_value
protected static int	LF_variants

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

id, MASKS, txn, values

Constructor Summary

TopicName()

TopicName(TransactionIF txn)

Method Summary

int	_p_getFieldCount()
void	addTheme(TopicIF theme) PUBLIC: Add a topic to this scope.
void	detach()
java.lang.String	getClassIndicator() INTERNAL: Returns the token that can be used to indicate the class of this instance.
java.lang.String	getObjectId() PUBLIC: Gets the id of this object.
TopicIF	getReifier() PUBLIC: Returns the topic that reifies this object.
java.util.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 topic name belongs.
TopicIF	getType() PUBLIC: Gets the type that this object is an instance of.
java.lang.String	getValue() PUBLIC: Gets the value of this topic name.
java.util.Collection<VariantNameIF>	getVariants() PUBLIC: Gets the variant names of the topic named by this topic name.
void	remove() PUBLIC: Removes the object from its parent.
void	removeTheme(TopicIF theme) PUBLIC: Remove a topic from this scope.
void	setReifier(TopicIF _reifier) PUBLIC: Sets the reifier of this object.
void	setType(TopicIF type) PUBLIC: Sets the type that this object is an instance of.
void	setValue(java.lang.String value) PUBLIC: Sets the value of this topic name.
java.lang.String	toString()

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

addItemIdentifier, fireEvent, getItemIdentifiers, 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, 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

LF_topic

protected static final int LF_topic

See Also:

Constant Field Values

LF_scope

protected static final int LF_scope

See Also:

Constant Field Values

LF_type

protected static final int LF_type

See Also:

Constant Field Values

LF_value

protected static final int LF_value

See Also:

Constant Field Values

LF_variants

protected static final int LF_variants

See Also:

Constant Field Values

LF_reifier

protected static final int LF_reifier

See Also:

Constant Field Values

fields

protected static final java.lang.String[] fields

CLASS_INDICATOR

public static final java.lang.String CLASS_INDICATOR

See Also:

Constant Field Values

Constructor Detail

TopicName

public TopicName()

TopicName

public TopicName(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 java.lang.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 java.lang.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.

getTopic

public TopicIF getTopic()

Description copied from interface: TopicNameIF

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

Specified by:

getTopic in interface TopicNameIF

Returns:

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

getValue

public java.lang.String getValue()

Description copied from interface: TopicNameIF

PUBLIC: Gets 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.

Specified by:

getValue in interface TopicNameIF

Returns:

A string which is the value of this topic name.

setValue

public void setValue(java.lang.String value)

Description copied from interface: TopicNameIF

PUBLIC: Sets the value of this topic name. This corresponds to the content of the 'baseNameString' element in XTM 1.0, as a string.

Specified by:

setValue in interface TopicNameIF

Parameters:

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

getVariants

public java.util.Collection<VariantNameIF> getVariants()

Description copied from interface: TopicNameIF

PUBLIC: Gets the variant names of the topic named by this topic name. These correspond to the 'variant' child elements of the 'baseName' element in XTM 1.0. There is no guarantee as to which order these appear in the collection.

Specified by:

getVariants in interface TopicNameIF

Returns:

A collection of VariantNameIF objects.

remove

public void remove()

Description copied from interface: TMObjectIF

PUBLIC: Removes the object from its parent.

Specified by:

remove in interface TMObjectIF

getScope

public java.util.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.

getType

public TopicIF getType()

Description copied from interface: TypedIF

PUBLIC: Gets the type that this object is an instance of.

Specified by:

getType in interface TypedIF

Returns:

The type of this object; an object implementing TopicIF.

setType

public void setType(TopicIF type)

Description copied from interface: TypedIF

PUBLIC: Sets the type that this object is an instance of.

Specified by:

setType in interface TypedIF

Parameters:

type - The type for this object; an object implementing TopicIF.

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 java.lang.String toString()

Overrides:

toString in class java.lang.Object