Interface ResultObjectProvider
- All Superinterfaces:
Closeable
- All Known Subinterfaces:
BatchedResultObjectProvider, PCResultObjectProvider
- All Known Implementing Classes:
AbstractPCResultObjectProvider, GenericResultObjectProvider, InstanceResultObjectProvider, ListResultObjectProvider, MergedResultObjectProvider, OrderingMergedResultObjectProvider, PagingResultObjectProvider, PreparedResultObjectProvider, QueryImpl.PackingResultObjectProvider, RangeResultObjectProvider, SelectResultObjectProvider, UniqueResultObjectProvider, XROP
Interface that allows lazy/custom instantiation of input objects.
ResultList objects do not necessarily load in data all
at once. Instead, they may lazily load objects as necessary. So,
the lifespan of a ResultObjectProvider instance is
related to how the application deals with processing the
ResultList created with a given
ResultObjectProvider instance.- Author:
- Marc Prud'hommeaux, Patrick Linskey, Abe White
-
Method Summary
Modifier and TypeMethodDescriptionbooleanabsolute(int pos) Move to the given 0-based position.voidclose()Free the resources associated with this provider.Instantiate the current result object.voidAny checked exceptions that are thrown will be passed to this method.booleannext()Advance the input to the next position.voidopen()Open the result.voidreset()Reset this provider.intsize()Return the number of items in the input, orInteger.MAX_VALUEif the size in unknown.booleanReturn true if this provider supports random access.
-
Method Details
-
supportsRandomAccess
boolean supportsRandomAccess()Return true if this provider supports random access. -
open
- Throws:
Exception
-
getResultObject
Instantiate the current result object. This method will only be called afternext()orabsolute(int).- Throws:
Exception
-
next
-
absolute
-
size
Return the number of items in the input, orInteger.MAX_VALUEif the size in unknown.- Throws:
Exception
-
reset
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.- Throws:
Exception
-
close
-
handleCheckedException
Any checked exceptions that are thrown will be passed to this method. The provider should re-throw the exception as an appropriate unchecked exception.
-