If an interface is constructed with a reference object, the interface will represented a shortcut to
the reference object. When an interface is used as a shortcut, most properties are accessed through
the base object. The IOdiShortcutable
interface implemented by OdiInterface provides
access and control over the shortcut aspects of this object.
This class is not intended to be used directly to create a consistent OdiInterface instance.
A consistent OdiInterface is an OdiInterface instance that would be executed as is without any consistency issues
regarding mappings, execution locations, etc. Creating a consistent OdiInterface
has to be done using 3d party tools
or classes that extend IInteractiveInterfaceHelper
such as InteractiveInterfaceHelperWithActions
.
This class is provided for internal use only, or for ODI consumers that want to read an existing OdiInterface instance.
Any direct changes to that class or any of its enclosing members from package oracle.odi.domain.project.interfaces
are strongly discouraged and without any guarantee. This may lead into unpredictable consistency issues.
StagingArea and TargetDataStore are non-nullable instances.
public class OdiInterface extends oracle.odi.domain.support.AbstractOdiEntity implements oracle.odi.domain.shortcuts.IOdiShortcutable, IOdiScenarioSource, IProcedureUser, IWorkDevelopmentOdiEntity, oracle.odi.domain.impexp.IExportable, IInterfaceSubComponent, IFlexFieldUser, oracle.odi.impexp.smartie.ISmartExportable
Modifier and Type | Class and Description |
---|---|
class |
OdiInterface.CheckableFlowConstraint
Deprecated.
this class/method belongs to 11g SDK and is deprecated in 12c release.
A constraint that can be checkable on the flow and potentially overriden in the interface.
Constraints include OdiKey s, OdiCondition s and OdiReference s.This class enables to manipulate the constraints and how they can be overridden in the interface. Note that as for all objects inside interfaces, you should use IInteractiveInterfaceHelper s to modify constraints. |
static class |
OdiInterface.ColumnSorterId
Deprecated.
this class/method belongs to 11g SDK and is deprecated in 12c release.
Sorter for TargetColumns by id.
|
static class |
OdiInterface.ColumnSorterPosition
Deprecated.
this class/method belongs to 11g SDK and is deprecated in 12c release.
Comparator used to sort TargetColumns by position.
|
static class |
OdiInterface.DatabaseSchema
Deprecated.
this class/method belongs to 11g SDK and is deprecated in 12c release.
The database schema on which the temporary target datastore is located.
|
static class |
OdiInterface.ExecutionLocation
Deprecated.
this class/method belongs to 11g SDK and is deprecated in 12c release.
The execution location for
Join , Filter , TargetMapping and TargetColumn expressions. |
class |
OdiInterface.StagingArea
Deprecated.
this class/method belongs to 11g SDK and is deprecated in 12c release.
Represents the staging area of the interface. It references a LKM, which
is used to load data from the staging area to the target data server
when the staging area is different from the target datastore.
|
class |
OdiInterface.TargetDataStore
Deprecated.
this class/method belongs to 11g SDK and is deprecated in 12c release.
Represents the target datastore of the interface, which may be either a temporary datastore or an underlying existing
OdiDataStore defined in an OdiModel .It is located on an OdiLogicalSchema , which is either deduced from the underlying OdiDataStore or either shared with the Staging Area for a temporary datastore.It contains TargetColumn s which are either the mirror of existing OdiColumn s from the underlying OdiDataStore , or either temporary target columns. Both are represented by the class TargetColumn .It has an update key, which is either taken from one of the underlying datastore's OdiReference s, either set using a TemporaryTargetUpdateKey .It references a CKM, which is used at runtime to check the data that is sent to the target. It references an IKM, which is used to actually integrate the data from the sources into the target datastore. |
Constructor and Description |
---|
OdiInterface(OdiFolder pFolder,
java.lang.String pName,
OdiContext pOptimizationContext)
Deprecated.
For internal use only
Creates a new interface.
|
OdiInterface(OdiFolder pFolder,
java.lang.String pName,
OdiContext pOptimizationContext,
IOdiEntityManager pEntityManager)
Deprecated.
For internal use only
Creates a new interface.
|
OdiInterface(OdiFolder pFolder,
java.lang.String pName,
OdiInterface pReferenceInterface,
OdiContext pOptimizationContext)
Deprecated.
|
OdiInterface(OdiFolder pFolder,
java.lang.String pName,
OdiInterface pReferenceInterface,
OdiContext pOptimizationContext,
java.lang.String pGuid)
Deprecated.
Creates a new interface.
|
Modifier and Type | Method and Description |
---|---|
void |
addDataSet(DataSet pDataSet)
Deprecated.
For internal use only
Add a new data set to the interface.
|
void |
addDataSet(DataSet pDataSet,
int pPosition)
Deprecated.
For internal use only
Add a new data set to the interface at the specified location.
|
void |
addObjTrace(ObjTrace pTrace)
Deprecated.
For internal use only
Add a new object trace to this interface.
|
boolean |
changeShortcutReferenceObject(OdiInterface pReferenceObject)
Deprecated.
|
void |
checkValidReference(OdiInterface pReferenceObject)
Deprecated.
|
void |
clearObjTraces()
Deprecated.
For internal use only
Removes all object traces from this interface.
|
static java.lang.String |
computeSQLWithHeaders(Expression pExpression,
DataSet pDataSet)
Deprecated.
Returns a String representing a more functional representation of
pExpression . |
java.util.List |
getDataSets()
Deprecated.
Returns a list of data sets of this interface, sorted by its position.
|
java.lang.String |
getDescription()
Deprecated.
Returns the description of this interface.
|
static java.lang.String |
getExecutionLocationDescription(OdiInterface.ExecutionLocation pExecutionLocation)
Deprecated.
Returns the textual string for the enum
OdiInterface.ExecutionLocation . |
java.util.Date |
getFirstDate()
Deprecated.
Provides a common getter to obtain the date of creation of this instance.
|
java.lang.String |
getFirstUser()
Deprecated.
Provides a common getter to obtain the name of the ODI user that created
this instance.
|
java.util.Collection |
getFlexFieldsValues()
Deprecated.
Obtains flex fields values related to this
IFlexFieldUser . |
OdiFolder |
getFolder()
Deprecated.
Returns the parent folder of this interface.
|
java.lang.String |
getGlobalId()
Deprecated.
Global ID is unique cross repositories.
|
java.lang.Number |
getInstanceId()
Deprecated.
Return the instance ID of this interface.
|
java.lang.Number |
getInterfaceId()
Deprecated.
Return the instance ID of this interface.
|
java.io.Serializable |
getInternalId()
Deprecated.
Provides a common getter for the persistence layer to obtain an identity,
irrespective of the actual type of identity used.
|
OdiInterface.TargetDataStore |
getInternalTargetDataStore()
Deprecated.
WARNING! This method is intended for internal use only.
|
int |
getInternalVersion()
Deprecated.
|
SourceDataStore |
getJournalizedDataStore(DataSet pDataSet)
Deprecated.
Return the source datastore that is set to be journalized in the
specified data set.
|
java.util.Date |
getLastDate()
Deprecated.
Provides a common getter to obtain the date of last modification of this
instance.
|
java.lang.String |
getLastUser()
Deprecated.
Provides a common getter to obtain the name of the last ODI user that
modified this instance.
|
java.lang.String |
getName()
Deprecated.
Returns the name of this interface.
|
java.util.List |
getObjTraces()
Deprecated.
Returns the list of object traces for this interface.
|
OdiContext |
getOptimizationContext()
Deprecated.
Returns the optimization context used when computing source sets for
this interface.
|
OdiInterface |
getRealObject()
Deprecated.
|
IReleaseTag |
getReleaseTag()
Deprecated.
|
IRepositoryEntity |
getSecurityContainer()
Deprecated.
Define a generic way to retrieve container for entities.
|
OdiInterface |
getShortcutBaseObject()
Deprecated.
|
OdiInterface |
getShortcutOrigObject()
Deprecated.
|
OdiInterface |
getShortcutReferenceObject()
Deprecated.
|
OdiInterface.StagingArea |
getStagingArea()
Deprecated.
Returns the Staging Area object for this interface.
|
MapPhysicalNode |
getStagingExecutionUnitAPNode()
Deprecated.
|
java.lang.String |
getSubComponentDescription()
Deprecated.
Returns the sub component's description in a human-readable way.
|
java.lang.String |
getSubComponentDescription(java.util.Locale pLocale)
Deprecated.
Returns the sub component's description in a human-readable way for the given Locale.
|
OdiInterface.TargetDataStore |
getTargetDataStore()
Deprecated.
Returns the target data store object of this interface.
|
OdiDataStore |
getUnderlyingShortcutTable()
Deprecated.
Returns the target data store shortcut of this interface, or
null for
a temporary interface. |
OdiDataStore |
getUnderlyingTable()
Deprecated.
Returns the target data store of this interface, or
null for
a temporary interface. |
boolean |
hasObjTrace()
Deprecated.
Returns whether there are any object traces for this interface.
|
void |
initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
Deprecated.
Initialize flex fields related to this
IFlexFieldUser . |
boolean |
internalPersistenceEquals(OdiInterface i2)
Deprecated.
For internal use only.
|
boolean |
isShortcut()
Deprecated.
|
void |
moveDataSet(DataSet pDataSet,
int pPosition)
Deprecated.
For internal use only
change the pos of specific.
|
void |
removeDataSet(DataSet pDataSet)
Deprecated.
For internal use only
Remove the specified data set from this interface.
|
void |
removeObjTrace(ObjTrace pTrace)
Deprecated.
For internal use only
Add an object trace from this interface.
|
void |
setDescription(java.lang.String pDescription)
Deprecated.
For internal use only
Set the description of the interface.
|
void |
setName(java.lang.String pName)
Deprecated.
For internal use only
Sets the name of this interface.
|
void |
setOptCtxCode(java.lang.String pOptCtxCode)
Deprecated.
For internal use only
|
void |
setOptimizationContext(OdiContext pOptimizationContext)
Deprecated.
For internal use only
Sets the optimization context for this interface.
|
boolean |
setShortcutBaseObject(OdiInterface pBaseObject)
Deprecated.
|
boolean |
setShortcutReferenceObject(OdiInterface pReferenceObject)
Deprecated.
|
void |
setUnderlyingTable(OdiDataStore pUnderlyingTable)
Deprecated.
not used, will be removed in next few label to avoid confusion.
Internal use only.
Sets the target data store of this interface, or |
equals, hashCode, isInstanceLevelSecurityNeeded, isNew, toString
isInstanceLevelSecurityNeeded
public OdiInterface(OdiFolder pFolder, java.lang.String pName, OdiInterface pReferenceInterface, OdiContext pOptimizationContext)
public OdiInterface(OdiFolder pFolder, java.lang.String pName, OdiInterface pReferenceInterface, OdiContext pOptimizationContext, java.lang.String pGuid)
pFolder
- the parent folder of this interfacepName
- the name,pReferenceInterface
- The reference interface if this is an interface shortcut.pOptimizationContext
- the optimization context of this interfacepublic OdiInterface(OdiFolder pFolder, java.lang.String pName, OdiInterface pReferenceInterface, OdiContext pOptimizationContext, boolean isInUpgrade, java.lang.String pGuid)
pFolder
- pName
- pReferenceInterface
- pOptimizationContext
- isInUpgrade
- public OdiInterface(OdiFolder pFolder, java.lang.String pName, OdiContext pOptimizationContext)
IInteractiveInterfaceHelper
such as InteractiveInterfaceHelperWithActions
to create interfaces.pFolder
- the parent folder of this interfacepName
- the name,pOptimizationContext
- the optimization context of this interfacepublic OdiInterface(OdiFolder pFolder, java.lang.String pName, OdiContext pOptimizationContext, IOdiEntityManager pEntityManager)
IInteractiveInterfaceHelper
such as InteractiveInterfaceHelperWithActions
to create interfaces.pFolder
- the parent folder of this interfacepName
- the name,pOptimizationContext
- the optimization context of this interfacepublic OdiInterface(OdiFolder pFolder, java.lang.String pName, OdiContext pOptimizationContext, OdiInterface.DatabaseSchema dSchema, java.lang.String pGuid)
pFolder
- pName
- pOptimizationContext
- dSchema
- 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
getInternalId
in interface IInterfaceSubComponent
IRepositoryEntity.getInternalId()
public java.lang.Number getInterfaceId()
public java.lang.String getName()
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(String)
public void setName(java.lang.String pName)
null
,
and the maximum name length is 400 characters.
To modify an OdiInterface
object or its children, please refer to
the description of the class.pName
- the new name for the interfacegetName()
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public OdiFolder getFolder()
public java.lang.String getDescription()
setDescription(String)
public void setDescription(java.lang.String pDescription)
OdiInterface
object or its children, please refer to
the description of the class.pDescription
- The new description for this interface.getDescription()
public OdiInterface.TargetDataStore getTargetDataStore()
java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public OdiInterface.TargetDataStore getInternalTargetDataStore()
public OdiContext getOptimizationContext()
setOptimizationContext(OdiContext)
public void setOptimizationContext(OdiContext pOptimizationContext)
OdiInterface
object or its children, please refer to
the description of the class.pOptimizationContext
- the new Optimization ContextgetOptimizationContext()
public void setOptCtxCode(java.lang.String pOptCtxCode)
optimization
- context codepublic java.util.List getDataSets()
java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public OdiInterface.StagingArea getStagingArea()
java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public void addDataSet(DataSet pDataSet)
OdiInterface
object or its children, please refer to
the description of the class.pDataSet
- The data set to be added.java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public void addDataSet(DataSet pDataSet, int pPosition)
OdiInterface
object or its children, please refer to
the description of the class.pDataSet
- The data set to be added.pPosition
- The position where the data set is to be added.java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public void removeDataSet(DataSet pDataSet)
OdiInterface
object or its children, please refer to
the description of the class.pDataSet
- The data set to be removed.java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public void moveDataSet(DataSet pDataSet, int pPosition)
OdiInterface
object or its children, please refer to
the description of the class.pDataSet
- The data set to be changed.pPosition
- The position where the data set is to be added.java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public SourceDataStore getJournalizedDataStore(DataSet pDataSet)
pDataSet
- The data set from which the journalized source is to
be retrieved.java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public java.lang.Number getInstanceId()
getInstanceId
in interface IProcedureUser
public void addObjTrace(ObjTrace pTrace)
OdiInterface
object or its children, please refer to
the description of the class.pTrace
- The new object trace to be added to this interface.java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public void removeObjTrace(ObjTrace pTrace)
OdiInterface
object or its children, please refer to
the description of the class.pTrace
- The object trace to be removed from this interface.java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public boolean hasObjTrace()
true
if there are object traces added to this
interface, false
otherwise.java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public void clearObjTraces()
OdiInterface
object or its children, please refer to
the description of the class.java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public java.util.List getObjTraces()
java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public static java.lang.String computeSQLWithHeaders(Expression pExpression, DataSet pDataSet)
pExpression
.
This is achieved by replacing all referenced column names by their "heading".pExpression
- the expression to processpDataSet
- the dataset in which the expression should be processedpublic java.lang.String getSubComponentDescription()
IInterfaceSubComponent
getSubComponentDescription
in interface IInterfaceSubComponent
public java.lang.String getSubComponentDescription(java.util.Locale pLocale)
IInterfaceSubComponent
getSubComponentDescription
in interface IInterfaceSubComponent
pLocale
- the Locale
for which the description should be returnedpublic static java.lang.String getExecutionLocationDescription(OdiInterface.ExecutionLocation pExecutionLocation)
OdiInterface.ExecutionLocation
.pExecutionLocation
- The desired execution location.OdiInterface.ExecutionLocation
.public OdiDataStore getUnderlyingShortcutTable()
null
for
a temporary interface.OdiDataStore
used as the target.java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public OdiDataStore getUnderlyingTable()
null
for
a temporary interface.OdiDataStore
used as the target.java.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public java.util.Collection getFlexFieldsValues()
IFlexFieldUser
.
In most implementations method initFlexFields(IOdiFlexFieldFinder)
should be
called before calling this method.getFlexFieldsValues
in interface IFlexFieldUser
public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
IFlexFieldUser
IFlexFieldUser
.initFlexFields
in interface IFlexFieldUser
pOdiFlexFieldFinder
- OdiFlexField
finder to be used to query flex fieldspublic boolean internalPersistenceEquals(OdiInterface i2)
i2
- true
if this interface is equal to i2public void setUnderlyingTable(OdiDataStore pUnderlyingTable)
Sets the target data store of this interface, or null
for
a temporary interface.
pUnderlyingTable
- enw underlying tablejava.lang.IllegalStateException
- if this is a shortcut. Use getRealObject to access.public OdiInterface getShortcutBaseObject()
getShortcutBaseObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public boolean setShortcutBaseObject(OdiInterface pBaseObject)
setShortcutBaseObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public OdiInterface getShortcutReferenceObject()
getShortcutReferenceObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public boolean setShortcutReferenceObject(OdiInterface pReferenceObject)
setShortcutReferenceObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public OdiInterface getShortcutOrigObject()
getShortcutOrigObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public boolean isShortcut()
isShortcut
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public IReleaseTag getReleaseTag()
getReleaseTag
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public OdiInterface getRealObject()
getRealObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public void checkValidReference(OdiInterface pReferenceObject)
checkValidReference
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public boolean changeShortcutReferenceObject(OdiInterface pReferenceObject)
changeShortcutReferenceObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public java.lang.String getGlobalId()
IRepositoryEntity
getGlobalId
in interface IRepositoryEntity
getGlobalId
in class oracle.odi.domain.support.AbstractRepositoryEntity
public java.lang.String getFirstUser()
IOdiEntity
When an instance of the subclass will be persisted, the current ODI user name will be saved on this instance in order to know which user created it. The value is set only if a real persist takes place (i.e. first persist).
getFirstUser
in interface IOdiEntity
getFirstUser
in class oracle.odi.domain.support.AbstractOdiEntity
public java.lang.String getLastUser()
IOdiEntity
When an instance of the subclass is persisted, the last user name is the same as the first user name.
When an instance of the subclass is merged, the current ODI user name will be saved on this instance in order to know which user modified it last. The value is set only if a real merge takes place (i.e. with real modifications).
getLastUser
in interface IOdiEntity
getLastUser
in class oracle.odi.domain.support.AbstractOdiEntity
public java.util.Date getFirstDate()
IOdiEntity
When an instance of the subclass is persisted, the current date in the underlying database is saved on this instance in order to know the creation date of this instance. The value is set only if a real persist takes place (i.e. first persist).
getFirstDate
in interface IOdiEntity
getFirstDate
in class oracle.odi.domain.support.AbstractOdiEntity
public java.util.Date getLastDate()
IOdiEntity
When an instance of the subclass is merged, the current date in the underlying database is saved on this instance in order to know the creation date of this instance. The value is set only if a real merge takes place (i.e. real modifications).
getLastDate
in interface IOdiEntity
getLastDate
in class oracle.odi.domain.support.AbstractOdiEntity
public int getInternalVersion()
getInternalVersion
in class oracle.odi.domain.support.AbstractOdiEntity
public MapPhysicalNode getStagingExecutionUnitAPNode() throws java.lang.Exception
java.lang.Exception