Class ReadOnlyOccurrence

All Implemented Interfaces:
PersistentIF, OccurrenceIF, ReifiableIF, ScopedIF, TMObjectIF, TypedIF

public class ReadOnlyOccurrence extends ReadOnlyTMObject implements OccurrenceIF
INTERNAL: The read-only rdbms occurrence implementation.
  • Constructor Details

    • ReadOnlyOccurrence

      public ReadOnlyOccurrence()
  • 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: OccurrenceIF
      PUBLIC: Gets the topic for this occurrence.
      Specified by:
      getTopic in interface OccurrenceIF
      Returns:
      The topic to which this occurrence belongs; an object implementing TopicIF.
    • getDataType

      public LocatorIF getDataType()
      Description copied from interface: OccurrenceIF
      PUBLIC: Gets the data type of this occurrence.
      Specified by:
      getDataType in interface OccurrenceIF
    • setDataType

      public void setDataType(LocatorIF datatype)
    • getValue

      public String getValue()
      Description copied from interface: OccurrenceIF
      PUBLIC: Gets the string representation of this occurrence. This method will return null if the length of the value exceeds the supported maximum size.
      Specified by:
      getValue in interface OccurrenceIF
    • setValue

      public void setValue(String value, LocatorIF datatype)
      Description copied from interface: OccurrenceIF
      PUBLIC: Sets the value and the data type of this occurrence using a string. The value must conform to the correct string representation according to the datatype.
      Specified by:
      setValue in interface OccurrenceIF
    • getReader

      public Reader getReader()
      Description copied from interface: OccurrenceIF
      PUBLIC: Returns a Reader that allows you to stream the string representation of this occurrence. Values of all sizes are supported by this method.
      Specified by:
      getReader in interface OccurrenceIF
    • setReader

      public void setReader(Reader value, long length, LocatorIF datatype)
      Description copied from interface: OccurrenceIF
      PUBLIC: Sets the value and the data type of this occurrence using a reader. The reader value must conform to the correct string representation according to the datatype.
      Specified by:
      setReader in interface OccurrenceIF
    • setLocator

      public void setLocator(LocatorIF locator)
      Description copied from interface: OccurrenceIF
      PUBLIC: Same as setValue(locator.getAddress(), DataTypes.TYPE_URI). This method is here primarily for backwards compatibility.
      Specified by:
      setLocator in interface OccurrenceIF
    • getLength

      public long getLength()
      Description copied from interface: OccurrenceIF
      PUBLIC: Returns the length of the occurrence value. The number of characters in the string representation is returned.
      Specified by:
      getLength in interface OccurrenceIF
    • 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