org.apache.openjpa.jdbc.schema
Class Sequence

java.lang.Object
  extended by org.apache.openjpa.jdbc.schema.Sequence
All Implemented Interfaces:
java.lang.Comparable, org.apache.openjpa.lib.meta.SourceTracker

public class Sequence
extends java.lang.Object
implements java.lang.Comparable, org.apache.openjpa.lib.meta.SourceTracker

Represents a database sequence.

Author:
Abe White

Field Summary
 
Fields inherited from interface org.apache.openjpa.lib.meta.SourceTracker
SRC_ANNOTATIONS, SRC_OTHER, SRC_XML
 
Constructor Summary
Sequence()
          Default constructor.
Sequence(java.lang.String name, Schema schema)
          Constructor.
 
Method Summary
 int compareTo(java.lang.Object other)
           
 void deref()
           
 int getAllocate()
          The sequence's cache size.
 java.lang.String getFullName()
          Return the sequence name, including schema, using '.' as the catalog separator.
 int getIncrement()
          The sequence's increment.
 int getInitialValue()
          The sequence's initial value.
 java.lang.String getName()
          Return the name of the sequence.
 int getRefCount()
           
 java.lang.String getResourceName()
           
 Schema getSchema()
          Return the schema for the sequence.
 java.lang.String getSchemaName()
          The sequence's schema name.
 java.io.File getSourceFile()
           
 java.lang.Object getSourceScope()
           
 int getSourceType()
           
 void ref()
           
 void setAllocate(int cache)
          The sequence's cache size.
 void setIncrement(int increment)
          The sequence's increment.
 void setInitialValue(int initial)
          The sequence's initial value.
 void setName(java.lang.String name)
          Set the name of the sequence.
 void setSchemaName(java.lang.String name)
          The sequence's schema name.
 void setSource(java.io.File source, int srcType)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Sequence

public Sequence()
Default constructor.


Sequence

public Sequence(java.lang.String name,
                Schema schema)
Constructor.

Parameters:
name - the sequence name
schema - the sequence schema
Method Detail

getSchema

public Schema getSchema()
Return the schema for the sequence.


getSchemaName

public java.lang.String getSchemaName()
The sequence's schema name.


setSchemaName

public void setSchemaName(java.lang.String name)
The sequence's schema name. You can only call this method on sequences whose schema object is not set.


getName

public java.lang.String getName()
Return the name of the sequence.


setName

public void setName(java.lang.String name)
Set the name of the sequence. This method can only be called on sequences that are not part of a schema.


getFullName

public java.lang.String getFullName()
Return the sequence name, including schema, using '.' as the catalog separator.


getInitialValue

public int getInitialValue()
The sequence's initial value.


setInitialValue

public void setInitialValue(int initial)
The sequence's initial value.


getIncrement

public int getIncrement()
The sequence's increment.


setIncrement

public void setIncrement(int increment)
The sequence's increment.


getAllocate

public int getAllocate()
The sequence's cache size.


setAllocate

public void setAllocate(int cache)
The sequence's cache size.


getSourceFile

public java.io.File getSourceFile()
Specified by:
getSourceFile in interface org.apache.openjpa.lib.meta.SourceTracker

getSourceScope

public java.lang.Object getSourceScope()
Specified by:
getSourceScope in interface org.apache.openjpa.lib.meta.SourceTracker

getSourceType

public int getSourceType()
Specified by:
getSourceType in interface org.apache.openjpa.lib.meta.SourceTracker

setSource

public void setSource(java.io.File source,
                      int srcType)

getResourceName

public java.lang.String getResourceName()
Specified by:
getResourceName in interface org.apache.openjpa.lib.meta.SourceTracker

compareTo

public int compareTo(java.lang.Object other)
Specified by:
compareTo in interface java.lang.Comparable

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getRefCount

public int getRefCount()

ref

public void ref()

deref

public void deref()


Copyright © 2006 Apache Software Foundation. All Rights Reserved.