public class OdiSequence extends oracle.odi.domain.support.AbstractOdiEntity implements oracle.odi.domain.impexp.IExportable, IWorkDevelopmentOdiEntity, oracle.odi.impexp.smartie.ISmartExportable, ISequence, oracle.odi.core.audit.support.IAuditableFirstClassObject
OdiSequence class is the only member of OdiSequence aggregate, thus it is the
root entity and implements IOdiEntity
interface. An OdiSequence has an ID
that can be obtained from getSequenceId() method call. This ID is assigned
when an OdiSequence is stored in design time repository. This ID represents
the identity of an OdiSequence. Equals / hashCode method are implemented
according this identity.
There is two distinct scopes of OdiSequence: Global and Project.
Life cycle of an OdiSequence begins at design time when it is created from
constructor (Global Scope), from enclosing OdiProject
(Project Scope), or
when imported from external XML file. It is then typically stored inside ODI
design time repository. The users can modify it in order to make it fit their
needs. Life cycle ends when a user remove OdiSequence instance from design
time repository, or if enclosing OdiProject is removed (Project Scope). An
OdiSequence can be exported and imported. It implements the interface
IExportable
.
Modifier and Type | Class and Description |
---|---|
static class |
OdiSequence.SequenceType
Type of a sequence.
|
Constructor and Description |
---|
OdiSequence(OdiProject pProject,
java.lang.String pName,
java.lang.Integer pIncrementValue)
Construct a new
OdiSequence . |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getColumnName()
Returns the name of the column used by this sequence to store sequence
value.
|
java.lang.Integer |
getIncrementValue()
Returns increment value of this sequence.
|
java.io.Serializable |
getInternalId()
Provides a common getter for the persistence layer to obtain an identity,
irrespective of the actual type of identity used.
|
java.lang.String |
getLogicalSchemaName()
Returns the ODI logical schema name associated with this sequence.
|
java.lang.String |
getName()
Obtains the name of this sequence in ODI.
|
java.lang.String |
getNativeName()
Gets the native name of the sequence object, for NATIVE sequences.
|
java.lang.String |
getNativeSequenceName()
Returns native DB sequence's name.
|
OdiProject |
getProject()
Returns the
OdiProject instance for Project-Level sequences. |
java.lang.String |
getReferenceSubstitutionValue(java.lang.String refType)
Returns the code generator substitution value for the sequence when
it is referenced in an expression.
|
java.lang.String |
getRowFilter()
Deprecated.
Use
getRowFilterExpression() instead |
Expression |
getRowFilterExpression()
Returns SQL WHERE clause expression used to filter a single row from sequence table.
|
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
java.lang.Number |
getSequenceId()
Returns the ID of this sequence.
|
java.lang.String |
getSequenceType()
Gets the type of the sequence, it will be NATIVE, STANDARD, or SPECIFIC.
|
java.lang.String |
getTableName()
Returns name of the table used by this sequence.
|
OdiSequence.SequenceType |
getType()
Obtains the type of this sequence.
|
boolean |
isGlobal()
Returns whether this OdiSequence is global, or not
|
boolean |
isInstanceLevelSecurityNeeded()
Internal: this method is for internal purpose and must not be considered
as part of the public API.
|
void |
setColumnName(java.lang.String pColumnName)
Sets name of the column which will be used by this sequence to store
sequence.
|
void |
setIncrementValue(java.lang.Integer pIncrementValue)
Sets increment value for this sequence.
|
void |
setLogicalSchemaName(java.lang.String pLogicalSchemaName)
Sets the logical schema's name for this sequence.
|
void |
setName(java.lang.String pName)
Sets the name of this sequence.
|
void |
setNativeSequenceName(java.lang.String pNativeSequenceName)
Sets native DB sequence's name.
|
void |
setRowFilter(java.lang.String pRowFilter)
Deprecated.
Use
setRowFilterExpression(Expression) instead |
void |
setRowFilterExpression(Expression pSqlExpression)
Sets SQL WHERE clause expression used to filter single row from sequence table.
|
void |
setTableName(java.lang.String pTableName)
Sets name of the table which will be used by this sequence.
|
void |
setType(OdiSequence.SequenceType pType)
Sets the type of this sequence.
|
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isNew, preCommit, toString
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getFirstDate, getFirstUser, getLastDate, getLastUser
getGlobalId
getGlobalId, getNumericId
public OdiSequence(OdiProject pProject, java.lang.String pName, java.lang.Integer pIncrementValue)
OdiSequence
.
This constructor will initialize the project, name and incrementValue properties from the passed arguments.
Global sequence will be created in case if pProject
is
null
and project sequence otherwise.
pProject
- project this sequence belongs to.pName
- name for the sequence.pIncrementValue
- increment value.public java.lang.String getName()
getName
in interface IModelObject
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(String)
public void setName(java.lang.String pName)
pName
- name to set.getName()
public OdiSequence.SequenceType getType()
setType(SequenceType)
public void setType(OdiSequence.SequenceType pType)
pType
- type to set.getType()
public java.lang.String getLogicalSchemaName()
setLogicalSchemaName(String)
public void setLogicalSchemaName(java.lang.String pLogicalSchemaName)
pLogicalSchemaName
- logical schema's name to set.getLogicalSchemaName()
public java.lang.String getNativeSequenceName()
setNativeSequenceName(String)
public void setNativeSequenceName(java.lang.String pNativeSequenceName)
pNativeSequenceName
- native sequence's namegetNativeSequenceName()
public java.lang.Integer getIncrementValue()
setIncrementValue(Integer)
public void setIncrementValue(java.lang.Integer pIncrementValue)
pIncrementValue
- increment value to set.s_s
public java.lang.String getTableName()
setTableName(String)
public void setTableName(java.lang.String pTableName)
pTableName
- table's name to set.getTableName()
public java.lang.String getColumnName()
setColumnName(String)
public void setColumnName(java.lang.String pColumnName)
pColumnName
- column name to set.getColumnName()
@Deprecated public java.lang.String getRowFilter()
getRowFilterExpression()
insteadsetRowFilter(String)
@Deprecated public void setRowFilter(java.lang.String pRowFilter)
setRowFilterExpression(Expression)
insteadpRowFilter
- SQL WHERE clause to set.getRowFilter()
public void setRowFilterExpression(Expression pSqlExpression)
pSqlExpression
- SQL WHERE clause expression to set.getRowFilterExpression()
public Expression getRowFilterExpression()
setRowFilterExpression(Expression)
public java.lang.Number getSequenceId()
public java.io.Serializable getInternalId()
IRepositoryEntity
Typically a subclass will delegate to a public
SomePrimitiveWrapper getId()
method. The necessity for the
getInternalId()
abstract method is solely because the
persistence layer needs a way of obtaining the identity irrespective of
the actual identity implementation choice.
Returning null
from this method will indicate the object has
never been saved. This will likely be relied on by some DAO
implementations.
getInternalId
in interface IRepositoryEntity
public boolean isGlobal()
true
if this is sequence has Global Scope, false
otherwise
(i.e. Project Scope)public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public boolean isInstanceLevelSecurityNeeded()
IOdiEntity
Defines a method to capture the info on which object needs instance level privilege.
isInstanceLevelSecurityNeeded
in interface IOdiEntity
isInstanceLevelSecurityNeeded
in class oracle.odi.domain.support.AbstractOdiEntity
true
if instance level security needed,
false
otherwisepublic OdiProject getProject()
OdiProject
instance for Project-Level sequences.getProject
in interface ISequence
null
if this sequence' scopeg is Globalpublic java.lang.String getSequenceType()
ISequence
getSequenceType
in interface ISequence
public java.lang.String getNativeName()
ISequence
getNativeName
in interface ISequence
public java.lang.String getReferenceSubstitutionValue(java.lang.String refType)
ISequence
getReferenceSubstitutionValue
in interface ISequence
refType
- A character indicating the reference type, '#' for substitution and ':' for binding.