org.apache.openjpa.jdbc.schema
Class Sequence

java.lang.Object
  org.apache.openjpa.jdbc.schema.Sequence

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Sequence>, SourceTracker

public class Sequence
extends java.lang.Object
implements java.lang.Comparable<Sequence>, SourceTracker

Represents a database sequence.

Author:

Abe White

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.openjpa.lib.meta.SourceTracker

SRC_ANNOTATIONS, SRC_OTHER, SRC_XML

Constructor Summary

Sequence()
Default constructor.

Sequence(DBIdentifier name, Schema schema)

Sequence(java.lang.String name, Schema schema)
Deprecated.

Method Summary

int	compareTo(Sequence other)
void	deref()
int	getAllocate() The sequence's cache size.
int	getColNumber() Return the column number in the line of the file at which this instance was parsed.
DBIdentifier	getFullIdentifier()
java.lang.String	getFullName() Deprecated.
DBIdentifier	getIdentifier()
int	getIncrement() The sequence's increment.
int	getInitialValue() The sequence's initial value.
int	getLineNumber() Return the line number of the file at which this instance was parsed.
java.lang.String	getName() Deprecated.
QualifiedDBIdentifier	getQualifiedPath()
int	getRefCount()
java.lang.String	getResourceName() Return the domain-meaningful name of the resource that was loaded from this source.
Schema	getSchema() Return the schema for the sequence.
DBIdentifier	getSchemaIdentifier()
java.lang.String	getSchemaName() The sequence's schema name.
java.io.File	getSourceFile() Return the file from which this instance was parsed.
java.lang.Object	getSourceScope() Return the domain-dependent scope of this instance within its file.
int	getSourceType() Return the type of source.
void	ref()
void	setAllocate(int cache) The sequence's cache size.
void	setColNumber(int colNum)
void	setIdentifier(DBIdentifier name)
void	setIncrement(int increment) The sequence's increment.
void	setInitialValue(int initial) The sequence's initial value.
void	setLineNumber(int lineNum)
void	setName(java.lang.String name) Deprecated.
void	setSchemaIdentifier(DBIdentifier name)
void	setSchemaName(java.lang.String name) Deprecated.
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)

Deprecated.

Constructor.

Parameters:

name - the sequence name

schema - the sequence schema

Sequence

public Sequence(DBIdentifier name,
                Schema schema)

Method Detail

getSchema

public Schema getSchema()

Return the schema for the sequence.

getSchemaName

public java.lang.String getSchemaName()

The sequence's schema name.

getSchemaIdentifier

public DBIdentifier getSchemaIdentifier()

setSchemaName

public void setSchemaName(java.lang.String name)

Deprecated.

The sequence's schema name. You can only call this method on sequences whose schema object is not set.

setSchemaIdentifier

public void setSchemaIdentifier(DBIdentifier name)

getName

public java.lang.String getName()

Deprecated.

Return the name of the sequence.

getIdentifier

public DBIdentifier getIdentifier()

setName

public void setName(java.lang.String name)

Deprecated.

Set the name of the sequence. This method can only be called on sequences that are not part of a schema.

setIdentifier

public void setIdentifier(DBIdentifier name)

getFullName

public java.lang.String getFullName()

Deprecated.

Return the sequence name, including schema, using '.' as the catalog separator.

getFullIdentifier

public DBIdentifier getFullIdentifier()

getQualifiedPath

public QualifiedDBIdentifier getQualifiedPath()

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()

Description copied from interface: SourceTracker

Return the file from which this instance was parsed.

Specified by:

getSourceFile in interface SourceTracker

getSourceScope

public java.lang.Object getSourceScope()

Description copied from interface: SourceTracker

Return the domain-dependent scope of this instance within its file.

Specified by:

getSourceScope in interface SourceTracker

getSourceType

public int getSourceType()

Description copied from interface: SourceTracker

Return the type of source.

Specified by:

getSourceType in interface SourceTracker

setSource

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

getResourceName

public java.lang.String getResourceName()

Description copied from interface: SourceTracker

Return the domain-meaningful name of the resource that was loaded from this source. I.e., if we had loaded the source for a Java class, this would return the name of the class.

Specified by:

getResourceName in interface SourceTracker

compareTo

public int compareTo(Sequence other)

Specified by:

compareTo in interface java.lang.Comparable<Sequence>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLineNumber

public int getLineNumber()

Description copied from interface: SourceTracker

Return the line number of the file at which this instance was parsed.

Specified by:

getLineNumber in interface SourceTracker

setLineNumber

public void setLineNumber(int lineNum)

getColNumber

public int getColNumber()

Description copied from interface: SourceTracker

Return the column number in the line of the file at which this instance was parsed.

Specified by:

getColNumber in interface SourceTracker

setColNumber

public void setColNumber(int colNum)

getRefCount

public int getRefCount()

ref

public void ref()

deref

public void deref()