SQLProjectionResultObjectProvider (OpenJPA Parent POM 2.4.0 API)

java.lang.Object
- org.apache.openjpa.jdbc.kernel.SQLProjectionResultObjectProvider

All Implemented Interfaces:

ResultObjectProvider, Closeable
```
 class SQLProjectionResultObjectProvider
extends Object
implements ResultObjectProvider
```
Provides all column data in a ResultSet.

Author:

Abe White

Constructor Summary

Constructors
Constructor and Description
`SQLProjectionResultObjectProvider(JDBCStore store, JDBCFetchConfiguration fetch, ResultSetResult res, Class cls)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`absolute(int pos)` Move to the given 0-based position.
`void`	`close()` Free the resources associated with this provider.
`Object`	`getResultObject()` Instantiate the current result object.
`void`	`handleCheckedException(Exception e)` Any checked exceptions that are thrown will be passed to this method.
`boolean`	`next()` Advance the input to the next position.
`void`	`open()` Open the result.
`void`	`reset()` Reset this provider.
`int`	`size()` Return the number of items in the input, or `Integer.MAX_VALUE` if the size in unknown.
`boolean`	`supportsRandomAccess()` Return true if this provider supports random access.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SQLProjectionResultObjectProvider
```
public SQLProjectionResultObjectProvider(JDBCStore store,
                                 JDBCFetchConfiguration fetch,
                                 ResultSetResult res,
                                 Class cls)
                                  throws SQLException
```
    Constructor.
    
    Parameters:
    res - the result data
    cls - the result class; may be null for the default
    
    Throws:
    
    SQLException
- Method Detail
  - supportsRandomAccess
```
public boolean supportsRandomAccess()
```
    Description copied from interface: ResultObjectProvider
    
    Return true if this provider supports random access.
    
    Specified by:
    
    supportsRandomAccess in interface ResultObjectProvider
  - open
```
public void open()
```
    Description copied from interface: ResultObjectProvider
    
    Open the result. This will be called before ResultObjectProvider.next(), ResultObjectProvider.absolute(int), or ResultObjectProvider.size().
    
    Specified by:
    
    open in interface ResultObjectProvider
  - getResultObject
```
public Object getResultObject()
                       throws SQLException
```
    Description copied from interface: ResultObjectProvider
    
    Instantiate the current result object. This method will only be called after ResultObjectProvider.next() or ResultObjectProvider.absolute(int).
    
    Specified by:
    
    getResultObject in interface ResultObjectProvider
    
    Throws:
    
    SQLException
  - next
```
public boolean next()
             throws SQLException
```
    Description copied from interface: ResultObjectProvider
    
    Advance the input to the next position. Return true if there is more data; otherwise false.
    
    Specified by:
    
    next in interface ResultObjectProvider
    
    Throws:
    
    SQLException
  - absolute
```
public boolean absolute(int pos)
                 throws SQLException
```
    Description copied from interface: ResultObjectProvider
    
    Move to the given 0-based position. This method is only called for providers that support random access. Return true if there is data at this position; otherwise false. This may be invoked in place of ResultObjectProvider.next().
    
    Specified by:
    
    absolute in interface ResultObjectProvider
    
    Throws:
    
    SQLException
  - size
```
public int size()
         throws SQLException
```
    Description copied from interface: ResultObjectProvider
    
    Return the number of items in the input, or Integer.MAX_VALUE if the size in unknown.
    
    Specified by:
    
    size in interface ResultObjectProvider
    
    Throws:
    
    SQLException
  - reset
```
public void reset()
```
    Description copied from interface: ResultObjectProvider
    
    Reset this provider. This is an optional operation. If supported, it should move the position of the provider to before the first element. Non-random-access providers may be able to support this method by re-acquiring all resources as if the result were just opened.
    
    Specified by:
    
    reset in interface ResultObjectProvider
  - close
```
public void close()
```
    Description copied from interface: ResultObjectProvider
    
    Free the resources associated with this provider.
    
    Specified by:
    
    close in interface ResultObjectProvider
    
    Specified by:
    
    close in interface Closeable
  - handleCheckedException
```
public void handleCheckedException(Exception e)
```
    Description copied from interface: ResultObjectProvider
    
    Any checked exceptions that are thrown will be passed to this method. The provider should re-throw the exception as an appropriate unchecked exception.
    
    Specified by:
    
    handleCheckedException in interface ResultObjectProvider

Class SQLProjectionResultObjectProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SQLProjectionResultObjectProvider

Method Detail

supportsRandomAccess

open

getResultObject

next

absolute

size

reset

close

handleCheckedException