Class NeoDatisExtent

  extended by
      extended by
All Implemented Interfaces:

public class NeoDatisExtent

Extent for use with NeoDatis datastores. The Extent is generated in two ways, with or without subclasses. These simply execute a NeoDatis Criteria query setting the "polymorphic" flag.

Nested Class Summary
 class NeoDatisExtent.NeoDatisExtentIterator
          Iterator for use with NeoDatis Extents.
Field Summary
protected static org.datanucleus.util.Localiser LOCALISER_NEODATIS
          Localiser for messages.
Fields inherited from class
candidateClass, cmd, LOCALISER, om, storeMgr, subclasses
Constructor Summary
NeoDatisExtent(org.datanucleus.ObjectManager om, java.lang.Class cls, boolean subclasses, org.datanucleus.metadata.AbstractClassMetaData cmd)
Method Summary
 void close(java.util.Iterator iter)
          Method to close the extent.
 void closeAll()
          Close all Iterators associated with this Extent instance.
 org.datanucleus.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
getCandidateClass, getObjectManager, hasSubclasses, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail


protected static final org.datanucleus.util.Localiser LOCALISER_NEODATIS
Localiser for messages.

Constructor Detail


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

om - Object Manager
cls - candidate class
subclasses - Whether to include subclasses
cmd - MetaData for the candidate class
Method Detail


public void close(java.util.Iterator iter)
Method to close the extent.

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


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.


public java.util.Iterator iterator()
Returns an iterator over all the instances in the Extent.

an iterator over all the instances in the Extent.


public org.datanucleus.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.

the FetchPlan

Copyright © 2009. All Rights Reserved.