org.axiondb

Class Sequence

java.lang.Object

org.axiondb.Sequence

All Implemented Interfaces:

java.io.Serializable

public class Sequence
extends java.lang.Object
implements java.io.Serializable

A database sequence. A sequence provides a mechanism for obtaining unique integer values from the database.

Note: If increment value is negative, then the sequence generator is a descending sequence generator; otherwise, it is an ascending sequence generator.

Note: The data type of a sequence generator must be exact numeric with scale 0.

Version:

$Revision: 1.15 $ $Date: 2007/11/13 19:04:02 $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	RADIX

Constructor Summary

Constructors

Constructor and Description
Sequence()
Sequence(java.lang.String name, DataType type, java.math.BigInteger startVal, java.math.BigInteger incrementBy, java.math.BigInteger maxValue, java.math.BigInteger minValue, boolean isCycle) Create a sequence with all ANSI 2003 parameters.
Sequence(java.lang.String name, int startVal) Create a sequence starting whose initial value is startVal .

Method Summary

Modifier and Type	Method and Description
void	addSequenceModificationListener(SequenceModificationListener listener)
boolean	equals(java.lang.Object otherobject) Returns true iff otherobject is a Sequencewhose name are equal to mine.
java.lang.Object	evaluate() Increment and return the next value in this sequence.
java.lang.Object	getCuurentValue()
DataType	getDataType()
java.math.BigInteger	getIncrementBy()
java.math.BigInteger	getMaxValue()
java.math.BigInteger	getMinValue()
java.lang.String	getName() Get the name of this sequence.
java.lang.Object	getValue() Get the current value of this sequence.
int	hashCode() Returns a hash code in keeping with the standard equals/ hashCodecontract.
boolean	isCycle()
void	read(java.io.DataInput in)
void	write(java.io.DataOutput out) Writes the given value to the given DataOutput.

Methods inherited from class java.lang.Object

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

Field Detail

RADIX

public static int RADIX

Constructor Detail

Sequence

public Sequence()

Sequence

public Sequence(java.lang.String name,
                DataType type,
                java.math.BigInteger startVal,
                java.math.BigInteger incrementBy,
                java.math.BigInteger maxValue,
                java.math.BigInteger minValue,
                boolean isCycle)

Create a sequence with all ANSI 2003 parameters.

Sequence

public Sequence(java.lang.String name,
                int startVal)

Create a sequence starting whose initial value is startVal .

Method Detail

addSequenceModificationListener

public void addSequenceModificationListener(SequenceModificationListener listener)

equals

public boolean equals(java.lang.Object otherobject)

Returns true iff otherobject is a Sequencewhose name are equal to mine.

Overrides:

equals in class java.lang.Object

evaluate

public java.lang.Object evaluate()
                          throws AxionException

Increment and return the next value in this sequence.

Throws:

AxionException

getCuurentValue

public java.lang.Object getCuurentValue()
                                 throws AxionException

Throws:

AxionException

getDataType

public DataType getDataType()

getIncrementBy

public java.math.BigInteger getIncrementBy()

getMaxValue

public java.math.BigInteger getMaxValue()

getMinValue

public java.math.BigInteger getMinValue()

getName

public java.lang.String getName()

Get the name of this sequence.

getValue

public java.lang.Object getValue()
                          throws AxionException

Get the current value of this sequence.

Throws:

AxionException

hashCode

public int hashCode()

Returns a hash code in keeping with the standard equals/ hashCodecontract.

Overrides:

hashCode in class java.lang.Object

isCycle

public boolean isCycle()

read

public void read(java.io.DataInput in)
          throws java.lang.Exception

Throws:

java.lang.Exception

See Also:

write(java.io.DataOutput)

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Writes the given value to the given DataOutput.

Parameters:

value - the value to write, which must be Sequence

Throws:

java.io.IOException