|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.openjpa.meta.SequenceMetaData
public class SequenceMetaData
Metadata about a named sequence.
| Nested Class Summary | |
|---|---|
static interface |
SequenceMetaData.SequenceFactory
Allow facades to supply adapters from a spec sequence type to the OpenJPA sequence type. |
| Field Summary | |
|---|---|
static java.lang.String |
IMPL_NATIVE
Default plugin alias name; every back end should have some 'native' sequence implementation. |
static java.lang.String |
IMPL_TIME
Time-based sequence values. |
static java.lang.String |
NAME_SYSTEM
Sequence name that means to use the system default sequence. |
| Fields inherited from interface org.apache.openjpa.lib.meta.SourceTracker |
|---|
SRC_ANNOTATIONS, SRC_OTHER, SRC_XML |
| Fields inherited from interface org.apache.openjpa.lib.xml.Commentable |
|---|
EMPTY_COMMENTS |
| Constructor Summary | |
|---|---|
SequenceMetaData(java.lang.String name,
MetaDataRepository repos)
Constructor; supply sequence name. |
|
| Method Summary | |
|---|---|
protected void |
addStandardProperties(java.lang.StringBuffer props)
Add standard properties to the given properties buffer. |
protected void |
appendProperty(java.lang.StringBuffer props,
java.lang.String name,
int val)
Add an int property to the buffer. |
protected void |
appendProperty(java.lang.StringBuffer props,
java.lang.String name,
java.lang.String val)
Add a string property to the buffer. |
void |
close()
Close user sequence instance. |
int |
getAllocate()
Sequence values to allocate, or -1 for default. |
java.lang.String[] |
getComments()
|
int |
getIncrement()
Sequence increment, or -1 for default. |
int |
getInitialValue()
Initial sequence value, or -1 for default. |
Seq |
getInstance(java.lang.ClassLoader envLoader)
Return the initialized sequence instance. |
java.lang.String |
getName()
The sequence name. |
MetaDataRepository |
getRepository()
The owning repository. |
java.lang.String |
getResourceName()
|
java.lang.String |
getSequence()
Native sequence name. |
SequenceMetaData.SequenceFactory |
getSequenceFactory()
A factory to transform spec sequences produced by user factories into the OpenJPA sequence type. |
java.lang.String |
getSequencePlugin()
Plugin string describing the Seq. |
java.io.File |
getSourceFile()
|
java.lang.Object |
getSourceScope()
|
int |
getSourceType()
|
int |
getType()
The sequence type. |
protected Seq |
instantiate(java.lang.ClassLoader envLoader)
Create a new uninitialized instance of this sequence. |
protected PluginValue |
newPluginValue(java.lang.String property)
Create a new plugin value for sequences. |
void |
setAllocate(int allocate)
Sequence values to allocate, or -1 for default. |
void |
setComments(java.lang.String[] comments)
|
void |
setIncrement(int increment)
Sequence increment, or -1 for default. |
void |
setInitialValue(int initial)
Initial sequence value, or -1 for default. |
void |
setSequence(java.lang.String sequence)
Native sequence name. |
void |
setSequenceFactory(SequenceMetaData.SequenceFactory factory)
A factory to transform spec sequences produced by user factories into the OpenJPA sequence type. |
void |
setSequencePlugin(java.lang.String plugin)
Plugin string describing the Seq. |
void |
setSource(java.io.File file,
java.lang.Object scope,
int srcType)
|
void |
setType(int type)
The sequence type. |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String NAME_SYSTEM
public static final java.lang.String IMPL_NATIVE
public static final java.lang.String IMPL_TIME
| Constructor Detail |
|---|
public SequenceMetaData(java.lang.String name,
MetaDataRepository repos)
| Method Detail |
|---|
public MetaDataRepository getRepository()
getRepository in interface MetaDataContextpublic java.lang.String getName()
public java.io.File getSourceFile()
getSourceFile in interface SourceTrackerpublic java.lang.Object getSourceScope()
getSourceScope in interface SourceTrackerpublic int getSourceType()
getSourceType in interface SourceTracker
public void setSource(java.io.File file,
java.lang.Object scope,
int srcType)
public java.lang.String getResourceName()
getResourceName in interface SourceTrackerpublic int getType()
public void setType(int type)
public java.lang.String getSequence()
public void setSequence(java.lang.String sequence)
public int getIncrement()
public void setIncrement(int increment)
public int getAllocate()
public void setAllocate(int allocate)
public int getInitialValue()
public void setInitialValue(int initial)
public java.lang.String getSequencePlugin()
Seq.
public void setSequencePlugin(java.lang.String plugin)
Seq.
public SequenceMetaData.SequenceFactory getSequenceFactory()
public void setSequenceFactory(SequenceMetaData.SequenceFactory factory)
public Seq getInstance(java.lang.ClassLoader envLoader)
protected Seq instantiate(java.lang.ClassLoader envLoader)
protected PluginValue newPluginValue(java.lang.String property)
SeqValue by default.
protected void addStandardProperties(java.lang.StringBuffer props)
protected void appendProperty(java.lang.StringBuffer props,
java.lang.String name,
java.lang.String val)
protected void appendProperty(java.lang.StringBuffer props,
java.lang.String name,
int val)
public void close()
close in interface Closeablepublic java.lang.String toString()
toString in class java.lang.Objectpublic java.lang.String[] getComments()
getComments in interface Commentablepublic void setComments(java.lang.String[] comments)
setComments in interface Commentable
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||