|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.odi.domain.support.BusinessObject oracle.odi.domain.support.AbstractRepositoryEntity oracle.odi.domain.support.AbstractOdiEntity oracle.odi.domain.project.OdiSequence
public class OdiSequence
Represents design time metadata about a sequence.
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
.
Nested Class Summary | |
---|---|
static class |
OdiSequence.SequenceType
Type of an ODI Sequence. |
Field Summary |
---|
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Constructor Summary | |
---|---|
OdiSequence(OdiProject pProject,
java.lang.String pName,
java.lang.Integer pIncrementValue)
Construct a new OdiSequence . |
Method Summary | |
---|---|
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 |
getNativeSequenceName()
Returns native DB sequence's name. |
OdiProject |
getProject()
Returns the OdiProject instance for Project-Level sequences. |
java.lang.String |
getRowFilter()
Returns SQL WHERE clause 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 |
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)
Sets SQL WHERE clause 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. |
Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isNew, toString |
Methods inherited from class oracle.odi.domain.support.BusinessObject |
---|
clone |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.odi.domain.IOdiEntity |
---|
getFirstDate, getFirstUser, getLastDate, getLastUser |
Constructor Detail |
---|
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.Method Detail |
---|
public java.lang.String getColumnName()
setColumnName(String)
public java.lang.Integer getIncrementValue()
setIncrementValue(Integer)
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 java.lang.String getLogicalSchemaName()
setLogicalSchemaName(String)
public java.lang.String getName()
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(String)
public java.lang.String getNativeSequenceName()
setNativeSequenceName(String)
public OdiProject getProject()
OdiProject
instance for Project-Level sequences.
null
if this sequence' scopeg is Globalpublic java.lang.String getRowFilter()
setRowFilter(String)
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.lang.Number getSequenceId()
public java.lang.String getTableName()
setTableName(String)
public OdiSequence.SequenceType getType()
setType(SequenceType)
public boolean isGlobal()
true
if this is sequence has Global Scope, false
otherwise
(i.e. Project Scope)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 void setColumnName(java.lang.String pColumnName)
pColumnName
- column name to set.getColumnName()
public void setIncrementValue(java.lang.Integer pIncrementValue)
pIncrementValue
- increment value to set.getIncrementValue()
public void setLogicalSchemaName(java.lang.String pLogicalSchemaName)
pLogicalSchemaName
- logical schema's name to set.getLogicalSchemaName()
public void setName(java.lang.String pName)
pName
- name to set.getName()
public void setNativeSequenceName(java.lang.String pNativeSequenceName)
pNativeSequenceName
- native sequence's namegetNativeSequenceName()
public void setRowFilter(java.lang.String pRowFilter)
pRowFilter
- SQL WHERE clause to set.getRowFilter()
public void setTableName(java.lang.String pTableName)
pTableName
- table's name to set.getTableName()
public void setType(OdiSequence.SequenceType pType)
pType
- type to set.getType()
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |