oracle.odi.domain.project

Class OdiSequence

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.support.AbstractOdiEntity

oracle.odi.domain.project.OdiSequence

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.odi.core.audit.support.IAuditableFirstClassObject, IModelObject, IModelObjectBase, IModelObjectWithLocation, ISequence, oracle.odi.domain.impexp.IExportable, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, oracle.odi.impexp.smartie.ISmartExportable

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

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.

• Global Scope OdiSequence are not bound to a given project and can be used in every interface.
• Project Scope OdiSequence are bound to a single OdiProject and can only be used inside interfaces of the same OdiProject.

Scope of an OdiSequence cannot be changed.

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.

Since:

11.1.1.3.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OdiSequence.SequenceType Type of a sequence.

Field Summary

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity

STARTING_INTERNAL_VERSION

Constructor Summary

Constructors

Constructor and Description
OdiSequence(OdiProject pProject, java.lang.String pName, java.lang.Integer pIncrementValue) Construct a new OdiSequence.

Method Summary

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.
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.

Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity

getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, isNew, preCommit, toString

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode

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

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Constructor Detail

OdiSequence

public OdiSequence(OdiProject pProject,
                   java.lang.String pName,
                   java.lang.Integer pIncrementValue)

Construct a new 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.

Parameters:

pProject - project this sequence belongs to.

pName - name for the sequence.

pIncrementValue - increment value.

Method Detail

getName

public java.lang.String getName()

Obtains the name of this sequence in ODI.

Specified by:

getName in interface IModelObject

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

this sequence's name

See Also:

setName(String)

setName

public void setName(java.lang.String pName)

Sets the name of this sequence.

Parameters:

pName - name to set.

See Also:

getName()

getType

public OdiSequence.SequenceType getType()

Obtains the type of this sequence.

Returns:

this sequence's type.

See Also:

setType(SequenceType)

setType

public void setType(OdiSequence.SequenceType pType)

Sets the type of this sequence.

Parameters:

pType - type to set.

See Also:

getType()

getLogicalSchemaName

public java.lang.String getLogicalSchemaName()

Returns the ODI logical schema name associated with this sequence. Isn't relevant if this sequence is an ODI standard sequence.

Returns:

this sequence's logical schema's name.

See Also:

setLogicalSchemaName(String)

setLogicalSchemaName

public void setLogicalSchemaName(java.lang.String pLogicalSchemaName)

Sets the logical schema's name for this sequence.

Parameters:

pLogicalSchemaName - logical schema's name to set.

See Also:

getLogicalSchemaName()

getNativeSequenceName

public java.lang.String getNativeSequenceName()

Returns native DB sequence's name. Only relevant for native sequences.

Returns:

native DB sequence's name.

See Also:

setNativeSequenceName(String)

setNativeSequenceName

public void setNativeSequenceName(java.lang.String pNativeSequenceName)

Sets native DB sequence's name. Only relevant for native sequences.

Parameters:

pNativeSequenceName - native sequence's name

See Also:

getNativeSequenceName()

getIncrementValue

public java.lang.Integer getIncrementValue()

Returns increment value of this sequence. Isn't relevant if this sequence is a native sequence.

Returns:

increment value

See Also:

setIncrementValue(Integer)

setIncrementValue

public void setIncrementValue(java.lang.Integer pIncrementValue)

Sets increment value for this sequence. Isn't relevant if this sequence is a native sequence.

Parameters:

pIncrementValue - increment value to set.

See Also:

s_s

getTableName

public java.lang.String getTableName()

Returns name of the table used by this sequence. Only relevant for user defined sequence.

Returns:

the table's name

See Also:

setTableName(String)

setTableName

public void setTableName(java.lang.String pTableName)

Sets name of the table which will be used by this sequence. Only relevant for user defined sequence.

Parameters:

pTableName - table's name to set.

See Also:

getTableName()

getColumnName

public java.lang.String getColumnName()

Returns the name of the column used by this sequence to store sequence value. Only relevant for user defined sequence.

Returns:

the column's name

See Also:

setColumnName(String)

setColumnName

public void setColumnName(java.lang.String pColumnName)

Sets name of the column which will be used by this sequence to store sequence.

Parameters:

pColumnName - column name to set.

See Also:

getColumnName()

getRowFilter

@Deprecated
public java.lang.String getRowFilter()

Deprecated. Use getRowFilterExpression() instead

Returns SQL WHERE clause used to filter a single row from sequence table. Only relevant for user defined sequence.

Returns:

the SQL WHERE clause

See Also:

setRowFilter(String)

setRowFilter

@Deprecated
public void setRowFilter(java.lang.String pRowFilter)

Deprecated. Use setRowFilterExpression(Expression) instead

Sets SQL WHERE clause used to filter single row from sequence table.

Parameters:

pRowFilter - SQL WHERE clause to set.

See Also:

getRowFilter()

setRowFilterExpression

public void setRowFilterExpression(Expression pSqlExpression)

Sets SQL WHERE clause expression used to filter single row from sequence table.

Parameters:

pSqlExpression - SQL WHERE clause expression to set.

Since:

11.1.1.6.0

See Also:

getRowFilterExpression()

getRowFilterExpression

public Expression getRowFilterExpression()

Returns SQL WHERE clause expression used to filter a single row from sequence table. Only relevant for user defined sequence.

Returns:

the SQL WHERE clause expression

Since:

11.1.1.6.0

See Also:

setRowFilterExpression(Expression)

getSequenceId

public java.lang.Number getSequenceId()

Returns the ID of this sequence.

Returns:

this sequence's ID

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IRepositoryEntity

Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

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.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

isGlobal

public boolean isGlobal()

Returns whether this OdiSequence is global, or not

Returns:

true if this is sequence has Global Scope, false otherwise (i.e. Project Scope)

isInstanceLevelSecurityNeeded

public boolean isInstanceLevelSecurityNeeded()

Description copied from interface: IOdiEntity

Internal: this method is for internal purpose and must not be considered as part of the public API.

Defines a method to capture the info on which object needs instance level privilege.

Specified by:

isInstanceLevelSecurityNeeded in interface IOdiEntity

Overrides:

isInstanceLevelSecurityNeeded in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

true if instance level security needed, false otherwise

getProject

public OdiProject getProject()

Returns the OdiProject instance for Project-Level sequences.

Specified by:

getProject in interface ISequence

Returns:

this sequence's project or null if this sequence' scopeg is Global

getSequenceType

public java.lang.String getSequenceType()

Description copied from interface: ISequence

Gets the type of the sequence, it will be NATIVE, STANDARD, or SPECIFIC.

Specified by:

getSequenceType in interface ISequence

Returns:

sequence type.

getNativeName

public java.lang.String getNativeName()

Description copied from interface: ISequence

Gets the native name of the sequence object, for NATIVE sequences.

Specified by:

getNativeName in interface ISequence

Returns:

the native name of a NATIVE sequence.

getReferenceSubstitutionValue

public java.lang.String getReferenceSubstitutionValue(java.lang.String refType)

Description copied from interface: ISequence

Returns the code generator substitution value for the sequence when it is referenced in an expression.

Specified by:

getReferenceSubstitutionValue in interface ISequence

Parameters:

refType - A character indicating the reference type, '#' for substitution and ':' for binding.

Returns:

the full substitution value to be inserted into the session or scenario task.