|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Extent
Instances of the Extent
class represent the entire collection
of instances in the data store of the candidate class
possibly including its subclasses.
The Extent
instance has two possible uses:
Query
in the data store over all instances
of a particular class
Method Summary | |
---|---|
void |
close(java.util.Iterator it)
Close an Iterator associated with this Extent instance. |
void |
closeAll()
Close all Iterator s 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. |
FetchPlan |
getFetchPlan()
Get the fetch plan associated with this Extent. |
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 . |
Method Detail |
---|
java.util.Iterator iterator()
Extent
.
The behavior of the returned iterator might depend on the setting of the
ignoreCache
flag in the owning PersistenceManager
.
Extent
boolean hasSubclasses()
Extent
was defined to contain subclasses.
Extent
was defined to contain instances
that are of a subclass type.java.lang.Class getCandidateClass()
Extent
contains all instances of a particular class in the data
store; this method returns the Class
of the instances.
Class
of instances of this Extent
.PersistenceManager getPersistenceManager()
Extent
is managed by a PersistenceManager
;
this method gives access to the owning PersistenceManager
.
PersistenceManager
void closeAll()
Iterator
s associated with this Extent
instance.
Iterator
s 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
.
void close(java.util.Iterator it)
Iterator
associated with this Extent
instance.
Iterator
s 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
.
it
- an Iterator
obtained by the method
iterator()
on this Extent
instance.FetchPlan getFetchPlan()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |