net.ontopia.topicmaps.impl.basic
Class TopicName

java.lang.Object
  extended by net.ontopia.topicmaps.impl.basic.TMObject
      extended by net.ontopia.topicmaps.impl.basic.TopicName
All Implemented Interfaces:
java.io.Serializable, ReifiableIF, ScopedIF, TMObjectIF, TopicNameIF, TypedIF

public class TopicName
extends TMObject
implements TopicNameIF

INTERNAL: The basic topic name implementation.

See Also:
Serialized Form

Method Summary
 void addTheme(TopicIF theme)
          PUBLIC: Add a topic to this scope.
 TopicIF getReifier()
          PUBLIC: Returns the topic that reifies this object.
 java.util.Collection 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 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.basic.TMObject
addItemIdentifier, getItemIdentifiers, getObjectId, getTopicMap, isReadOnly, removeItemIdentifier
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface net.ontopia.topicmaps.core.TMObjectIF
addItemIdentifier, getItemIdentifiers, getObjectId, getTopicMap, isReadOnly, removeItemIdentifier
 
Methods inherited from interface net.ontopia.topicmaps.core.TMObjectIF
addItemIdentifier, getItemIdentifiers, getObjectId, getTopicMap, isReadOnly, removeItemIdentifier
 
Methods inherited from interface net.ontopia.topicmaps.core.TMObjectIF
addItemIdentifier, getItemIdentifiers, getObjectId, getTopicMap, isReadOnly, removeItemIdentifier
 

Method Detail

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 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 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


Copyright © 2000-2009 Ontopia.