eBusiness Smart Components JumpStart: Class AlphaNumericSequencerImpl

Overview

Package

Class

Tree

Deprecated

Index

Help

bea Systems, Inc.

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

theory.smart.axiom.util
Class AlphaNumericSequencerImpl

java.lang.Object
  |
  +--theory.smart.foundation.EntityImpl
        |
        +--theory.smart.axiom.util.AlphaNumericSequencerImpl

Direct Known Subclasses:: AlphaNumericSequencerExtensionImpl

public class AlphaNumericSequencerImpl
extends EntityImpl

This class generates sequential identifiers in a prescribed format.. The user of the classs can configure the starting number, prefix, suffix, and step. It is also possible to specify the width of the numeric component. The current sequence number is persisted and access to the counter is controlled so that uniqueness can be guaranteed across all users of a given sequencer. It is used to generate unique keys for entities such as accounts, users, and sessions.

 Primary Key = theory.smart.axiom.util.AlphaNumericSequencerPk

See Also:: AlphaNumericSequencer, AlphaNumericSequencerHome, AlphaNumericSequencerValue, Serialized Form

Field Summary

int counter
           counter [AlphaNumericSequencer] <*>------> [int]

java.lang.String identifier
           identifier [AlphaNumericSequencer] <*>------> [String] (Primary Key)

int numDigits
           numDigits [AlphaNumericSequencer] <*>------> [int]

java.lang.String prefix
           prefix [AlphaNumericSequencer] <*>------> [String]

int step
           step [AlphaNumericSequencer] <*>------> [int]

java.lang.String suffix
           suffix [AlphaNumericSequencer] <*>------> [String]

Fields inherited from class theory.smart.foundation.EntityImpl

ctx, isDirty, isLoaded

Constructor Summary

AlphaNumericSequencerImpl()


Method Summary

void ejbActivate()
          ejbActivate method.

AlphaNumericSequencerPk ejbCreate(AlphaNumericSequencerPk alphaNumericSequencerPk)


protected void ejbCreateInitVars(AlphaNumericSequencerPk alphaNumericSequencerPk)


java.util.Enumeration ejbFindAll()


AlphaNumericSequencerPk ejbFindByPrimaryKey(AlphaNumericSequencerPk pk)


void ejbLoad()
          ejbLoad method.

void ejbPassivate()
          ejbPassivate method.

void ejbPostCreate(AlphaNumericSequencerPk alphaNumericSequencerPk)


void ejbRemove()
          ejbRemove method.

void ejbStore()
          ejbStore method.

AlphaNumericSequencerValue getAlphaNumericSequencerByValue()
          Get all of AlphaNumericSequencer's attributes.

int getCounter()
          Get the value of counter

java.lang.String getIdentifier()


java.lang.String getNextValue()
          This method returns the next value of the AlphaNumericSequencer.

int getNumDigits()
          Get the value of numDigits

java.lang.String getPrefix()
          Get the value of prefix

int getStep()
          Get the value of step

java.lang.String getSuffix()
          Get the value of suffix

java.lang.String getValue()
          This method returns the CURRENT value of the AlphaNumericSequencer.

void initialize(java.lang.String prefix, int numDigits, java.lang.String suffix, int start, int step)
          This is a short cut to initialize the sequencer

void setAlphaNumericSequencerByValue(AlphaNumericSequencerValue value)
          Set all of AlphaNumericSequencer's attributes to the passed in value.

void setCounter(int counter)
          Set the value of counter

void setEntityContext(EntityContext ctx)
          setEntityContext method.

void setNumDigits(int numDigits)
          Set the value of numDigits

void setPrefix(java.lang.String prefix)
          Set the value of prefix

void setStep(int step)
          Set the value of step

void setSuffix(java.lang.String suffix)
          Set the value of suffix

void unsetEntityContext()
          unsetEntityContext method.

Methods inherited from class theory.smart.foundation.EntityImpl

ejbCreate, ejbCreateInitVars, ejbPostCreate, getEntityContext, isModified

Methods inherited from class java.lang.Object

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

Field Detail

identifier

public java.lang.String identifier

                  identifier
 [AlphaNumericSequencer] <*>------> [String] (Primary Key)

prefix

public java.lang.String prefix

                  prefix
 [AlphaNumericSequencer] <*>------> [String]

numDigits

public int numDigits

                  numDigits
 [AlphaNumericSequencer] <*>------> [int]

suffix

public java.lang.String suffix

                  suffix
 [AlphaNumericSequencer] <*>------> [String]

step

public int step

                  step
 [AlphaNumericSequencer] <*>------> [int]

counter

public int counter

                  counter
 [AlphaNumericSequencer] <*>------> [int]

Constructor Detail

AlphaNumericSequencerImpl

public AlphaNumericSequencerImpl()
                          throws CreateException

Method Detail

getAlphaNumericSequencerByValue

public AlphaNumericSequencerValue getAlphaNumericSequencerByValue()
                                                           throws java.rmi.RemoteException

Get all of AlphaNumericSequencer's attributes.

Returns:: AlphaNumericSequencerValue the AlphaNumericSequencer value object

setAlphaNumericSequencerByValue

public void setAlphaNumericSequencerByValue(AlphaNumericSequencerValue value)
                                     throws java.rmi.RemoteException

Set all of AlphaNumericSequencer's attributes to the passed in value. Note: Primary key attributes are not set.

Parameters:: AlphaNumericSequencerValue - the AlphaNumericSequencer value object

ejbCreate

public AlphaNumericSequencerPk ejbCreate(AlphaNumericSequencerPk alphaNumericSequencerPk)
                                  throws CreateException,
                                         java.rmi.RemoteException

ejbCreateInitVars

protected void ejbCreateInitVars(AlphaNumericSequencerPk alphaNumericSequencerPk)
                          throws CreateException,
                                 java.rmi.RemoteException