oracle.javatools.db

Class AbstractIncrementer

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractIncrementer

All Implemented Interfaces:

DBObject, Copyable, DynamicPropertySet

Direct Known Subclasses:

IdentityColumnProperties, Sequence

public abstract class AbstractIncrementer
extends AbstractBuildableObject

Abstract superclass of Sequence to allow for other implementations that use a Sequence (or similar) but not as a SchemaObject to re-use these properties.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Constructor and Description
AbstractIncrementer()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	getCacheFlag() Returns TRUE if the sequence is cached, FALSE if it isn't, and null representing the database default.
java.math.BigInteger	getCacheSize() Retrieves the cache size for this sequence.
java.lang.Boolean	getCycleFlag() Retrieves whether this sequence should cycle back to the beginning when the last permissible value is reached.
java.math.BigInteger	getIncrementBy() Retrieves the increment value for this sequence.
java.math.BigInteger	getLastNumber() Retrieves the last sequence number written to disk in the database.
java.math.BigInteger	getMaxValue() Retrieves the maximum value for this sequence.
java.math.BigInteger	getMinValue() Retrieves the minimum value for this sequence.
java.lang.Boolean	getOrderFlag() Retrieves whether this sequence must generate values in order.
java.math.BigInteger	getStartWith() Retrieves the start with value for this sequence.
void	setCacheFlag(java.lang.Boolean cacheFlag) Sets whether this sequence caches sequence values.
void	setCacheSize(java.math.BigInteger cacheSize) Sets the cache size for this sequence.
void	setCycleFlag(java.lang.Boolean cycleFlag) Sets whether this sequence should cycle back to the beginning when the last permissible value is reached.
void	setIncrementBy(java.math.BigInteger incrementBy) Sets the increment value for this sequence.
void	setLastNumber(java.math.BigInteger lastNumber) Sets the last sequence number written to disk in the database.
void	setMaxValue(java.math.BigInteger maxValue) Sets the maximum value for this sequence.
void	setMinValue(java.math.BigInteger minValue) Sets the minimum value for this sequence.
void	setOrderFlag(java.lang.Boolean orderFlag) Sets whether this sequence must generate values in order.
void	setStartWith(java.math.BigInteger startWith) Sets the start with value for this sequence.

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, copyToImpl, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties, setProperty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.javatools.db.DBObject

getType

Constructor Detail

AbstractIncrementer

public AbstractIncrementer()

Method Detail

setStartWith

public void setStartWith(java.math.BigInteger startWith)

Sets the start with value for this sequence.

Parameters:

startWith - an BigInteger value representing the start value of this sequence, or null to omit the specification of a start value

getStartWith

public java.math.BigInteger getStartWith()

Retrieves the start with value for this sequence.

Returns:

an BigInteger value representing the start with value of this sequence, or null if the start with value is not specified

setMinValue

public void setMinValue(java.math.BigInteger minValue)

Sets the minimum value for this sequence.

Parameters:

minValue - an BigInteger value representing the minimum value of this sequence, or null to omit the specification of a minimum value

getMinValue

public java.math.BigInteger getMinValue()

Retrieves the minimum value for this sequence.

Returns:

an BigInteger value representing the minimum value of this sequence, or null if there is no minimum value.

setMaxValue

public void setMaxValue(java.math.BigInteger maxValue)

Sets the maximum value for this sequence.

Parameters:

maxValue - an BigInteger value representing the maximum value of this sequence, or null to omit the specification of a maximum value

getMaxValue

public java.math.BigInteger getMaxValue()

Retrieves the maximum value for this sequence.

Returns:

an BigInteger value representing the maximum value of this sequence, or null if there is no maximum value.

setIncrementBy

public void setIncrementBy(java.math.BigInteger incrementBy)

Sets the increment value for this sequence.

Parameters:

incrementBy - an BigInteger value representing the increment value of this sequence, or null to omit the specification of a increment value

getIncrementBy

public java.math.BigInteger getIncrementBy()

Retrieves the increment value for this sequence.

Returns:

an BigInteger value representing the increment value of this sequence, or null if the increment value is not specified

setCycleFlag

public void setCycleFlag(java.lang.Boolean cycleFlag)

Sets whether this sequence should cycle back to the beginning when the last permissible value is reached.

Parameters:

cycleFlag - a boolean value representing the cycle flag of this sequence, or null to omit the specification of a cycle flag

getCycleFlag

public java.lang.Boolean getCycleFlag()

Retrieves whether this sequence should cycle back to the beginning when the last permissible value is reached.

Returns:

a boolean value representing the cycle flag of this sequence, or null if the cycle flag is not specified

setOrderFlag

public void setOrderFlag(java.lang.Boolean orderFlag)

Sets whether this sequence must generate values in order.

Parameters:

orderFlag - a boolean value representing the order flag of this sequence, or null to omit the specification of a order flag

getOrderFlag

public java.lang.Boolean getOrderFlag()

Retrieves whether this sequence must generate values in order.

Returns:

a boolean value representing the order flag of this sequence, or null if the order flag is not specified

setCacheFlag

public void setCacheFlag(java.lang.Boolean cacheFlag)

Sets whether this sequence caches sequence values. A value of null represents the database default. When TRUE, setCacheSize() must be called with a minimum value of 2.

Parameters:

cached - : TRUE, FALSE or null

Since:

11.0

See Also:

setCacheSize(java.math.BigInteger)

getCacheFlag

public java.lang.Boolean getCacheFlag()

Returns TRUE if the sequence is cached, FALSE if it isn't, and null representing the database default.

Since:

11.0

setCacheSize

public void setCacheSize(java.math.BigInteger cacheSize)

Sets the cache size for this sequence. Only valid when getCacheFlag() is TRUE.

Parameters:

cacheSize - an BigInteger value representing the size of the cache used by this sequence, or null to omit the specification of cache size.

See Also:

getCacheFlag()

getCacheSize

public java.math.BigInteger getCacheSize()

Retrieves the cache size for this sequence. Only valid when getCacheFlag() is TRUE.

Returns:

a BigInteger value representing the size of the cache used by this sequence, or null if the cache size is not specified.

See Also:

getCacheFlag()

getLastNumber

public java.math.BigInteger getLastNumber()

Retrieves the last sequence number written to disk in the database. If a sequence uses caching, the number written to disk is the last number placed in the sequence cache. This number is likely to be greater than the last sequence number that was used.

This will only be populated if the sequence is retrieved from a live Database.

setLastNumber

public void setLastNumber(java.math.BigInteger lastNumber)

Sets the last sequence number written to disk in the database.