Package com.solarmetric.kodo.runtime.objectprovider

Object provider framework

See:
Description

Interface Summary

CustomResultList	Customizable implementation of the ResultList interface, that allows configuration of the input source and ResultObjectProvider upon instantiation.
CustomResultObjectProvider	Variant of ResultObjectProvider that populates a StateManagerImpl object in an application-defined manner.
ResultList	List interface that represents a potentially lazy ResultList instantiation.
ResultObjectProvider	Interface that allows lazy/custom instantiation of input objects.

Class Summary

CollectionResultList	A basic ResultList inplementation that just wraps a Collection.
CustomResultObjectProvider.ResultObjectProviderAdapter	Adapter class that allows a CustomResultObjectProvider to be used in situations that require a ResultObjectProvider.
CustomResultObjectProvider.ROPInfo	Data structure that holds information about the object currently being loaded, and a reference to the CustomResultObjectProvider that should be used to load the information into a StateManagerImpl.
CustomResultObjectProviderImpl	Abstract implementation of CustomResultObjectProvider that implements CustomResultObjectProvider.getROPInfo(java.lang.Object, java.lang.Object, com.solarmetric.kodo.meta.ClassMetaData) by assembling the necessary information about the object to be loaded.
EagerResultList	Simple, non-lazy ResultList implementation
MergedResultList	A MergedResultList is a wrapper for multiple instances of a ResultList that may be returned.
OnDemandForwardResultList	ResultList implementation that uses lazy instantiation for forward-only underlying ResultObjectProvider instances.
ResultListIterator	Wrapper iterator that will return false for hasNext() if the owning ResultList has been closed.

Package com.solarmetric.kodo.runtime.objectprovider Description

Object provider framework

This package provides a framework for loading data into a PersistenceManager. It can be used internally by StoreManager implementations, or can be accessed directly for loading of arbitrary data into a PersistenceManager.

Notable Classes

• ResultObjectProvider

  This interface, coupled with ResultList, allows for lazy materialization of data into PersistenceCapable objects. This is a fairly lightweight interface that delegates most of the work of loading data to the underlying StoreManager.

• ResultList

  Extension of the java.util.List interface that provides some facilities for loading the next object from a data source and for cleaning up resources once a list is fully instantiated. ResultList instances will not necessarily be fully instantiated up-front. Rather, the objects backing the list may be lazily materialized on demand.

• CustomResultObjectProvider

  This interface is a variation of ResultObjectProvider that directly handles considerably more of the data loading process than does ResultObjectProvider. It is useful when loading data in an application-dependent manner that might not be possible using Kodo JDO's standard data loading algorithms. For example, data returned from stored procedures can be loaded with an appropriate CustomResultObjectProvider.

• CustomResultObjectProviderImpl

  This abstract class is a useful starting point for basic application-defined loading of data. It loads all data up-front into a PCData object, and later loads the fields in that object into a StateManagerImpl object provided by the Kodo JDO runtime framework.