org.datanucleus.api.jdo

Class JDOExtent

java.lang.Object

org.datanucleus.api.jdo.JDOExtent

All Implemented Interfaces:

Iterable, javax.jdo.Extent

public class JDOExtent
extends Object
implements javax.jdo.Extent

Wrapper implementation of a JDO Extent.

Constructor Summary

Constructors

Constructor and Description
JDOExtent(javax.jdo.PersistenceManager pm, org.datanucleus.store.Extent extent) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close(Iterator iterator) Method to close the Extent iterator.
void	closeAll() Method to close all Extent iterators.
Class	getCandidateClass() Accessor for the candidate class of the Extent.
org.datanucleus.store.Extent	getExtent() Accessor for the real extent.
javax.jdo.FetchPlan	getFetchPlan() Accessor for the FetchPlan for the Extent.
javax.jdo.PersistenceManager	getPersistenceManager() Accessor for the PersistenceManager.
boolean	hasSubclasses() Accessor for whether the Extent includes subclasses.
Iterator	iterator() Accessor for an iterator for this Extent.

Methods inherited from class java.lang.Object

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

Constructor Detail

JDOExtent

public JDOExtent(javax.jdo.PersistenceManager pm,
         org.datanucleus.store.Extent extent)

Constructor.

Parameters:

pm - PersistenceManager

extent - Underlying Extent

Method Detail

close

public void close(Iterator iterator)

Method to close the Extent iterator.

Specified by:

close in interface javax.jdo.Extent

Parameters:

iterator - Iterator for the extent.

closeAll

public void closeAll()

Method to close all Extent iterators.

Specified by:

closeAll in interface javax.jdo.Extent

getCandidateClass

public Class getCandidateClass()

Accessor for the candidate class of the Extent.

Specified by:

getCandidateClass in interface javax.jdo.Extent

Returns:

Candidate class

hasSubclasses

public boolean hasSubclasses()

Accessor for whether the Extent includes subclasses.

Specified by:

hasSubclasses in interface javax.jdo.Extent

Returns:

Whether it has subclasses

getFetchPlan

public javax.jdo.FetchPlan getFetchPlan()

Accessor for the FetchPlan for the Extent.

Specified by:

getFetchPlan in interface javax.jdo.Extent

Returns:

FetchPlan

getPersistenceManager

public javax.jdo.PersistenceManager getPersistenceManager()

Accessor for the PersistenceManager.

Specified by:

getPersistenceManager in interface javax.jdo.Extent

Returns:

The PM

getExtent

public org.datanucleus.store.Extent getExtent()

Accessor for the real extent.

Returns:

The Underlying extent

iterator

public Iterator iterator()

Accessor for an iterator for this Extent.

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface javax.jdo.Extent

Returns:

The iterator