com.solarmetric.kodo.runtime.objectprovider
Interface ResultObjectProvider

All Known Implementing Classes:

CustomResultObjectProvider.ResultObjectProviderAdapter, DefaultResultObjectProvider

public interface ResultObjectProvider

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.

Method Summary

boolean	advance(Object input) Advance the input source input to the next position.
void	free(Object input) Optionally free the resources associated with this provider.
Object	getResultObject(Object input) Instantiate the desired object from the current data in input.
boolean	open(Object input) Open the input source input.

Method Detail

getResultObject

public Object getResultObject(Object input)
                       throws Exception

Instantiate the desired object from the current data in input.

open

public boolean open(Object input)
             throws Exception

Open the input source input. This is invoked before any data is loaded from the input. Return true if there is data in the input; otherwise false.

advance

public boolean advance(Object input)
                throws Exception

Advance the input source input to the next position. Return true if there is more data; otherwise false. This is invoked between each invocation of getResultObject(java.lang.Object).

free

public void free(Object input)
          throws Exception

Optionally free the resources associated with this provider. For example, the source Connection might be released once the statement has been completed, or an InputStream might be closed.