Extension SDK 9.0.5

oracle.jdeveloper.cm.ds.db
Class Sequence

java.lang.Object
  extended byoracle.jdeveloper.cm.ds.db.AbstractDBObject
      extended byoracle.jdeveloper.cm.ds.db.AbstractSchemaObject
          extended byoracle.jdeveloper.cm.ds.db.Sequence
All Implemented Interfaces:
Copyable, DBObject, SchemaObject, Subject

public class Sequence
extends AbstractSchemaObject

Model of a database sequence.


Field Summary
static java.lang.String TYPE
           
 
Fields inherited from interface oracle.jdeveloper.cm.ds.db.DBObject
COMMENT
 
Fields inherited from interface oracle.ide.addin.Subject
OBJECT_MODIFIED
 
Constructor Summary
Sequence()
          Constructs a new sequence.
Sequence(java.lang.String name, Schema schema)
          Constructs a new sequence in the specified schema with the specified name.
 
Method Summary
 java.lang.Object copyTo(java.lang.Object target)
          Copies the state of this DBObject to another instance.
protected  void copyToImpl(Sequence copy)
           
 boolean equals(java.lang.Object target)
           
protected  boolean equalsImpl(Sequence target)
           
 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 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.lang.String getType()
          Returns the type of this object.
 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 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.
 
Methods inherited from class oracle.jdeveloper.cm.ds.db.AbstractSchemaObject
copyToImpl, equalsImpl, getSchema, setSchema
 
Methods inherited from class oracle.jdeveloper.cm.ds.db.AbstractDBObject
attach, compareToImpl, copyToImpl, detach, equalsImpl, getID, getName, getProperties, getProperty, hashCode, notifyObservers, 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.jdeveloper.cm.ds.db.DBObject
getID, getName, getProperties, getProperty, setID, setName, setProperties, setProperty
 
Methods inherited from interface oracle.ide.addin.Subject
attach, detach, notifyObservers
 

Field Detail

TYPE

public static final java.lang.String TYPE
See Also:
Constant Field Values
Constructor Detail

Sequence

public Sequence()
Constructs a new sequence.


Sequence

public Sequence(java.lang.String name,
                Schema schema)
Constructs a new sequence in the specified schema with the specified name.

Parameters:
name - a string containing the name of the sequence
schema - the schema that owns the sequence
Method Detail

copyTo

public java.lang.Object copyTo(java.lang.Object target)
Description copied from interface: DBObject
Copies the state of this DBObject to another instance. If null is specified for the target, a new instance will be created.

The entire state of the object will be copied, with a few exceptions. In particular, any observers registered will NOT be copied. In cases where this instance contains child DBObjects, new instances of those children will be created, and the state copied to them. The copy will thus contain its own unique state; after making the copy, changing one instance will not cause any changes to occur to the copy. The properties will be copied; however, copies will not be made of the values referenced by the properties - thus, the copy will refer to the same instance as the original. Child objects that are copied will still point to the original parent; it is the responsibility of a copied parent to update the parent of copies of its children point to the copy of itself.

The ID associated with this object will not be copied. If the copy is intended to be a temporary copy of this object (to be used in a dialog editing the object for example), then the caller should explicitly set the ID of the copy to be the same as on this object. However, if the new object is intended to exist separately from this object, the caller should ensure that the new object have a different ID from this object.

Parameters:
target - The object to copy to. If target is null, a new instance will be created, and the state will be copied to that object.
Returns:
the copy.

equals

public boolean equals(java.lang.Object target)
Overrides:
equals in class AbstractDBObject

copyToImpl

protected void copyToImpl(Sequence copy)

equalsImpl

protected boolean equalsImpl(Sequence target)

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 the minimum value is not specified

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 the maximum value is not specified

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

setCacheSize

public void setCacheSize(java.math.BigInteger cacheSize)
Sets the cache size for this sequence.

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

getCacheSize

public java.math.BigInteger getCacheSize()
Retrieves the cache size for this sequence.

Returns:
an BigInteger value representing the size of the cache used by this sequence, or null if the cache size is not specified

getType

public java.lang.String getType()
Description copied from interface: DBObject
Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Returns:
a string describing the type of object.

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.