org.apache.ojb.broker.accesslayer
Class PkEnumeration

java.lang.Object
  extended byorg.apache.ojb.broker.accesslayer.PkEnumeration
All Implemented Interfaces:
java.util.Enumeration, java.io.Serializable

public class PkEnumeration
extends java.lang.Object
implements java.util.Enumeration, java.io.Serializable

this class can be used to create enumerations of PrimaryKey objects. This is interesting for EJB finder methods in BMP entity beans which must return such enumerations.

Version:
$Id: PkEnumeration.java,v 1.15 2004/01/07 11:41:20 thma Exp $
Author:
Thomas Mahler
See Also:
Serialized Form

Field Summary
protected  PersistenceBroker broker
           
protected  ClassDescriptor classDescriptor
          descriptor for the class of which items are to be found
protected  java.lang.reflect.Constructor constructor
          the Constructor that is needed to build the PrimaryKey Objects
protected  boolean hasCalledCheck
           
protected  boolean hasNext
           
protected  ResultSetAndStatement resultSetAndStatment
          The underlying jdbc resultset produced by select statement
(package private) static long serialVersionUID
           
 
Constructor Summary
PkEnumeration(Query query, ClassDescriptor cld, java.lang.Class primaryKeyClass, PersistenceBroker broker)
          PkEnumeration constructor.
 
Method Summary
protected  void finalize()
          protection just in case someone leaks.
 boolean hasMoreElements()
          Tests if this enumeration contains more elements.
 java.lang.Object nextElement()
          Returns the next element of this enumeration if this enumeration object has at least one more element to provide.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

hasCalledCheck

protected boolean hasCalledCheck

hasNext

protected boolean hasNext

broker

protected PersistenceBroker broker

resultSetAndStatment

protected ResultSetAndStatement resultSetAndStatment
The underlying jdbc resultset produced by select statement


classDescriptor

protected ClassDescriptor classDescriptor
descriptor for the class of which items are to be found


constructor

protected java.lang.reflect.Constructor constructor
the Constructor that is needed to build the PrimaryKey Objects

Constructor Detail

PkEnumeration

public PkEnumeration(Query query,
                     ClassDescriptor cld,
                     java.lang.Class primaryKeyClass,
                     PersistenceBroker broker)
PkEnumeration constructor.

Parameters:
query - the SELECT statement gerating the underlying resultset
cld - classDescriptor of the target entity class (say Article)
primaryKeyClass - the entity classes PrimaryKey class (say ArticleKey). this key-class MUST have a constructor with one argument of type org.apache.ojb.broker.Identity !
Method Detail

hasMoreElements

public boolean hasMoreElements()
Tests if this enumeration contains more elements.

Specified by:
hasMoreElements in interface java.util.Enumeration
Returns:
true if and only if this enumeration object contains at least one more element to provide; false otherwise.

nextElement

public java.lang.Object nextElement()
Returns the next element of this enumeration if this enumeration object has at least one more element to provide.

Specified by:
nextElement in interface java.util.Enumeration
Returns:
the next element of this enumeration.
Throws:
java.util.NoSuchElementException - if no more elements exist.

finalize

protected void finalize()
protection just in case someone leaks.



Authors: Thomas Mahler and others. (C) 2000 - 2003 Apache Software Foundation
All rights reserved. Published under the Apache License.
http://db.apache.org/ojb
Version: 1.0.rc5, 2003-12-14