org.objectweb.speedo.query.lib
Class SpeedoExtent

java.lang.Object
  org.objectweb.speedo.query.lib.SpeedoExtent

All Implemented Interfaces:

javax.jdo.Extent

public class SpeedoExtent

extends java.lang.Object

implements javax.jdo.Extent

Constructor Summary

SpeedoExtent(java.lang.Class candidateClass, boolean hasSubclasses, ProxyManager pm, JormFactory jf, boolean prefetch, org.objectweb.util.monolog.api.Logger logger)
create a new SpeedoExtent object, this object is not obtained by a call to 'new' by the client application, but by the PersistenceManager object with getExtent() method

Method Summary

void	close(java.util.Iterator it) Close an Iterator associated with this Extent instance.
void	closeAll() Close all Iterators associated with this Extent instance.
java.lang.Class	getCandidateClass() An Extent contains all instances of a particular Class in the data store; this method returns the Class of the instances
javax.jdo.FetchPlan	getFetchPlan()
javax.jdo.PersistenceManager	getPersistenceManager() An Extent is managed by a PersistenceManager; this method gives access to the owning PersistenceManager.
boolean	hasSubclasses() Returns whether this Extent was defined to contain subclasses.
java.util.Iterator	iterator() Returns an iterator over all the instances in the Extent.
void	setFetchPlan(javax.jdo.FetchPlan fp)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpeedoExtent

public SpeedoExtent(java.lang.Class candidateClass,
                    boolean hasSubclasses,
                    ProxyManager pm,
                    JormFactory jf,
                    boolean prefetch,
                    org.objectweb.util.monolog.api.Logger logger)

create a new SpeedoExtent object, this object is not obtained by a call to 'new' by the client application, but by the PersistenceManager object with getExtent() method

Parameters:

candidateClass -

hasSubclasses -

pm -

Method Detail

iterator

public java.util.Iterator iterator()

Returns an iterator over all the instances in the Extent.

Specified by:

iterator in interface javax.jdo.Extent

Returns:

an iterator over all instances in the Extent

hasSubclasses

public boolean hasSubclasses()

Returns whether this Extent was defined to contain subclasses.

Specified by:

hasSubclasses in interface javax.jdo.Extent

Returns:

true if this Extent was defined to contain instances that are of a subclass type

getCandidateClass

public java.lang.Class getCandidateClass()

An Extent contains all instances of a particular Class in the data store; this method returns the Class of the instances

Specified by:

getCandidateClass in interface javax.jdo.Extent

Returns:

the Class of instances of this Extent

getPersistenceManager

public javax.jdo.PersistenceManager getPersistenceManager()

An Extent is managed by a PersistenceManager; this method gives access to the owning PersistenceManager.

Specified by:

getPersistenceManager in interface javax.jdo.Extent

Returns:

the owning PersistenceManager

getFetchPlan

public javax.jdo.FetchPlan getFetchPlan()

Specified by:

getFetchPlan in interface javax.jdo.Extent

setFetchPlan

public void setFetchPlan(javax.jdo.FetchPlan fp)

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.setExtent, and to get an Iterator.

Specified by:

closeAll in interface javax.jdo.Extent

close

public void close(java.util.Iterator it)

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.setExtent, and to get an Iterator.

Specified by:

close in interface javax.jdo.Extent

Parameters:

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