org.eclipse.datatools.modelbase.sql.schema
Interface IdentitySpecifier

All Superinterfaces:
SQLObject
All Known Implementing Classes:
IdentitySpecifierImpl

public interface IdentitySpecifier
extends SQLObject

A representation of the model object 'Identity Specifier'. 4.14.4 Identity columns The columns of a base table BT can optionally include not more than one identity column. The declared type of an identity column is either an exact numeric type with scale 0 (zero), INTEGER for example, or a distinct type whose source type is an exact numeric type with scale 0 (zero). An identity column has a start value, an increment, a maximum value, a minimum value, and a cycle option. An identity column is associated with an internal sequence generator SG. Let IC be the identity column of BT. When a row R is presented for insertion into BT, if R does not contain a column corresponding to IC, then the value V for IC in the row inserted into BT is obtained by applying the General Rules of Subclause 9.21, "Generation of the next value of a sequence generator", to SG. The definition of an identity column may specify GENERATED ALWAYS or GENERATED BY DEFAULT. NOTE 24: "Start value", "increment", "maximum value", "minimum value", and "cycle option" are defined in Subclause 4.21, "Sequence generators". NOTE 25: The notion of an internal sequence generator being associated with an identity column is used only for definitional purposes in this International Standard.

The following features are supported:

See Also:
SQLSchemaPackage.getIdentitySpecifier()

Method Summary
 GenerateType getGenerationType()
          Returns the value of the 'Generation Type' attribute.
 java.math.BigInteger getIncrement()
          Returns the value of the 'Increment' attribute.
 java.math.BigInteger getMaximum()
          Returns the value of the 'Maximum' attribute.
 java.math.BigInteger getMinimum()
          Returns the value of the 'Minimum' attribute.
 java.math.BigInteger getStartValue()
          Returns the value of the 'Start Value' attribute.
 boolean isCycleOption()
          Returns the value of the 'Cycle Option' attribute.
 void setCycleOption(boolean value)
          Sets the value of the 'Cycle Option' attribute.
 void setGenerationType(GenerateType value)
          Sets the value of the 'Generation Type' attribute.
 void setIncrement(java.math.BigInteger value)
          Sets the value of the 'Increment' attribute.
 void setMaximum(java.math.BigInteger value)
          Sets the value of the 'Maximum' attribute.
 void setMinimum(java.math.BigInteger value)
          Sets the value of the 'Minimum' attribute.
 void setStartValue(java.math.BigInteger value)
          Sets the value of the 'Start Value' attribute.
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.schema.SQLObject
addEAnnotation, addEAnnotationDetail, getDependencies, getDescription, getEAnnotation, getEAnnotationDetail, getLabel, removeEAnnotationDetail, setAnnotationDetail, setDescription, setLabel
 

Method Detail

getGenerationType

public GenerateType getGenerationType()
Returns the value of the 'Generation Type' attribute. The literals are from the enumeration GenerateType.

If the meaning of the 'Generation Type' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Generation Type' attribute.
See Also:
GenerateType, setGenerationType(GenerateType), SQLSchemaPackage.getIdentitySpecifier_GenerationType()

setGenerationType

public void setGenerationType(GenerateType value)
Sets the value of the 'Generation Type' attribute.

Parameters:
value - the new value of the 'Generation Type' attribute.
See Also:
GenerateType, getGenerationType()

getStartValue

public java.math.BigInteger getStartValue()
Returns the value of the 'Start Value' attribute.

If the meaning of the 'Start Value' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Start Value' attribute.
See Also:
setStartValue(BigInteger), SQLSchemaPackage.getIdentitySpecifier_StartValue()

setStartValue

public void setStartValue(java.math.BigInteger value)
Sets the value of the 'Start Value' attribute.

Parameters:
value - the new value of the 'Start Value' attribute.
See Also:
getStartValue()

getIncrement

public java.math.BigInteger getIncrement()
Returns the value of the 'Increment' attribute.

If the meaning of the 'Increment' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Increment' attribute.
See Also:
setIncrement(BigInteger), SQLSchemaPackage.getIdentitySpecifier_Increment()

setIncrement

public void setIncrement(java.math.BigInteger value)
Sets the value of the 'Increment' attribute.

Parameters:
value - the new value of the 'Increment' attribute.
See Also:
getIncrement()

getMinimum

public java.math.BigInteger getMinimum()
Returns the value of the 'Minimum' attribute.

If the meaning of the 'Minimum' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Minimum' attribute.
See Also:
setMinimum(BigInteger), SQLSchemaPackage.getIdentitySpecifier_Minimum()

setMinimum

public void setMinimum(java.math.BigInteger value)
Sets the value of the 'Minimum' attribute.

Parameters:
value - the new value of the 'Minimum' attribute.
See Also:
getMinimum()

getMaximum

public java.math.BigInteger getMaximum()
Returns the value of the 'Maximum' attribute.

If the meaning of the 'Maximum' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Maximum' attribute.
See Also:
setMaximum(BigInteger), SQLSchemaPackage.getIdentitySpecifier_Maximum()

setMaximum

public void setMaximum(java.math.BigInteger value)
Sets the value of the 'Maximum' attribute.

Parameters:
value - the new value of the 'Maximum' attribute.
See Also:
getMaximum()

isCycleOption

public boolean isCycleOption()
Returns the value of the 'Cycle Option' attribute.

If the meaning of the 'Cycle Option' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Cycle Option' attribute.
See Also:
setCycleOption(boolean), SQLSchemaPackage.getIdentitySpecifier_CycleOption()

setCycleOption

public void setCycleOption(boolean value)
Sets the value of the 'Cycle Option' attribute.

Parameters:
value - the new value of the 'Cycle Option' attribute.
See Also:
isCycleOption()


Copyright © 2006 Actuate, IBM Corporation, Sybase, Inc. and others. All rights reserved.