Package org.datanucleus.store.query

Class DefaultCandidateExtent<T>

java.lang.Object

org.datanucleus.store.query.AbstractExtent<T>

org.datanucleus.store.query.DefaultCandidateExtent<T>

All Implemented Interfaces:

java.lang.AutoCloseable, Extent<T>

public class DefaultCandidateExtent<T>
extends AbstractExtent<T>
implements java.lang.AutoCloseable

Extent that does a simple JDOQL query for the candidate with/without subclasses.

Field Summary

Fields

Modifier and Type	Field	Description
private FetchPlan	fetchPlan	FetchPlan for use with this Extent.
private Query	query	Underlying query for getting the Extent.
protected java.util.Map<java.util.Iterator,QueryResult>	queryResultsByIterator	Map of the iterators of the Extents accessed.

Fields inherited from class org.datanucleus.store.query.AbstractExtent

candidateClass, cmd, ec, subclasses

Constructor Summary

Constructors

Constructor	Description
DefaultCandidateExtent(ExecutionContext ec, java.lang.Class<T> cls, boolean subclasses, AbstractClassMetaData cmd)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
void	close(java.util.Iterator<T> iterator)	Close the specified iterator.
void	closeAll()	Close all iterators and all resources for this extent.
ExecutionContext	getExecutionContext()	Accessor for the owning execution context.
FetchPlan	getFetchPlan()
boolean	hasSubclasses()	Returns whether this Extent was defined to contain subclasses.
java.util.Iterator<T>	iterator()	Accessor for an iterator over the extent.

Methods inherited from class org.datanucleus.store.query.AbstractExtent

getCandidateClass, toString

Methods inherited from class java.lang.Object

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

Field Detail

fetchPlan

private FetchPlan fetchPlan

FetchPlan for use with this Extent.

query

private Query query

Underlying query for getting the Extent.

queryResultsByIterator

protected java.util.Map<java.util.Iterator,QueryResult> queryResultsByIterator

Map of the iterators of the Extents accessed.

Constructor Detail

DefaultCandidateExtent

public DefaultCandidateExtent(ExecutionContext ec,
                              java.lang.Class<T> cls,
                              boolean subclasses,
                              AbstractClassMetaData cmd)

Constructor.

Parameters:

ec - execution context

cls - candidate class

subclasses - Whether to include subclasses

cmd - MetaData for the candidate class

Method Detail

iterator

public java.util.Iterator<T> iterator()

Description copied from interface: Extent

Accessor for an iterator over the extent.

Specified by:

iterator in interface Extent<T>

Returns:

The iterator

hasSubclasses

public boolean hasSubclasses()

Description copied from class: AbstractExtent

Returns whether this Extent was defined to contain subclasses.

Specified by:

hasSubclasses in interface Extent<T>

Overrides:

hasSubclasses in class AbstractExtent<T>

Returns:

true if this Extent was defined to include subclasses.

getExecutionContext

public ExecutionContext getExecutionContext()

Description copied from class: AbstractExtent

Accessor for the owning execution context.

Specified by:

getExecutionContext in interface Extent<T>

Overrides:

getExecutionContext in class AbstractExtent<T>

Returns:

execution context

getFetchPlan

public FetchPlan getFetchPlan()

Specified by:

getFetchPlan in interface Extent<T>

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

closeAll

public void closeAll()

Description copied from interface: Extent

Close all iterators and all resources for this extent.

Specified by:

closeAll in interface Extent<T>

close

public void close(java.util.Iterator<T> iterator)

Description copied from interface: Extent

Close the specified iterator.

Specified by:

close in interface Extent<T>

Parameters:

iterator - The iterator