org.objectweb.speedo.runtime.query
Class SpeedoExtent

org.objectweb.speedo.runtime.query.SpeedoExtent

public class SpeedoExtent


Constructor Summary
SpeedoExtent(java.lang.Class candidateClass, boolean hasSubclasses, javax.jdo.PersistenceManager pm)
          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.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.
 

Constructor Detail

SpeedoExtent

public SpeedoExtent(java.lang.Class candidateClass,
                    boolean hasSubclasses,
                    javax.jdo.PersistenceManager pm)
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.
Returns:
an iterator over all instances in the Extent

hasSubclasses

public boolean hasSubclasses()
Returns whether this Extent was defined to contain subclasses.
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
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.
Returns:
the owning PersistenceManager

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.

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.
Parameters:
it - an iterator obtained by the method iterator() on this Extent instance.