Provides the meta information about a ISequence configuring its operative behavior. More...

Inheritance diagram for Deveel.Data.Sql.Sequences.SequenceInfo:

Public Member Functions
	SequenceInfo (ObjectName sequenceName, SqlNumber startValue, SqlNumber increment, SqlNumber minValue, SqlNumber maxValue, long cache)
	Constructs a new object with the information given More...

	SequenceInfo (ObjectName sequenceName, SqlNumber startValue, SqlNumber increment, SqlNumber minValue, SqlNumber maxValue, bool cycle)
	Constructs a new object with the information given More...

	SequenceInfo (ObjectName sequenceName, SqlNumber startValue, SqlNumber increment, SqlNumber minValue, SqlNumber maxValue, long cache, bool cycle)
	Constructs a new object with the information given More...

Static Public Member Functions
static SequenceInfo	Native (ObjectName tableName)
	Creates an object that describes a native sequence for the table having the specified name. More...

Properties
DbObjectType IObjectInfo.	ObjectType `[get]`

ObjectName	SequenceName `[get, private set]`

ObjectName IObjectInfo.	FullName `[get]`

SequenceType	Type `[get, private set]`

SqlNumber	StartValue `[get, private set]`
	Gets the configured starting numeric value of a sequence. More...

SqlNumber	Increment `[get, private set]`
	Gets the configured incremental value, that is the value added to the current value of a sequence each time it advances. More...

SqlNumber	MinValue `[get, private set]`
	Gets the configured minimum value of the sequence. More...

SqlNumber	MaxValue `[get, private set]`
	Gets the configured maximum value of the sequence. More...

long	Cache `[get, private set]`
	Gets the number of items of the sequence to cache. More...

bool	Cycle `[get, private set]`
	Gets `true` if the sequence will cycle when it reaches either MinValue or MaxValue. More...

Properties inherited from Deveel.Data.Sql.IObjectInfo
DbObjectType	ObjectType `[get]`

ObjectName	FullName `[get]`

Private Member Functions
	SequenceInfo (ObjectName sequenceName, SequenceType sequenceType)

Detailed Description

Provides the meta information about a ISequence configuring its operative behavior.

See also: ISequence.SequenceInfo, ISequence

Definition at line 28 of file SequenceInfo.cs.

Constructor & Destructor Documentation

Deveel.Data.Sql.Sequences.SequenceInfo.SequenceInfo	(	ObjectName	sequenceName,
		SequenceType	sequenceType
	)

inlineprivate

Definition at line 29 of file SequenceInfo.cs.

                                                                                  {
             if (sequenceName == null)
                 throw new ArgumentNullException("sequenceName");
 
             SequenceName = sequenceName;
             Type = sequenceType;
         }

Deveel.Data.Sql.Sequences.SequenceInfo.SequenceInfo	(	ObjectName	sequenceName,
		SqlNumber	startValue,
		SqlNumber	increment,
		SqlNumber	minValue,
		SqlNumber	maxValue,
		long	cache
	)

inline

Constructs a new object with the information given

Parameters

sequenceName
startValue	The start value of the sequence
increment	The incremental value of the sequence, that is the value added to the current value of the sequence, each time it advances.
minValue	The minimum value of the sequence.
maxValue	The maximum value of the sequence.
cache	The number of items to cache.

Definition at line 47 of file SequenceInfo.cs.

48 : this(sequenceName, startValue, increment, minValue, maxValue, cache, true) {

49 }

Deveel.Data.Sql.Sequences.SequenceInfo.SequenceInfo	(	ObjectName	sequenceName,
		SqlNumber	startValue,
		SqlNumber	increment,
		SqlNumber	minValue,
		SqlNumber	maxValue,
		bool	cycle
	)

inline

Constructs a new object with the information given

Parameters

sequenceName
startValue	The start value of the sequence
increment	The incremental value of the sequence, that is the value added to the current value of the sequence, each time it advances.
minValue	The minimum value of the sequence.
maxValue	The maximum value of the sequence.
cycle	Indicates if the sequence must be cycled when it reaches the minimum or maximum value.

Definition at line 62 of file SequenceInfo.cs.

63 : this(sequenceName, startValue, increment, minValue, maxValue, 256, cycle) {

64 }

Deveel.Data.Sql.Sequences.SequenceInfo.SequenceInfo	(	ObjectName	sequenceName,
		SqlNumber	startValue,
		SqlNumber	increment,
		SqlNumber	minValue,
		SqlNumber	maxValue,
		long	cache,
		bool	cycle
	)

inline

Constructs a new object with the information given

Parameters

sequenceName
startValue	The start value of the sequence
increment	The incremental value of the sequence, that is the value added to the current value of the sequence, each time it advances.
minValue	The minimum value of the sequence.
maxValue	The maximum value of the sequence.
cache	The number of items to cache.
cycle	Indicates if the sequence must be cycled when it reaches the minimum or maximum value.

Definition at line 78 of file SequenceInfo.cs.

             : this(sequenceName, SequenceType.Normal) {
             StartValue = startValue;
             Increment = increment;
             MinValue = minValue;
             MaxValue = maxValue;
             Cache = cache;
             Cycle = cycle;
         }

Member Function Documentation

static SequenceInfo Deveel.Data.Sql.Sequences.SequenceInfo.Native ( ObjectName tableName )

inlinestatic

Creates an object that describes a native sequence for the table having the specified name.

Parameters

tableName

Returns

Definition at line 143 of file SequenceInfo.cs.

                                                                 {
             return new SequenceInfo(tableName, SequenceType.Native);
         }

Property Documentation

long Deveel.Data.Sql.Sequences.SequenceInfo.Cache

getprivate set

Gets the number of items of the sequence to cache.

Definition at line 127 of file SequenceInfo.cs.

bool Deveel.Data.Sql.Sequences.SequenceInfo.Cycle

getprivate set

Gets true if the sequence will cycle when it reaches either MinValue or MaxValue.

See also: MinValue, MaxValue

Definition at line 135 of file SequenceInfo.cs.

ObjectName IObjectInfo. Deveel.Data.Sql.Sequences.SequenceInfo.FullName

getprivate

Definition at line 94 of file SequenceInfo.cs.

SqlNumber Deveel.Data.Sql.Sequences.SequenceInfo.Increment

getprivate set

Gets the configured incremental value, that is the value added to the current value of a sequence each time it advances.

See also: ISequence.GetCurrentValue, ISequence.NextValue

Definition at line 111 of file SequenceInfo.cs.

SqlNumber Deveel.Data.Sql.Sequences.SequenceInfo.MaxValue

getprivate set

Gets the configured maximum value of the sequence.

See also: Cycle

Definition at line 122 of file SequenceInfo.cs.

SqlNumber Deveel.Data.Sql.Sequences.SequenceInfo.MinValue

getprivate set

Gets the configured minimum value of the sequence.

Definition at line 116 of file SequenceInfo.cs.

DbObjectType IObjectInfo. Deveel.Data.Sql.Sequences.SequenceInfo.ObjectType

getprivate

Definition at line 88 of file SequenceInfo.cs.

ObjectName Deveel.Data.Sql.Sequences.SequenceInfo.SequenceName

getprivate set

Definition at line 92 of file SequenceInfo.cs.

SqlNumber Deveel.Data.Sql.Sequences.SequenceInfo.StartValue

getprivate set

Gets the configured starting numeric value of a sequence.

Definition at line 103 of file SequenceInfo.cs.

SequenceType Deveel.Data.Sql.Sequences.SequenceInfo.Type

getprivate set

Definition at line 98 of file SequenceInfo.cs.

The documentation for this class was generated from the following file:

/var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Sql.Sequences/SequenceInfo.cs

Public Member Functions

Static Public Member Functions

Properties

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation