org.jpox.store.rdbms.extent
Class AbstractRDBMSExtent

java.lang.Object
  org.jpox.store.AbstractExtent
      org.jpox.store.rdbms.extent.AbstractRDBMSExtent

All Implemented Interfaces:

org.jpox.store.Extent

Direct Known Subclasses:

ClassTableExtent, ClassViewExtent

public abstract class AbstractRDBMSExtent
extends org.jpox.store.AbstractExtent

Abstract representation of an Extent for RDBMS datastores.

Version:

$Revision: 1.6 $

Field Summary

protected org.jpox.store.query.Query	query Query executed for returning the Extent.
protected java.util.HashMap	queryResultsByIterator Map of the iterators of the Extents accessed.

Fields inherited from class org.jpox.store.AbstractExtent

candidateClass, cmd, LOCALISER, om, storeMgr, subclasses

Constructor Summary

AbstractRDBMSExtent(org.jpox.ObjectManager om, java.lang.Class cls, boolean subclasses, org.jpox.metadata.AbstractClassMetaData cmd)
Constructor.

Method Summary

void	close(java.util.Iterator iter) Close an Iterator associated with this Extent instance.
void	closeAll() Close all Iterators associated with this Extent instance.
org.jpox.FetchPlan	getFetchPlan() This method retrieves the fetch plan associated with the Extent.
java.util.Iterator	iterator() Returns an iterator over all the instances in the Extent.

Methods inherited from class org.jpox.store.AbstractExtent

getCandidateClass, getObjectManager, hasSubclasses, toString

Methods inherited from class java.lang.Object

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

Field Detail

query

protected final org.jpox.store.query.Query query

Query executed for returning the Extent.

queryResultsByIterator

protected java.util.HashMap queryResultsByIterator

Map of the iterators of the Extents accessed.

Constructor Detail

AbstractRDBMSExtent

public AbstractRDBMSExtent(org.jpox.ObjectManager om,
                           java.lang.Class cls,
                           boolean subclasses,
                           org.jpox.metadata.AbstractClassMetaData cmd)

Constructor.

Parameters:

om - Object Manager

cls - candidate class

subclasses - Whether to include subclasses

cmd - MetaData for the candidate class

Method Detail

iterator

public java.util.Iterator iterator()

Returns an iterator over all the instances in the Extent.

Returns:

an iterator over all the instances in the Extent.

close

public void close(java.util.Iterator iter)

Close an Iterator associated with this Extent instance. Iterators closed by this method will return false to hasNext() and will throw NoSuchElementException on next(). The Extent instance can still be used as a parameter of Query.setCandidates, and to get an Iterator.

Parameters:

iter - an iterator obtained by the method iterator() on this Extent instance.

closeAll

public void closeAll()

Close all Iterators associated with this Extent instance. Iterators closed by this method will return false to hasNext() and will throw NoSuchElementException on next(). The Extent instance can still be used as a parameter of Query.setCandidates, and to get an Iterator.

getFetchPlan

public org.jpox.FetchPlan getFetchPlan()

This method retrieves the fetch plan associated with the Extent. It always returns the identical instance for the same Extent instance. Any change made to the fetch plan affects subsequent instance retrievals via next(). Only instances not already in memory are affected by the fetch plan. Fetch plan is described in Section 12.7.

Returns:

the FetchPlan