org.objectweb.jorm.facility.naming.rdbsequence
Class RdbSequenceHelper

java.lang.Object
  extended byorg.objectweb.jorm.facility.naming.rdbsequence.RdbSequenceHelper
Direct Known Subclasses:
RdbSequenceLongGen

public class RdbSequenceHelper
extends java.lang.Object

This helper permits to create and consult a RDB sequence. It requires a RdbAdapter.

Author:
S.Chassande-Barrioz

Constructor Summary
RdbSequenceHelper()
           
RdbSequenceHelper(RdbAdapter adapter, java.lang.String seqName, boolean sequenceCreated)
           
 
Method Summary
 boolean allocateHint(java.lang.Object c, int numberOfNextVal)
           
 long allocateId(java.lang.Object c)
           
 boolean createSequence(java.lang.Object c)
          Create the sql sequence on the relational database
 RdbAdapter getAdapter()
           
 Logger getLogger()
           
 java.lang.Integer getSequenceCache()
           
 java.lang.Integer getSequenceIncrement()
           
 java.lang.String getSequenceName()
           
 java.lang.Integer getSequenceStart()
           
 boolean isSequenceCreated()
           
 void setAdapter(RdbAdapter adapter)
           
 void setLogger(Logger logger)
           
 void setSequenceCache(java.lang.Integer seqCache)
           
 void setSequenceCreated(boolean sequencecreated)
           
 void setSequenceIncrement(java.lang.Integer seqIncrement)
           
 void setSequenceName(java.lang.String seqName)
           
 void setSequenceStart(java.lang.Integer seqStart)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RdbSequenceHelper

public RdbSequenceHelper()

RdbSequenceHelper

public RdbSequenceHelper(RdbAdapter adapter,
                         java.lang.String seqName,
                         boolean sequenceCreated)
Parameters:
adapter - is the Rdb Adapter permitting to choose the SQL syntax corresponding to the relational database. (not null)
seqName - is the sequence name (not null)
Method Detail

setSequenceCreated

public void setSequenceCreated(boolean sequencecreated)

isSequenceCreated

public boolean isSequenceCreated()

setSequenceName

public void setSequenceName(java.lang.String seqName)

getSequenceName

public java.lang.String getSequenceName()

getAdapter

public RdbAdapter getAdapter()

setAdapter

public void setAdapter(RdbAdapter adapter)

getSequenceStart

public java.lang.Integer getSequenceStart()

setSequenceStart

public void setSequenceStart(java.lang.Integer seqStart)

getSequenceIncrement

public java.lang.Integer getSequenceIncrement()

setSequenceIncrement

public void setSequenceIncrement(java.lang.Integer seqIncrement)

getSequenceCache

public java.lang.Integer getSequenceCache()

setSequenceCache

public void setSequenceCache(java.lang.Integer seqCache)

getLogger

public Logger getLogger()

setLogger

public void setLogger(Logger logger)

createSequence

public boolean createSequence(java.lang.Object c)
                       throws PException
Create the sql sequence on the relational database

Parameters:
c - is the connection for the acces to the database
Returns:
true if the sequence has been create, false if the sequence already exists.
Throws:
PException - if an error occurs during the SQL request

allocateId

public long allocateId(java.lang.Object c)
                throws PException
Throws:
PException

allocateHint

public boolean allocateHint(java.lang.Object c,
                            int numberOfNextVal)
                     throws PException
Throws:
PException