Class ReadOnlyTopicName

All Implemented Interfaces:
PersistentIF, NameIF, ReifiableIF, ScopedIF, TMObjectIF, TopicNameIF, TypedIF

public class ReadOnlyTopicName extends ReadOnlyTMObject implements TopicNameIF
INTERNAL: The read-only rdbms topic name implementation.
  • Constructor Details

    • ReadOnlyTopicName

      public ReadOnlyTopicName()
  • Method Details

    • _p_getFieldCount

      public int _p_getFieldCount()
      Specified by:
      _p_getFieldCount in interface PersistentIF
    • getClassIndicator

      public String getClassIndicator()
      Description copied from class: ReadOnlyTMObject
      INTERNAL: Returns the token that can be used to indicate the class of this instance. This indicator is currently only used by item identifiers.
      Specified by:
      getClassIndicator in class ReadOnlyTMObject
    • 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 ReadOnlyTMObject
      Returns:
      string which is this object's id.
    • 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.
    • getValue

      public String getValue()
      Description copied from interface: NameIF
      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.
      Specified by:
      getValue in interface NameIF
      Returns:
      A string which is the value of this topic name.
    • setValue

      public void setValue(String value)
      Description copied from interface: NameIF
      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.
      Specified by:
      setValue in interface NameIF
      Parameters:
      value - A string which is the value of this topic name.
    • getVariants

      public 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.
    • addVariant

      protected void addVariant(VariantNameIF variant)
    • removeVariant

      protected void removeVariant(VariantNameIF variant)
    • 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.
    • 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 String toString()
      Overrides:
      toString in class Object