Class CursorInfo

  • All Implemented Interfaces:
    java.io.Externalizable, java.io.Serializable, Formatable, TypedFormat

    public class CursorInfo
    extends java.lang.Object
    implements Formatable
    A basic holder for information about cursors for execution.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      CursorInfo()
      Niladic constructor for Formatable
      CursorInfo​(int updateMode, ExecCursorTableReference targetTable, java.util.List<java.lang.String> updateColumns)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getTypeFormatId()
      Get the formatID which corresponds to this class.
      void readExternal​(java.io.ObjectInput in)
      Read this object from a stream of stored objects.
      java.lang.String toString()  
      void writeExternal​(java.io.ObjectOutput out)
      Write this object out
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • targetTable

        ExecCursorTableReference targetTable
        This class implements Formatable. That means that it can write itself to and from a formatted stream. If you add more fields to this class, make sure that you also write/read them with the writeExternal()/readExternal() methods. If, inbetween releases, you add more fields to this class, then you should bump the version number emitted by the getTypeFormatId() method.
      • updateColumns

        java.util.List<java.lang.String> updateColumns
      • updateMode

        int updateMode
    • Constructor Detail

      • CursorInfo

        public CursorInfo()
        Niladic constructor for Formatable
      • CursorInfo

        public CursorInfo​(int updateMode,
                          ExecCursorTableReference targetTable,
                          java.util.List<java.lang.String> updateColumns)
    • Method Detail

      • writeExternal

        public void writeExternal​(java.io.ObjectOutput out)
                           throws java.io.IOException
        Write this object out
        Specified by:
        writeExternal in interface java.io.Externalizable
        Parameters:
        out - write bytes here
        Throws:
        java.io.IOException - thrown on error
      • readExternal

        public void readExternal​(java.io.ObjectInput in)
                          throws java.io.IOException,
                                 java.lang.ClassNotFoundException
        Read this object from a stream of stored objects.
        Specified by:
        readExternal in interface java.io.Externalizable
        Parameters:
        in - read this.
        Throws:
        java.io.IOException - thrown on error
        java.lang.ClassNotFoundException - thrown on error
      • getTypeFormatId

        public int getTypeFormatId()
        Get the formatID which corresponds to this class.
        Specified by:
        getTypeFormatId in interface TypedFormat
        Returns:
        the formatID of this class
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object