org.jpox
Class SequenceImpl

java.lang.Object
  org.jpox.SequenceImpl

All Implemented Interfaces:

javax.jdo.datastore.Sequence

public class SequenceImpl
extends java.lang.Object
implements javax.jdo.datastore.Sequence

Basic implementation of a JDO 2 datastore sequence. Utilises the org.jpox.store.poid classes to generate sequence values.

Version:

$Revision: 1.18 $

Field Summary

protected PoidGenerator	generator The generator for the sequence.
protected static Localiser	LOCALISER Localisation of messages
protected PersistenceManager	pm The controlling PersistenceManager.
protected SequenceMetaData	seqMetaData Name of the sequence.
protected StoreManager	storeManager Store Manager where we obtain our sequence.

Constructor Summary

SequenceImpl(PersistenceManager persistenceManager, StoreManager storeMgr, SequenceMetaData seqmd)
Constructor.

Method Summary

void	allocate(int additional) Method to allocate a set of elements.
java.lang.Object	current() Accessor for the current element.
long	currentValue() Accessor for the current element in the sequence as a long.
java.lang.String	getName() Accessor for the sequence name.
java.lang.Object	next() Accessor for the next element in the sequence.
long	nextValue() Accessor for the next element in the sequence as a long.

Methods inherited from class java.lang.Object

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

Field Detail

LOCALISER

protected static final Localiser LOCALISER

Localisation of messages

storeManager

protected final StoreManager storeManager

Store Manager where we obtain our sequence.

seqMetaData

protected final SequenceMetaData seqMetaData

Name of the sequence.

generator

protected final PoidGenerator generator

The generator for the sequence.

pm

protected final PersistenceManager pm

The controlling PersistenceManager.

Constructor Detail

SequenceImpl

public SequenceImpl(PersistenceManager persistenceManager,
                    StoreManager storeMgr,
                    SequenceMetaData seqmd)

Constructor.

Parameters:

persistenceManager - The PersistenceManager managing the sequence

storeMgr - Manager of the store where we obtain the sequence

seqmd - MetaData defining the sequence

Method Detail

getName

public java.lang.String getName()

Accessor for the sequence name.

Specified by:

getName in interface javax.jdo.datastore.Sequence

Returns:

The sequence name

allocate

public void allocate(int additional)

Method to allocate a set of elements.

Specified by:

allocate in interface javax.jdo.datastore.Sequence

Parameters:

additional - The number of additional elements to allocate

next

public java.lang.Object next()

Accessor for the next element in the sequence.

Specified by:

next in interface javax.jdo.datastore.Sequence

Returns:

The next element

nextValue

public long nextValue()

Accessor for the next element in the sequence as a long.

Specified by:

nextValue in interface javax.jdo.datastore.Sequence

Returns:

The next element

Throws:

javax.jdo.JDODataStoreException - Thrown if not numeric

current

public java.lang.Object current()

Accessor for the current element.

Specified by:

current in interface javax.jdo.datastore.Sequence

Returns:

The current element.

currentValue

public long currentValue()

Accessor for the current element in the sequence as a long.

Specified by:

currentValue in interface javax.jdo.datastore.Sequence

Returns:

The current element

Throws:

javax.jdo.JDODataStoreException - Thrown if not numeric