Package org.apache.openjpa.jdbc.sql

Class AbstractResult

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractResult()  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete 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.
      protected boolean absoluteInternal​(int row)
      Throws an exception by default.
      protected java.lang.Object checkNull​(java.lang.Object val)  
      void close()
      Closes all eager results.
      protected void closeEagerMap​(java.util.Map eager)
      Close all results in eager map.
      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.
      protected boolean containsAllInternal​(java.lang.Object[] objs, Joins joins)
      Return whether this result contains data for all the given ids or columns.
      protected abstract boolean containsInternal​(java.lang.Object obj, Joins joins)
      Return whether this result contains data for the given id or column.
      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.
      protected java.sql.Array getArrayInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected java.io.InputStream getAsciiStreamInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected java.math.BigDecimal getBigDecimalInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected java.math.BigInteger getBigIntegerInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected java.io.InputStream getBinaryStreamInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected java.sql.Blob getBlobInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected boolean getBooleanInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected byte getByteInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected byte[] getBytesInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected java.util.Calendar getCalendarInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected java.io.Reader getCharacterStreamInternal​(java.lang.Object obj, Joins joins)  
      protected char getCharInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected java.sql.Clob getClobInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected java.sql.Date getDateInternal​(java.lang.Object obj, java.util.Calendar cal, Joins joins)  
      protected java.util.Date getDateInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected double getDoubleInternal​(java.lang.Object obj, Joins joins)  
      java.lang.Object getEager​(FieldMapping key)
      The eager result for the given key, or null if none.
      protected java.util.Map getEagerMap​(boolean client)
      Raw eager information.
      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.
      protected float getFloatInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected int getIntInternal​(java.lang.Object obj, Joins joins)  
      java.io.InputStream getLOBStream​(JDBCStore store, java.lang.Object obj)  
      protected java.io.InputStream getLOBStreamInternal​(JDBCStore store, java.lang.Object obj, Joins joins)  
      java.time.LocalDate getLocalDate​(java.lang.Object obj)
      Return the value stored in the given column or id.
      protected java.time.LocalDate getLocalDateInternal​(java.lang.Object obj, Joins joins)  
      java.time.LocalDateTime getLocalDateTime​(java.lang.Object obj)
      Return the value stored in the given column or id.
      protected java.time.LocalDateTime getLocalDateTimeInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected java.util.Locale getLocaleInternal​(java.lang.Object obj, Joins joins)  
      java.time.LocalTime getLocalTime​(java.lang.Object obj)
      Return the value stored in the given column or id.
      protected java.time.LocalTime getLocalTimeInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected long getLongInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected java.lang.Number getNumberInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected abstract java.lang.Object getObjectInternal​(java.lang.Object obj, int metaType, java.lang.Object arg, Joins joins)
      Return the value stored in the given id or column.
      java.time.OffsetDateTime getOffsetDateTime​(java.lang.Object obj)
      Return the value stored in the given column or id.
      protected java.time.OffsetDateTime getOffsetDateTimeInternal​(java.lang.Object obj, Joins joins)  
      java.time.OffsetTime getOffsetTime​(java.lang.Object obj)
      Return the value stored in the given column or id.
      protected java.time.OffsetTime getOffsetTimeInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected java.sql.Ref getRefInternal​(java.lang.Object obj, java.util.Map map, Joins joins)  
      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.
      protected short getShortInternal​(java.lang.Object obj, Joins joins)  
      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.
      protected java.lang.Object getSQLObjectInternal​(java.lang.Object obj, java.util.Map map, Joins joins)  
      protected abstract java.lang.Object getStreamInternal​(JDBCStore store, java.lang.Object obj, int metaType, java.lang.Object arg, Joins joins)  
      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.
      protected java.lang.String getStringInternal​(java.lang.Object obj, Joins joins, boolean isClobString)  
      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.
      protected java.sql.Time getTimeInternal​(java.lang.Object obj, java.util.Calendar cal, Joins joins)  
      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.
      protected java.sql.Timestamp getTimestampInternal​(java.lang.Object obj, java.util.Calendar cal, Joins joins)  
      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()
      Returns a no-op joins object by default.
      boolean next()
      Advance to the next row, or return false if there are no more rows in the result.
      protected abstract boolean nextInternal()
      Advance this row.
      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 base)
      If this is the result of a UNION used to select a hierarchy of mappings, the base mapping represented by the current row.
      protected void setEagerMap​(java.util.Map eager)
      Raw eager information.
      void setIndexOf​(int idx)  
      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.
      void startDataRequest​(java.lang.Object mapping)
      Informs this receiver about the application element for which a subsequent data request will be made.
      boolean supportsRandomAccess()
      Returns false by default.
      protected java.lang.Object translate​(java.lang.Object obj, Joins joins)
      Translate the user-given id or column.
      boolean wasNull()
      Return true if the last value fetched was null.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface org.apache.openjpa.jdbc.sql.Result

        size

    • Constructor Detail

      • AbstractResult

        public AbstractResult()

    • Method Detail

      • getEager

        public java.lang.Object getEager​(FieldMapping key)
        Description copied from interface: Result
        The eager result for the given key, or null if none.
        Specified by:
        getEager in interface Result

      • putEager

        public void putEager​(FieldMapping key,
                     java.lang.Object res)
        Description copied from interface: Result
        The eager result for the given key, or null if none.
        Specified by:
        putEager in interface Result

      • getEagerMap

        protected java.util.Map getEagerMap​(boolean client)
        Raw eager information. May be null.
        Parameters:
        client - whether the client is accessing eager information

      • setEagerMap

        protected void setEagerMap​(java.util.Map eager)
        Raw eager information.

      • close

        public void close()
        Closes all eager results.
        Specified by:
        close in interface Closeable
        Specified by:
        close in interface Result

      • closeEagerMap

        protected void closeEagerMap​(java.util.Map eager)
        Close all results in eager map.

      • supportsRandomAccess

        public boolean supportsRandomAccess()
                             throws java.sql.SQLException
        Returns false by default.
        Specified by:
        supportsRandomAccess in interface Result
        Throws:
        java.sql.SQLException

      • absolute

        public boolean absolute​(int row)
                 throws java.sql.SQLException
        Description copied from interface: Result
        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.
        Specified by:
        absolute in interface Result
        Throws:
        java.sql.SQLException

      • absoluteInternal

        protected boolean absoluteInternal​(int row)
                            throws java.sql.SQLException
        Throws an exception by default.
        Throws:
        java.sql.SQLException

      • next

        public boolean next()
             throws java.sql.SQLException
        Description copied from interface: Result
        Advance to the next row, or return false if there are no more rows in the result.
        Specified by:
        next in interface Result
        Throws:
        java.sql.SQLException

      • nextInternal

        protected abstract boolean nextInternal()
                                 throws java.sql.SQLException
        Advance this row.
        Throws:
        java.sql.SQLException

      • pushBack

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

      • newJoins

        public Joins newJoins()
        Returns a no-op joins object by default.
        Specified by:
        newJoins in interface Result

      • contains

        public boolean contains​(java.lang.Object obj)
                 throws java.sql.SQLException
        Description copied from interface: Result
        Return true if the given id or column is available in the result.
        Specified by:
        contains in interface Result
        Throws:
        java.sql.SQLException

      • containsAll

        public boolean containsAll​(java.lang.Object[] objs)
                    throws java.sql.SQLException
        Description copied from interface: Result
        Return true if all the given ids or columns are available in the result.
        Specified by:
        containsAll in interface Result
        Throws:
        java.sql.SQLException

      • contains

        public boolean contains​(Column col,
                        Joins joins)
                 throws java.sql.SQLException
        Description copied from interface: Result
        Return true if the given column is available in the result.
        Specified by:
        contains in interface Result
        Throws:
        java.sql.SQLException

      • containsAll

        public boolean containsAll​(Column[] cols,
                           Joins joins)
                    throws java.sql.SQLException
        Description copied from interface: Result
        Return true if all the given columns are available in the result.
        Specified by:
        containsAll in interface Result
        Throws:
        java.sql.SQLException

      • containsInternal

        protected abstract boolean containsInternal​(java.lang.Object obj,
                                            Joins joins)
                                     throws java.sql.SQLException
        Return whether this result contains data for the given id or column. The id or column has not beed passed through translate(java.lang.Object, org.apache.openjpa.jdbc.sql.Joins).
        Throws:
        java.sql.SQLException

      • getBaseMapping

        public ClassMapping getBaseMapping()
        Description copied from interface: Result
        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.
        Specified by:
        getBaseMapping in interface Result

      • setBaseMapping

        public void setBaseMapping​(ClassMapping base)
        Description copied from interface: Result
        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.
        Specified by:
        setBaseMapping in interface Result

      • getMappedByFieldMapping

        public FieldMapping getMappedByFieldMapping()
        Description copied from interface: Result
        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.
        Specified by:
        getMappedByFieldMapping in interface Result

      • setMappedByFieldMapping

        public void setMappedByFieldMapping​(FieldMapping fieldMapping)
        Description copied from interface: Result
        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.
        Specified by:
        setMappedByFieldMapping in interface Result

      • getMappedByValue

        public java.lang.Object getMappedByValue()
        Description copied from interface: Result
        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.
        Specified by:
        getMappedByValue in interface Result

      • setMappedByValue

        public void setMappedByValue​(java.lang.Object mappedByValue)
        Description copied from interface: Result
        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.
        Specified by:
        setMappedByValue in interface Result

      • indexOf

        public int indexOf()
        Description copied from interface: Result
        The index of the select within the UNION that the current row corresponds to, or 0.
        Specified by:
        indexOf in interface Result

      • setIndexOf

        public void setIndexOf​(int idx)

      • load

        public java.lang.Object load​(ClassMapping mapping,
                             JDBCStore store,
                             JDBCFetchConfiguration fetch)
                      throws java.sql.SQLException
        Description copied from interface: Result
        Load a pc object using the given store manager.
        Specified by:
        load in interface Result
        Throws:
        java.sql.SQLException

      • getArray

        public java.sql.Array getArray​(java.lang.Object obj)
                        throws java.sql.SQLException
        Description copied from interface: Result
        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.
        Specified by:
        getArray in interface Result
        Throws:
        java.sql.SQLException

      • getArray

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

      • getArrayInternal

        protected java.sql.Array getArrayInternal​(java.lang.Object obj,
                                          Joins joins)
                                   throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getAsciiStream

        public java.io.InputStream getAsciiStream​(java.lang.Object obj)
                                   throws java.sql.SQLException
        Description copied from interface: Result
        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.
        Specified by:
        getAsciiStream in interface Result
        Throws:
        java.sql.SQLException

      • getAsciiStream

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

      • getAsciiStreamInternal

        protected java.io.InputStream getAsciiStreamInternal​(java.lang.Object obj,
                                                     Joins joins)
                                              throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getBigDecimal

        public java.math.BigDecimal getBigDecimal​(java.lang.Object obj)
                                   throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getBigDecimal in interface Result
        Throws:
        java.sql.SQLException

      • getBigDecimal

        public java.math.BigDecimal getBigDecimal​(Column col,
                                          Joins joins)
                                   throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getBigDecimal in interface Result
        Throws:
        java.sql.SQLException

      • getBigDecimalInternal

        protected java.math.BigDecimal getBigDecimalInternal​(java.lang.Object obj,
                                                     Joins joins)
                                              throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getBigInteger

        public java.math.BigInteger getBigInteger​(java.lang.Object obj)
                                   throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getBigInteger in interface Result
        Throws:
        java.sql.SQLException

      • getBigInteger

        public java.math.BigInteger getBigInteger​(Column col,
                                          Joins joins)
                                   throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getBigInteger in interface Result
        Throws:
        java.sql.SQLException

      • getBigIntegerInternal

        protected java.math.BigInteger getBigIntegerInternal​(java.lang.Object obj,
                                                     Joins joins)
                                              throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getBinaryStream

        public java.io.InputStream getBinaryStream​(java.lang.Object obj)
                                    throws java.sql.SQLException
        Description copied from interface: Result
        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.
        Specified by:
        getBinaryStream in interface Result
        Throws:
        java.sql.SQLException

      • getBinaryStream

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

      • getLOBStream

        public java.io.InputStream getLOBStream​(JDBCStore store,
                                        java.lang.Object obj)
                                 throws java.sql.SQLException
        Specified by:
        getLOBStream in interface Result
        Throws:
        java.sql.SQLException

      • getBinaryStreamInternal

        protected java.io.InputStream getBinaryStreamInternal​(java.lang.Object obj,
                                                      Joins joins)
                                               throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getLOBStreamInternal

        protected java.io.InputStream getLOBStreamInternal​(JDBCStore store,
                                                   java.lang.Object obj,
                                                   Joins joins)
                                            throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getBlob

        public java.sql.Blob getBlob​(java.lang.Object obj)
                      throws java.sql.SQLException
        Description copied from interface: Result
        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.
        Specified by:
        getBlob in interface Result
        Throws:
        java.sql.SQLException

      • getBlob

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

      • getBlobInternal

        protected java.sql.Blob getBlobInternal​(java.lang.Object obj,
                                        Joins joins)
                                 throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getBoolean

        public boolean getBoolean​(java.lang.Object obj)
                   throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getBoolean in interface Result
        Throws:
        java.sql.SQLException

      • getBoolean

        public boolean getBoolean​(Column col,
                          Joins joins)
                   throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getBoolean in interface Result
        Throws:
        java.sql.SQLException

      • getBooleanInternal

        protected boolean getBooleanInternal​(java.lang.Object obj,
                                     Joins joins)
                              throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getByte

        public byte getByte​(java.lang.Object obj)
             throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getByte in interface Result
        Throws:
        java.sql.SQLException

      • getByte

        public byte getByte​(Column col,
                    Joins joins)
             throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getByte in interface Result
        Throws:
        java.sql.SQLException

      • getByteInternal

        protected byte getByteInternal​(java.lang.Object obj,
                               Joins joins)
                        throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getBytes

        public byte[] getBytes​(java.lang.Object obj)
                throws java.sql.SQLException
        Description copied from interface: Result
        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.
        Specified by:
        getBytes in interface Result
        Throws:
        java.sql.SQLException

      • getBytes

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

      • getBytesInternal

        protected byte[] getBytesInternal​(java.lang.Object obj,
                                  Joins joins)
                           throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getCalendar

        public java.util.Calendar getCalendar​(java.lang.Object obj)
                               throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getCalendar in interface Result
        Throws:
        java.sql.SQLException

      • getCalendar

        public java.util.Calendar getCalendar​(Column col,
                                      Joins joins)
                               throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getCalendar in interface Result
        Throws:
        java.sql.SQLException

      • getCalendarInternal

        protected java.util.Calendar getCalendarInternal​(java.lang.Object obj,
                                                 Joins joins)
                                          throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getLocalDate

        public java.time.LocalDate getLocalDate​(java.lang.Object obj)
                                 throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getLocalDate in interface Result
        Throws:
        java.sql.SQLException

      • getLocalDateInternal

        protected java.time.LocalDate getLocalDateInternal​(java.lang.Object obj,
                                                   Joins joins)
                                            throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getLocalTime

        public java.time.LocalTime getLocalTime​(java.lang.Object obj)
                                 throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getLocalTime in interface Result
        Throws:
        java.sql.SQLException

      • getLocalTimeInternal

        protected java.time.LocalTime getLocalTimeInternal​(java.lang.Object obj,
                                                   Joins joins)
                                            throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getLocalDateTime

        public java.time.LocalDateTime getLocalDateTime​(java.lang.Object obj)
                                         throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getLocalDateTime in interface Result
        Throws:
        java.sql.SQLException

      • getLocalDateTimeInternal

        protected java.time.LocalDateTime getLocalDateTimeInternal​(java.lang.Object obj,
                                                           Joins joins)
                                                    throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getOffsetTime

        public java.time.OffsetTime getOffsetTime​(java.lang.Object obj)
                                   throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getOffsetTime in interface Result
        Throws:
        java.sql.SQLException

      • getOffsetTimeInternal

        protected java.time.OffsetTime getOffsetTimeInternal​(java.lang.Object obj,
                                                     Joins joins)
                                              throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getOffsetDateTime

        public java.time.OffsetDateTime getOffsetDateTime​(java.lang.Object obj)
                                           throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getOffsetDateTime in interface Result
        Throws:
        java.sql.SQLException

      • getOffsetDateTimeInternal

        protected java.time.OffsetDateTime getOffsetDateTimeInternal​(java.lang.Object obj,
                                                             Joins joins)
                                                      throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getChar

        public char getChar​(java.lang.Object obj)
             throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getChar in interface Result
        Throws:
        java.sql.SQLException

      • getChar

        public char getChar​(Column col,
                    Joins joins)
             throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getChar in interface Result
        Throws:
        java.sql.SQLException

      • getCharInternal

        protected char getCharInternal​(java.lang.Object obj,
                               Joins joins)
                        throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getCharacterStream

        public java.io.Reader getCharacterStream​(java.lang.Object obj)
                                  throws java.sql.SQLException
        Description copied from interface: Result
        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.
        Specified by:
        getCharacterStream in interface Result
        Throws:
        java.sql.SQLException

      • getCharacterStream

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

      • getCharacterStreamInternal

        protected java.io.Reader getCharacterStreamInternal​(java.lang.Object obj,
                                                    Joins joins)
                                             throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getClob

        public java.sql.Clob getClob​(java.lang.Object obj)
                      throws java.sql.SQLException
        Description copied from interface: Result
        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.
        Specified by:
        getClob in interface Result
        Throws:
        java.sql.SQLException

      • getClob

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

      • getClobInternal

        protected java.sql.Clob getClobInternal​(java.lang.Object obj,
                                        Joins joins)
                                 throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getDate

        public java.util.Date getDate​(java.lang.Object obj)
                       throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getDate in interface Result
        Throws:
        java.sql.SQLException

      • getDate

        public java.util.Date getDate​(Column col,
                              Joins joins)
                       throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getDate in interface Result
        Throws:
        java.sql.SQLException

      • getDateInternal

        protected java.util.Date getDateInternal​(java.lang.Object obj,
                                         Joins joins)
                                  throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getDate

        public java.sql.Date getDate​(java.lang.Object obj,
                             java.util.Calendar cal)
                      throws java.sql.SQLException
        Description copied from interface: Result
        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.
        Specified by:
        getDate in interface Result
        Throws:
        java.sql.SQLException

      • getDate

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

      • getDateInternal

        protected java.sql.Date getDateInternal​(java.lang.Object obj,
                                        java.util.Calendar cal,
                                        Joins joins)
                                 throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getDouble

        public double getDouble​(java.lang.Object obj)
                 throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getDouble in interface Result
        Throws:
        java.sql.SQLException

      • getDouble

        public double getDouble​(Column col,
                        Joins joins)
                 throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getDouble in interface Result
        Throws:
        java.sql.SQLException

      • getDoubleInternal

        protected double getDoubleInternal​(java.lang.Object obj,
                                   Joins joins)
                            throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getFloat

        public float getFloat​(java.lang.Object obj)
               throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getFloat in interface Result
        Throws:
        java.sql.SQLException

      • getFloat

        public float getFloat​(Column col,
                      Joins joins)
               throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getFloat in interface Result
        Throws:
        java.sql.SQLException

      • getFloatInternal

        protected float getFloatInternal​(java.lang.Object obj,
                                 Joins joins)
                          throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getInt

        public int getInt​(java.lang.Object obj)
           throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getInt in interface Result
        Throws:
        java.sql.SQLException

      • getInt

        public int getInt​(Column col,
                  Joins joins)
           throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getInt in interface Result
        Throws:
        java.sql.SQLException

      • getIntInternal

        protected int getIntInternal​(java.lang.Object obj,
                             Joins joins)
                      throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getLocale

        public java.util.Locale getLocale​(java.lang.Object obj)
                           throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getLocale in interface Result
        Throws:
        java.sql.SQLException

      • getLocale

        public java.util.Locale getLocale​(Column col,
                                  Joins joins)
                           throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getLocale in interface Result
        Throws:
        java.sql.SQLException

      • getLocaleInternal

        protected java.util.Locale getLocaleInternal​(java.lang.Object obj,
                                             Joins joins)
                                      throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getLong

        public long getLong​(java.lang.Object obj)
             throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getLong in interface Result
        Throws:
        java.sql.SQLException

      • getLong

        public long getLong​(Column col,
                    Joins joins)
             throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getLong in interface Result
        Throws:
        java.sql.SQLException

      • getLongInternal

        protected long getLongInternal​(java.lang.Object obj,
                               Joins joins)
                        throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getNumber

        public java.lang.Number getNumber​(java.lang.Object obj)
                           throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getNumber in interface Result
        Throws:
        java.sql.SQLException

      • getNumber

        public java.lang.Number getNumber​(Column col,
                                  Joins joins)
                           throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getNumber in interface Result
        Throws:
        java.sql.SQLException

      • getNumberInternal

        protected java.lang.Number getNumberInternal​(java.lang.Object obj,
                                             Joins joins)
                                      throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getObject

        public java.lang.Object getObject​(java.lang.Object obj,
                                  int metaType,
                                  java.lang.Object arg)
                           throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getObject in interface Result
        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

      • getObject

        public java.lang.Object getObject​(Column col,
                                  java.lang.Object arg,
                                  Joins joins)
                           throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getObject in interface Result
        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

      • getObjectInternal

        protected abstract java.lang.Object getObjectInternal​(java.lang.Object obj,
                                                      int metaType,
                                                      java.lang.Object arg,
                                                      Joins joins)
                                               throws java.sql.SQLException
        Return the value stored in the given id or column.
        Throws:
        java.sql.SQLException

      • getStreamInternal

        protected abstract java.lang.Object getStreamInternal​(JDBCStore store,
                                                      java.lang.Object obj,
                                                      int metaType,
                                                      java.lang.Object arg,
                                                      Joins joins)
                                               throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getSQLObject

        public java.lang.Object getSQLObject​(java.lang.Object obj,
                                     java.util.Map map)
                              throws java.sql.SQLException
        Description copied from interface: Result
        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.
        Specified by:
        getSQLObject in interface Result
        Throws:
        java.sql.SQLException

      • getSQLObject

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

      • getSQLObjectInternal

        protected java.lang.Object getSQLObjectInternal​(java.lang.Object obj,
                                                java.util.Map map,
                                                Joins joins)
                                         throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getRef

        public java.sql.Ref getRef​(java.lang.Object obj,
                           java.util.Map map)
                    throws java.sql.SQLException
        Description copied from interface: Result
        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.
        Specified by:
        getRef in interface Result
        Throws:
        java.sql.SQLException

      • getRef

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

      • getRefInternal

        protected java.sql.Ref getRefInternal​(java.lang.Object obj,
                                      java.util.Map map,
                                      Joins joins)
                               throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getShort

        public short getShort​(java.lang.Object obj)
               throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getShort in interface Result
        Throws:
        java.sql.SQLException

      • getShort

        public short getShort​(Column col,
                      Joins joins)
               throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getShort in interface Result
        Throws:
        java.sql.SQLException

      • getShortInternal

        protected short getShortInternal​(java.lang.Object obj,
                                 Joins joins)
                          throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getString

        public java.lang.String getString​(java.lang.Object obj)
                           throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column or id.
        Specified by:
        getString in interface Result
        Throws:
        java.sql.SQLException

      • getString

        public java.lang.String getString​(Column col,
                                  Joins joins)
                           throws java.sql.SQLException
        Description copied from interface: Result
        Return the value stored in the given column.
        Specified by:
        getString in interface Result
        Throws:
        java.sql.SQLException

      • getStringInternal

        protected java.lang.String getStringInternal​(java.lang.Object obj,
                                             Joins joins,
                                             boolean isClobString)
                                      throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getTime

        public java.sql.Time getTime​(java.lang.Object obj,
                             java.util.Calendar cal)
                      throws java.sql.SQLException
        Description copied from interface: Result
        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.
        Specified by:
        getTime in interface Result
        Throws:
        java.sql.SQLException

      • getTime

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

      • getTimeInternal

        protected java.sql.Time getTimeInternal​(java.lang.Object obj,
                                        java.util.Calendar cal,
                                        Joins joins)
                                 throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getTimestamp

        public java.sql.Timestamp getTimestamp​(java.lang.Object obj,
                                       java.util.Calendar cal)
                                throws java.sql.SQLException
        Description copied from interface: Result
        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.
        Specified by:
        getTimestamp in interface Result
        Throws:
        java.sql.SQLException

      • getTimestamp

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

      • getTimestampInternal

        protected java.sql.Timestamp getTimestampInternal​(java.lang.Object obj,
                                                  java.util.Calendar cal,
                                                  Joins joins)
                                           throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • wasNull

        public boolean wasNull()
                throws java.sql.SQLException
        Description copied from interface: Result
        Return true if the last value fetched was null.
        Specified by:
        wasNull in interface Result
        Throws:
        java.sql.SQLException

      • checkNull

        protected java.lang.Object checkNull​(java.lang.Object val)

      • setLocking

        public void setLocking​(boolean locking)
        Description copied from interface: Result
        Set to true if row locking has been issued for the row.
        Specified by:
        setLocking in interface Result

      • isLocking

        public boolean isLocking()
        Description copied from interface: Result
        If true, then any results loaded from this Result will be locked in the database.
        Specified by:
        isLocking in interface Result

      • startDataRequest

        public void startDataRequest​(java.lang.Object mapping)
        Description copied from interface: Result
        Informs this receiver about the application element for which a subsequent data request will be made.
        Specified by:
        startDataRequest in interface Result

      • endDataRequest

        public void endDataRequest()
        Description copied from interface: Result
        Ends a data request. Must be called in conjunction with Result.startDataRequest(java.lang.Object). The calls can be nested as follws
         startDataRequest (relation); startDataRequest (relationsField);
 getObject("COLUMN_Y"); endDataRequest (); endDataRequest ();
        Specified by:
        endDataRequest in interface Result

      • translate

        protected java.lang.Object translate​(java.lang.Object obj,
                                     Joins joins)
                              throws java.sql.SQLException
        Translate the user-given id or column. This method is called before delegating to any get*Internal methods with the exception of getObjectInternal. Return the original value by default.
        Throws:
        java.sql.SQLException