com.sequoiadb.base

Class DBSequence

java.lang.Object

com.sequoiadb.base.DBSequence

public class DBSequence
extends Object

Sequence of SequoiaDB

Method Summary

Modifier and Type	Method and Description
BSONObject	fetch(int fetchNum) Fetch a bulk of continuous values.
long	getCurrentValue() Get the current value of sequence.
String	getName()
long	getNextValue() Get the next value of sequence.
void	restart(long startValue) Restart sequence from the given value.
void	setAttributes(BSONObject options) Alter the sequence with the specified options.
void	setCurrentValue(long value) Set the current value to sequence.

Methods inherited from class java.lang.Object

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

Method Detail

fetch

public BSONObject fetch(int fetchNum)

Fetch a bulk of continuous values.

Parameters:

fetchNum - The number of values to be fetched

Returns:

A bson object that contains the following fields:

• NextValue(long) : The next value and also the first returned value.
• ReturnNum(int) : The number of values returned.
• Increment(int) : Increment of values.

getCurrentValue

public long getCurrentValue()

Get the current value of sequence.

Returns:

The current value

getName

public String getName()

Returns:

The name of current sequence

getNextValue

public long getNextValue()

Get the next value of sequence.

Returns:

The next value

restart

public void restart(long startValue)

Restart sequence from the given value.

Parameters:

startValue - The start value.

setAttributes

public void setAttributes(BSONObject options)

Alter the sequence with the specified options.

Parameters:

options - The options specified by user, details as bellow:

• CurrentValue(long) : The current value of sequence
• StartValue(long) : The start value of sequence
• MinValue(long) : The minimum value of sequence
• MaxValue(long) : The maxmun value of sequence
• Increment(int) : The increment value of sequence
• CacheSize(int) : The cache size of sequence
• AcquireSize(int) : The acquire size of sequence
• Cycled(boolean) : The cycled flag of sequence

setCurrentValue

public void setCurrentValue(long value)

Set the current value to sequence.

Parameters:

value - The expected current value