Package com.oracle.coherence.ai

Class DocumentChunk.Id

java.lang.Object
com.oracle.coherence.ai.DocumentChunk.Id
All Implemented Interfaces:
ExternalizableLite, PortableObject, Serializable
Enclosing class:
DocumentChunk
public static class DocumentChunk.Id extends Object implements PortableObject, ExternalizableLite
A document chunk identifier.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Id()
    Default constructor for serialization.
    Id(String sDocId, int nIndex)
    Create a document chunk identifier.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    docId()
    Return the document identifier.
    boolean
    equals(Object o)
     
    int
    hashCode()
     
    int
    index()
    Return the document chunk index.
    static DocumentChunk.Id
    parse(String s)
    Parse a string value into a document chunk id.
    void
    readExternal(PofReader in)
    Restore the contents of a user type instance by reading its state using the specified PofReader object.
    void
    readExternal(DataInput in)
    Restore the contents of this object by loading the object's state from the passed DataInput object.
    String
    toString()
     
    void
    writeExternal(PofWriter out)
    Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
    void
    writeExternal(DataOutput out)
    Save the contents of this object by storing the object's state into the passed DataOutput object.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Id

      public Id()
      Default constructor for serialization.

    • Id

      public Id(String sDocId, int nIndex)
      Create a document chunk identifier.
      Parameters:
      sDocId - the document identifier
      nIndex - the chunk index

  • Method Details

    • docId

      public String docId()
      Return the document identifier.
      Returns:
      the document identifier

    • index

      public int index()
      Return the document chunk index.
      Returns:
      the document chunk index

    • readExternal

      public void readExternal(PofReader in) throws IOException
      Description copied from interface: PortableObject
      Restore the contents of a user type instance by reading its state using the specified PofReader object.
      Specified by:
      readExternal in interface PortableObject
      Parameters:
      in - the PofReader from which to read the object's state
      Throws:
      IOException - if an I/O error occurs

    • writeExternal

      public void writeExternal(PofWriter out) throws IOException
      Description copied from interface: PortableObject
      Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
      Specified by:
      writeExternal in interface PortableObject
      Parameters:
      out - the PofWriter to which to write the object's state
      Throws:
      IOException - if an I/O error occurs

    • readExternal

      public void readExternal(DataInput in) throws IOException
      Description copied from interface: ExternalizableLite
      Restore the contents of this object by loading the object's state from the passed DataInput object.
      Specified by:
      readExternal in interface ExternalizableLite
      Parameters:
      in - the DataInput stream to read data from in order to restore the state of this object
      Throws:
      IOException - if an I/O exception occurs

    • writeExternal

      public void writeExternal(DataOutput out) throws IOException
      Description copied from interface: ExternalizableLite
      Save the contents of this object by storing the object's state into the passed DataOutput object.
      Specified by:
      writeExternal in interface ExternalizableLite
      Parameters:
      out - the DataOutput stream to write the state of this object to
      Throws:
      IOException - if an I/O exception occurs

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • parse

      public static DocumentChunk.Id parse(String s)
      Parse a string value into a document chunk id.
      Parameters:
      s - the string value to parse
      Returns:
      a document chunk id
      Throws:
      NullPointerException - if the string is null