Interface Result

  • All Superinterfaces:
    Closeable
    All Known Implementing Classes:
    AbstractResult, MergedResult, ResultSetResult, SelectImpl.SelectResult

    public interface Result
    extends Closeable
    A result from the execution of a query or stored procedure. This interface is aligned closely with the ResultSet, so you can expect like-named methods to have similar semantics. However, the interface has been distilled and simplified, so a result object could easily mask information sources other than a result set. For more flexible customization of data loading, see the PCResultObjectProvider.
    Author:
    Abe White
    See Also:
    ResultSetResult
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean absolute​(int row)
      Move to the given 0-based row in the result, or return false if the row does not exist.
      void close()
      Free the resources used by this result; do not close the SQL connection.
      boolean contains​(java.lang.Object obj)
      Return true if the given id or column is available in the result.
      boolean contains​(Column col, Joins joins)
      Return true if the given column is available in the result.
      boolean containsAll​(java.lang.Object[] objs)
      Return true if all the given ids or columns are available in the result.
      boolean containsAll​(Column[] cols, Joins joins)
      Return true if all the given columns are available in the result.
      void endDataRequest()
      Ends a data request.
      java.sql.Array getArray​(java.lang.Object obj)
      Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
      java.sql.Array getArray​(Column col, Joins joins)
      Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
      java.io.InputStream getAsciiStream​(java.lang.Object obj)
      Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
      java.io.InputStream getAsciiStream​(Column col, Joins joins)
      Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
      ClassMapping getBaseMapping()
      If this is the result of a UNION used to select a hierarchy of mappings, the base mapping represented by the current row.
      java.math.BigDecimal getBigDecimal​(java.lang.Object obj)
      Return the value stored in the given column or id.
      java.math.BigDecimal getBigDecimal​(Column col, Joins joins)
      Return the value stored in the given column.
      java.math.BigInteger getBigInteger​(java.lang.Object obj)
      Return the value stored in the given column or id.
      java.math.BigInteger getBigInteger​(Column col, Joins joins)
      Return the value stored in the given column.
      java.io.InputStream getBinaryStream​(java.lang.Object obj)
      Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
      java.io.InputStream getBinaryStream​(Column col, Joins joins)
      Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
      java.sql.Blob getBlob​(java.lang.Object obj)
      Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
      java.sql.Blob getBlob​(Column col, Joins joins)
      Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
      boolean getBoolean​(java.lang.Object obj)
      Return the value stored in the given column or id.
      boolean getBoolean​(Column col, Joins joins)
      Return the value stored in the given column.
      byte getByte​(java.lang.Object obj)
      Return the value stored in the given column or id.
      byte getByte​(Column col, Joins joins)
      Return the value stored in the given column.
      byte[] getBytes​(java.lang.Object obj)
      Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
      byte[] getBytes​(Column col, Joins joins)
      Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
      java.util.Calendar getCalendar​(java.lang.Object obj)
      Return the value stored in the given column or id.
      java.util.Calendar getCalendar​(Column col, Joins joins)
      Return the value stored in the given column.
      char getChar​(java.lang.Object obj)
      Return the value stored in the given column or id.
      char getChar​(Column col, Joins joins)
      Return the value stored in the given column.
      java.io.Reader getCharacterStream​(java.lang.Object obj)
      Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
      java.io.Reader getCharacterStream​(Column col, Joins joins)
      Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
      java.sql.Clob getClob​(java.lang.Object obj)
      Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
      java.sql.Clob getClob​(Column col, Joins joins)
      Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
      java.util.Date getDate​(java.lang.Object obj)
      Return the value stored in the given column or id.
      java.sql.Date getDate​(java.lang.Object obj, java.util.Calendar cal)
      Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
      java.sql.Date getDate​(Column col, java.util.Calendar cal, Joins joins)
      Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
      java.util.Date getDate​(Column col, Joins joins)
      Return the value stored in the given column.
      double getDouble​(java.lang.Object obj)
      Return the value stored in the given column or id.
      double getDouble​(Column col, Joins joins)
      Return the value stored in the given column.
      java.lang.Object getEager​(FieldMapping key)
      The eager result for the given key, or null if none.
      float getFloat​(java.lang.Object obj)
      Return the value stored in the given column or id.
      float getFloat​(Column col, Joins joins)
      Return the value stored in the given column.
      int getInt​(java.lang.Object obj)
      Return the value stored in the given column or id.
      int getInt​(Column col, Joins joins)
      Return the value stored in the given column.
      java.io.InputStream getLOBStream​(JDBCStore store, java.lang.Object obj)  
      java.time.LocalDate getLocalDate​(java.lang.Object obj)
      Return the value stored in the given column or id.
      java.time.LocalDateTime getLocalDateTime​(java.lang.Object obj)
      Return the value stored in the given column or id.
      java.util.Locale getLocale​(java.lang.Object obj)
      Return the value stored in the given column or id.
      java.util.Locale getLocale​(Column col, Joins joins)
      Return the value stored in the given column.
      java.time.LocalTime getLocalTime​(java.lang.Object obj)
      Return the value stored in the given column or id.
      long getLong​(java.lang.Object obj)
      Return the value stored in the given column or id.
      long getLong​(Column col, Joins joins)
      Return the value stored in the given column.
      FieldMapping getMappedByFieldMapping()
      If this is the result used to select a toMany relationship, the mappedByFieldMapping is field mapping representing the inverse relationship.
      java.lang.Object getMappedByValue()
      If this is the result used to select a toMany relationship, the mappedByValue is value of the owner of the toMany relationship.
      java.lang.Number getNumber​(java.lang.Object obj)
      Return the value stored in the given column or id.
      java.lang.Number getNumber​(Column col, Joins joins)
      Return the value stored in the given column.
      java.lang.Object getObject​(java.lang.Object obj, int metaType, java.lang.Object arg)
      Return the value stored in the given column or id.
      java.lang.Object getObject​(Column col, java.lang.Object arg, Joins joins)
      Return the value stored in the given column.
      java.time.OffsetDateTime getOffsetDateTime​(java.lang.Object obj)
      Return the value stored in the given column or id.
      java.time.OffsetTime getOffsetTime​(java.lang.Object obj)
      Return the value stored in the given column or id.
      java.sql.Ref getRef​(java.lang.Object obj, java.util.Map map)
      Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
      java.sql.Ref getRef​(Column col, java.util.Map map, Joins joins)
      Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
      short getShort​(java.lang.Object obj)
      Return the value stored in the given column or id.
      short getShort​(Column col, Joins joins)
      Return the value stored in the given column.
      java.lang.Object getSQLObject​(java.lang.Object obj, java.util.Map map)
      Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
      java.lang.Object getSQLObject​(Column col, java.util.Map map, Joins joins)
      Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
      java.lang.String getString​(java.lang.Object obj)
      Return the value stored in the given column or id.
      java.lang.String getString​(Column col, Joins joins)
      Return the value stored in the given column.
      java.sql.Time getTime​(java.lang.Object obj, java.util.Calendar cal)
      Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
      java.sql.Time getTime​(Column col, java.util.Calendar cal, Joins joins)
      Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
      java.sql.Timestamp getTimestamp​(java.lang.Object obj, java.util.Calendar cal)
      Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
      java.sql.Timestamp getTimestamp​(Column col, java.util.Calendar cal, Joins joins)
      Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
      int indexOf()
      The index of the select within the UNION that the current row corresponds to, or 0.
      boolean isLocking()
      If true, then any results loaded from this Result will be locked in the database.
      java.lang.Object load​(ClassMapping mapping, JDBCStore store, JDBCFetchConfiguration fetch)
      Load a pc object using the given store manager.
      java.lang.Object load​(ClassMapping mapping, JDBCStore store, JDBCFetchConfiguration fetch, Joins joins)
      Load a pc object using the given store manager.
      Joins newJoins()
      Return a new joins instance to use for traversing to related data.
      boolean next()
      Advance to the next row, or return false if there are no more rows in the result.
      void pushBack()
      Push back the last result.
      void putEager​(FieldMapping key, java.lang.Object res)
      The eager result for the given key, or null if none.
      void setBaseMapping​(ClassMapping mapping)
      If this is the result of a UNION used to select a hierarchy of mappings, the base mapping represented by the current row.
      void setLocking​(boolean locking)
      Set to true if row locking has been issued for the row.
      void setMappedByFieldMapping​(FieldMapping fieldMapping)
      If this is the result used to select a toMany relationship, the mappedByFieldMapping is field mapping representing the inverse relationship.
      void setMappedByValue​(java.lang.Object mappedByValue)
      If this is the result used to select a toMany relationship, the mappedByValue is value of the owner of the toMany relationship.
      int size()
      Return the number of rows in this result.
      void startDataRequest​(java.lang.Object mapping)
      Informs this receiver about the application element for which a subsequent data request will be made.
      boolean supportsRandomAccess()
      Return true if the result supports random access.
      boolean wasNull()
      Return true if the last value fetched was null.
    • Method Detail

      • getEager

        java.lang.Object getEager​(FieldMapping key)
        The eager result for the given key, or null if none.
      • putEager

        void putEager​(FieldMapping key,
                      java.lang.Object res)
        The eager result for the given key, or null if none.
      • newJoins

        Joins newJoins()
        Return a new joins instance to use for traversing to related data.
      • close

        void close()
        Free the resources used by this result; do not close the SQL connection.
        Specified by:
        close in interface Closeable
      • setLocking

        void setLocking​(boolean locking)
        Set to true if row locking has been issued for the row.
      • isLocking

        boolean isLocking()
        If true, then any results loaded from this Result will be locked in the database.
      • supportsRandomAccess

        boolean supportsRandomAccess()
                              throws java.sql.SQLException
        Return true if the result supports random access.
        Throws:
        java.sql.SQLException
      • absolute

        boolean absolute​(int row)
                  throws java.sql.SQLException
        Move to the given 0-based row in the result, or return false if the row does not exist. This method will only be called if the result supports random access.
        Throws:
        java.sql.SQLException
      • next

        boolean next()
              throws java.sql.SQLException
        Advance to the next row, or return false if there are no more rows in the result.
        Throws:
        java.sql.SQLException
      • pushBack

        void pushBack()
               throws java.sql.SQLException
        Push back the last result. In other words, just ignore the next call to next(). After the first time this method is called, additional calls before a call to next() or absolute(int) should have no further affect.
        Throws:
        java.sql.SQLException
      • size

        int size()
          throws java.sql.SQLException
        Return the number of rows in this result.
        Throws:
        java.sql.SQLException
      • contains

        boolean contains​(java.lang.Object obj)
                  throws java.sql.SQLException
        Return true if the given id or column is available in the result.
        Throws:
        java.sql.SQLException
      • containsAll

        boolean containsAll​(java.lang.Object[] objs)
                     throws java.sql.SQLException
        Return true if all the given ids or columns are available in the result.
        Throws:
        java.sql.SQLException
      • contains

        boolean contains​(Column col,
                         Joins joins)
                  throws java.sql.SQLException
        Return true if the given column is available in the result.
        Throws:
        java.sql.SQLException
      • containsAll

        boolean containsAll​(Column[] cols,
                            Joins joins)
                     throws java.sql.SQLException
        Return true if all the given columns are available in the result.
        Throws:
        java.sql.SQLException
      • getBaseMapping

        ClassMapping getBaseMapping()
        If this is the result of a UNION used to select a hierarchy of mappings, the base mapping represented by the current row. This information is not available after getting any eager results from the row.
      • setBaseMapping

        void setBaseMapping​(ClassMapping mapping)
        If this is the result of a UNION used to select a hierarchy of mappings, the base mapping represented by the current row. This information is not available after getting any eager results from the row.
      • getMappedByFieldMapping

        FieldMapping getMappedByFieldMapping()
        If this is the result used to select a toMany relationship, the mappedByFieldMapping is field mapping representing the inverse relationship. This is to avoid unneeded extra sql to retrieve the eager inverse field.
      • setMappedByFieldMapping

        void setMappedByFieldMapping​(FieldMapping fieldMapping)
        If this is the result used to select a toMany relationship, the mappedByFieldMapping is field mapping representing the inverse relationship. This is to avoid unneeded extra sql to retrieve the eager inverse field.
      • getMappedByValue

        java.lang.Object getMappedByValue()
        If this is the result used to select a toMany relationship, the mappedByValue is value of the owner of the toMany relationship. This is to avoid unneeded extra sql to retrieve the eager inverse field.
      • setMappedByValue

        void setMappedByValue​(java.lang.Object mappedByValue)
        If this is the result used to select a toMany relationship, the mappedByValue is value of the owner of the toMany relationship. This is to avoid unneeded extra sql to retrieve the eager inverse field.
      • indexOf

        int indexOf()
        The index of the select within the UNION that the current row corresponds to, or 0.
      • getArray

        java.sql.Array getArray​(java.lang.Object obj)
                         throws java.sql.SQLException
        Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getAsciiStream

        java.io.InputStream getAsciiStream​(java.lang.Object obj)
                                    throws java.sql.SQLException
        Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getBigDecimal

        java.math.BigDecimal getBigDecimal​(java.lang.Object obj)
                                    throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getBigInteger

        java.math.BigInteger getBigInteger​(java.lang.Object obj)
                                    throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getBinaryStream

        java.io.InputStream getBinaryStream​(java.lang.Object obj)
                                     throws java.sql.SQLException
        Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getLOBStream

        java.io.InputStream getLOBStream​(JDBCStore store,
                                         java.lang.Object obj)
                                  throws java.sql.SQLException
        Throws:
        java.sql.SQLException
      • getBlob

        java.sql.Blob getBlob​(java.lang.Object obj)
                       throws java.sql.SQLException
        Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getBoolean

        boolean getBoolean​(java.lang.Object obj)
                    throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getByte

        byte getByte​(java.lang.Object obj)
              throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getBytes

        byte[] getBytes​(java.lang.Object obj)
                 throws java.sql.SQLException
        Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getCalendar

        java.util.Calendar getCalendar​(java.lang.Object obj)
                                throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getLocalDate

        java.time.LocalDate getLocalDate​(java.lang.Object obj)
                                  throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getLocalTime

        java.time.LocalTime getLocalTime​(java.lang.Object obj)
                                  throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getLocalDateTime

        java.time.LocalDateTime getLocalDateTime​(java.lang.Object obj)
                                          throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getOffsetTime

        java.time.OffsetTime getOffsetTime​(java.lang.Object obj)
                                    throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getOffsetDateTime

        java.time.OffsetDateTime getOffsetDateTime​(java.lang.Object obj)
                                            throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getChar

        char getChar​(java.lang.Object obj)
              throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getCharacterStream

        java.io.Reader getCharacterStream​(java.lang.Object obj)
                                   throws java.sql.SQLException
        Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getClob

        java.sql.Clob getClob​(java.lang.Object obj)
                       throws java.sql.SQLException
        Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getDate

        java.util.Date getDate​(java.lang.Object obj)
                        throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getDate

        java.sql.Date getDate​(java.lang.Object obj,
                              java.util.Calendar cal)
                       throws java.sql.SQLException
        Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getDouble

        double getDouble​(java.lang.Object obj)
                  throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getFloat

        float getFloat​(java.lang.Object obj)
                throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getInt

        int getInt​(java.lang.Object obj)
            throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getLocale

        java.util.Locale getLocale​(java.lang.Object obj)
                            throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getLong

        long getLong​(java.lang.Object obj)
              throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getNumber

        java.lang.Number getNumber​(java.lang.Object obj)
                            throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getObject

        java.lang.Object getObject​(java.lang.Object obj,
                                   int metaType,
                                   java.lang.Object arg)
                            throws java.sql.SQLException
        Return the value stored in the given column or id.
        Parameters:
        obj - the column or id whose data to fetch
        metaType - the type code from JavaTypes or JavaSQLTypes for the type of the data; if obj is a column, you may specify -1 to use the column's recorded java type
        arg - some JDBC data access methods use an argument, such as a Calendar or Map
        Throws:
        java.sql.SQLException
      • getSQLObject

        java.lang.Object getSQLObject​(java.lang.Object obj,
                                      java.util.Map map)
                               throws java.sql.SQLException
        Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getRef

        java.sql.Ref getRef​(java.lang.Object obj,
                            java.util.Map map)
                     throws java.sql.SQLException
        Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getShort

        short getShort​(java.lang.Object obj)
                throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getString

        java.lang.String getString​(java.lang.Object obj)
                            throws java.sql.SQLException
        Return the value stored in the given column or id.
        Throws:
        java.sql.SQLException
      • getTime

        java.sql.Time getTime​(java.lang.Object obj,
                              java.util.Calendar cal)
                       throws java.sql.SQLException
        Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getTimestamp

        java.sql.Timestamp getTimestamp​(java.lang.Object obj,
                                        java.util.Calendar cal)
                                 throws java.sql.SQLException
        Return the value stored in the given column or id; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getArray

        java.sql.Array getArray​(Column col,
                                Joins joins)
                         throws java.sql.SQLException
        Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getAsciiStream

        java.io.InputStream getAsciiStream​(Column col,
                                           Joins joins)
                                    throws java.sql.SQLException
        Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getBigDecimal

        java.math.BigDecimal getBigDecimal​(Column col,
                                           Joins joins)
                                    throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getBigInteger

        java.math.BigInteger getBigInteger​(Column col,
                                           Joins joins)
                                    throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getBinaryStream

        java.io.InputStream getBinaryStream​(Column col,
                                            Joins joins)
                                     throws java.sql.SQLException
        Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getBlob

        java.sql.Blob getBlob​(Column col,
                              Joins joins)
                       throws java.sql.SQLException
        Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getBoolean

        boolean getBoolean​(Column col,
                           Joins joins)
                    throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getByte

        byte getByte​(Column col,
                     Joins joins)
              throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getBytes

        byte[] getBytes​(Column col,
                        Joins joins)
                 throws java.sql.SQLException
        Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getCalendar

        java.util.Calendar getCalendar​(Column col,
                                       Joins joins)
                                throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getChar

        char getChar​(Column col,
                     Joins joins)
              throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getCharacterStream

        java.io.Reader getCharacterStream​(Column col,
                                          Joins joins)
                                   throws java.sql.SQLException
        Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getClob

        java.sql.Clob getClob​(Column col,
                              Joins joins)
                       throws java.sql.SQLException
        Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getDate

        java.util.Date getDate​(Column col,
                               Joins joins)
                        throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getDate

        java.sql.Date getDate​(Column col,
                              java.util.Calendar cal,
                              Joins joins)
                       throws java.sql.SQLException
        Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getDouble

        double getDouble​(Column col,
                         Joins joins)
                  throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getFloat

        float getFloat​(Column col,
                       Joins joins)
                throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getInt

        int getInt​(Column col,
                   Joins joins)
            throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getLocale

        java.util.Locale getLocale​(Column col,
                                   Joins joins)
                            throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getLong

        long getLong​(Column col,
                     Joins joins)
              throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getNumber

        java.lang.Number getNumber​(Column col,
                                   Joins joins)
                            throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getObject

        java.lang.Object getObject​(Column col,
                                   java.lang.Object arg,
                                   Joins joins)
                            throws java.sql.SQLException
        Return the value stored in the given column.
        Parameters:
        col - the column whose data to fetch
        arg - some JDBC data access methods use an argument, such as a Calendar or Map
        Throws:
        java.sql.SQLException
      • getSQLObject

        java.lang.Object getSQLObject​(Column col,
                                      java.util.Map map,
                                      Joins joins)
                               throws java.sql.SQLException
        Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getRef

        java.sql.Ref getRef​(Column col,
                            java.util.Map map,
                            Joins joins)
                     throws java.sql.SQLException
        Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getShort

        short getShort​(Column col,
                       Joins joins)
                throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getString

        java.lang.String getString​(Column col,
                                   Joins joins)
                            throws java.sql.SQLException
        Return the value stored in the given column.
        Throws:
        java.sql.SQLException
      • getTime

        java.sql.Time getTime​(Column col,
                              java.util.Calendar cal,
                              Joins joins)
                       throws java.sql.SQLException
        Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • getTimestamp

        java.sql.Timestamp getTimestamp​(Column col,
                                        java.util.Calendar cal,
                                        Joins joins)
                                 throws java.sql.SQLException
        Return the value stored in the given column; may not be supported by results that are not backed by a SQL result set.
        Throws:
        java.sql.SQLException
      • wasNull

        boolean wasNull()
                 throws java.sql.SQLException
        Return true if the last value fetched was null.
        Throws:
        java.sql.SQLException
      • startDataRequest

        void startDataRequest​(java.lang.Object mapping)
        Informs this receiver about the application element for which a subsequent data request will be made.
      • endDataRequest

        void endDataRequest()
        Ends a data request. Must be called in conjunction with startDataRequest(java.lang.Object). The calls can be nested as follws
         startDataRequest (relation); startDataRequest (relationsField);
         getObject("COLUMN_Y"); endDataRequest (); endDataRequest ();