oracle.odi.domain.project

Class OdiInterface.TargetDataStore

java.lang.Object

oracle.odi.domain.project.OdiInterface.TargetDataStore

All Implemented Interfaces:

IProcedureUser, IInterfaceSubComponent, IDataStore

Enclosing class:

OdiInterface

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 TargetColumns which are either the mirror of existing OdiColumns 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 OdiReferences, 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.

public class OdiInterface.TargetDataStore
extends java.lang.Object
implements IProcedureUser, IInterfaceSubComponent, IDataStore

Since:

11.1.1.3.0

Method Summary

Modifier and Type	Method and Description
void	addColumn(TargetColumn pTargetColumn, boolean pSetPosition, java.lang.Number pPosition) Deprecated. For internal use only Adds a new target column to this target datastore.
void	changeToTemporary() Deprecated. For internal use only Switches the datastore to a temporary datastore.
void	clearColumns() Deprecated. For internal use only On a temporary datastore only, deletes all target columns of the datastore.
OdiCKM	getCKM() Deprecated. Returns the Control Knowledge module associated to this OdiInterface.TargetDataStore instance.
java.util.List	getCKMOptions() Deprecated. Returns the list of options of the Control Knowledge module.
TargetColumn	getColumn(java.lang.String pColumnName) Deprecated. Obtains the column matching the given name.
java.util.List	getColumns() Deprecated. Obtains the columns owned by this data store.
OdiInterface.DatabaseSchema	getDatabaseSchema() Deprecated. Returns the DatabaseSchema (user schema, temporary schema, or existing schema) on which this temporary target datastore is located.
OdiInterface.CheckableFlowConstraint[]	getFlowConstraints() Deprecated. Returns a list of checkable flow constraints for the target datastore.
OdiContext	getForcedTargetContext() Deprecated. Returns the forced target context on the target datastore.
OdiIKM	getIKM() Deprecated. Returns the Integration Knowledge module associated to this OdiInterface.TargetDataStore instance.
java.util.List	getIKMOptions() Deprecated. Returns the list of options of the Integration knowledge module.
java.lang.Number	getInstanceId() Deprecated. Return the internal identifier of the instance that is marked by this interface.
java.io.Serializable	getInternalId() Deprecated. The internal ID of this sub component. Returning null from this method will indicate the object has never been persisted in the repository.
java.util.List	getInternalTargetColumns() Deprecated. This is intended for internal use only, DO NOT USE this method.
java.lang.String	getKeyName() Deprecated. Returns the name of the update key of the target datastore.
java.util.Collection	getKeys() Deprecated. This method in inherited from IDataStore, but is not relevant in this context, especially if the target datastore is a temporary datastore.
OdiLogicalSchema	getLogicalSchema() Deprecated. Returns the logical schema of the target datastore.
java.lang.Integer	getMaxIntegrationErrors() Deprecated. Returns the maximum integration errors allowed for this target datastore.
java.lang.String	getName() Deprecated. Obtains the name of this data store.
OdiInterface	getOdiInterface() Deprecated. Returns the parent interface owning this target datastore.
OdiPartition	getPartition() Deprecated. Returns the selected partition of this target datastore.
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.
OdiDataStore	getUnderlyingOdiDataStore() Deprecated. Returns the underlying real data store for the target of this interface.
OdiDataStore	getUnderlyingShortcutOdiDataStore() Deprecated. Returns the underlying shortcut tor the target of this interface.
IKey	getUnderlyingUpdateKey() Deprecated. Returns the underlying update key.
void	internalAddColumn(TargetColumn pTargetColumn) Deprecated. For internal use only.
boolean	isInstanceLevelSecurityNeeded() Deprecated. Internal: this method is for internal purpose and must not be considered as part of the public API.
boolean	isMaxIntegrationErrorsAsPercentage() Deprecated. Returns whether the maximum integration errors allowed for this target datastore is defined as a percentage.
boolean	isTemporaryDataStore() Deprecated. Returns whether the target datastore is temporary.
void	populatePersistedColumns() Deprecated. For internal use only Populates internal persistence objects from target columns.
void	removeColumn(TargetColumn pTargetColumn) Deprecated. For internal use only Removes an existing target column from this target datastore.
void	renameColumn(java.lang.String pOldName, java.lang.String pNewName) Deprecated. For internal use only Rename a target column.
void	resetLastPosition() Deprecated. For internal use only Resets the last position depending on the values of the positions for the columns in the table
void	setCKM(OdiCKM pOdiCKM) Deprecated. For internal use only Sets the Control Knowledge module associated to this OdiInterface.TargetDataStore instance.
void	setCKMToMissingReference(MapReference missingRef) Deprecated.
void	setDatabaseSchema(OdiInterface.DatabaseSchema pDatabaseSchema) Deprecated. For internal use only Set the DatabaseSchema which this temporary target datastore is located.
void	setDataStoreToMissingReference(MapReference missingRef) Deprecated.
void	setForcedTargetContext(OdiContext pForcedTargetContext) Deprecated. For internal use only Set the forced target context for this target datastore.
void	setIKM(OdiIKM pOdiIKM) Deprecated. For internal use only Sets the Integration Knowledge module associated to this OdiInterface.TargetDataStore instance.
void	setIKMToMissingReference(MapReference missingRef) Deprecated. For internal use only Set the Integration Knowledge module associated to a MapReference instance, this instance is a empty reference which stands for the Knowledge Module that no longer exist.
void	setKeyName(java.lang.String pKeyName) Deprecated. For internal use only Used by OdiInterfaceShortcutAdapter.
void	setMaxIntegrationErrors(java.lang.Integer pMaxIntegrationErrors) Deprecated. For internal use only Sets the maximum integration errors allowed for this target datastore.
void	setMaxIntegrationErrorsAsPercentage(boolean pMaxIntegrationErrorsAsPercentage) Deprecated. For internal use only Sets the flag to indicate that maximum integration errors allowed for this target datastore is defined as a percentage.
void	setPartition(OdiPartition pPartition) Deprecated. For internal use only Sets the partition of this target datastore.
void	setPartitionId(java.lang.Number pPartitionId) Deprecated. For internal use only
void	setTargCtxCode(java.lang.String pTargCtxCode) Deprecated. For internal use only
void	setUnderlyingOdiDataStore(OdiDataStore pTargetDataStore, java.util.List pTargetColumns) Deprecated. For internal use only Sets the underlying datastore and resets the list of columns with pTargetColumns. Resets the key name, sets the correct logical schema on the staging area if it's on the target. To modify an OdiInterface object or its children, please refer to the description of the class.
void	setUnderlyingScTable(OdiDataStore pScTarget) Deprecated. For internal use only
void	setUpdateKey(IKey pKey) Deprecated. For internal use only Sets the update key of the target datastore.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getUnderlyingOdiDataStore

public OdiDataStore getUnderlyingOdiDataStore()

Deprecated.

Returns the underlying real data store for the target of this interface.

Returns:

the OdiDataStore that will be used as the target if it is a real datastore, null otherwise

See Also:

setUnderlyingOdiDataStore(OdiDataStore, List)

getUnderlyingShortcutOdiDataStore

public OdiDataStore getUnderlyingShortcutOdiDataStore()

Deprecated.

Returns the underlying shortcut tor the target of this interface.

Returns:

the OdiDataStore that will be used as the target if it is a real datastore, null otherwise

See Also:

setUnderlyingOdiDataStore(OdiDataStore, List)

changeToTemporary

public void changeToTemporary()

Deprecated.

For internal use only Switches the datastore to a temporary datastore. To modify an OdiInterface object or its children, please refer to the description of the class.

setUnderlyingScTable

public void setUnderlyingScTable(OdiDataStore pScTarget)

Deprecated.

For internal use only

setUnderlyingOdiDataStore

public void setUnderlyingOdiDataStore(OdiDataStore pTargetDataStore,
                                      java.util.List pTargetColumns)

Deprecated.

For internal use only Sets the underlying datastore and resets the list of columns with pTargetColumns.
Resets the key name, sets the correct logical schema on the staging area if it's on the target.
To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pRealTarget - the real OdiDataStore which is to replace the current one

pTargetColumns - along with their mappings, and the caller must make sure that the mappings are attached to the right source tables etc.

See Also:

getUnderlyingOdiDataStore()

isInstanceLevelSecurityNeeded

public boolean isInstanceLevelSecurityNeeded()

Deprecated.

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.

Returns:

true if instance level security needed, false otherwise

renameColumn

public void renameColumn(java.lang.String pOldName,
                         java.lang.String pNewName)

Deprecated.

For internal use only Rename a target column. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pOldName - the column name we want to rename

pNewName - the new name for this column

isTemporaryDataStore

public boolean isTemporaryDataStore()

Deprecated.

Returns whether the target datastore is temporary.

Returns:

true if the target datastore is a temporary datastore, false otherwise

getForcedTargetContext

public OdiContext getForcedTargetContext()

Deprecated.

Returns the forced target context on the target datastore.

Returns:

the forced target context on the target datastore if it is set, null otherwise.

See Also:

setForcedTargetContext(OdiContext)

setForcedTargetContext

public void setForcedTargetContext(OdiContext pForcedTargetContext)

Deprecated.

For internal use only Set the forced target context for this target datastore. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pForcedTargetContext - the new forced target context

See Also:

getForcedTargetContext()

setTargCtxCode

public void setTargCtxCode(java.lang.String pTargCtxCode)

Deprecated.

For internal use only

getIKM

public OdiIKM getIKM()

Deprecated.

Returns the Integration Knowledge module associated to this OdiInterface.TargetDataStore instance.

Returns:

The Integration Knowledge module for this target datastore.

See Also:

OdiIKM, setIKM(OdiIKM)

setIKM

public void setIKM(OdiIKM pOdiIKM)

Deprecated.

For internal use only Sets the Integration Knowledge module associated to this OdiInterface.TargetDataStore instance. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pOdiIKM - the new IKM to be set

See Also:

OdiIKM, getIKM()

setIKMToMissingReference

public void setIKMToMissingReference(MapReference missingRef)

Deprecated.

For internal use only Set the Integration Knowledge module associated to a MapReference instance, this instance is a empty reference which stands for the Knowledge Module that no longer exist.

Parameters:

missingRef - The MapReference instance to set.

setCKMToMissingReference

public void setCKMToMissingReference(MapReference missingRef)

Deprecated.

setDataStoreToMissingReference

public void setDataStoreToMissingReference(MapReference missingRef)

Deprecated.

getIKMOptions

public java.util.List getIKMOptions()

Deprecated.

Returns the list of options of the Integration knowledge module.

Returns:

The list of IKM options.

See Also:

OdiIKM, IOptionValue

getCKM

public OdiCKM getCKM()

Deprecated.

Returns the Control Knowledge module associated to this OdiInterface.TargetDataStore instance.

Returns:

The Control Knowledge module for this target datastore.

See Also:

OdiCKM, setCKM(OdiCKM)

setCKM

public void setCKM(OdiCKM pOdiCKM)

Deprecated.

For internal use only Sets the Control Knowledge module associated to this OdiInterface.TargetDataStore instance. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pOdiCKM - the new CKM to set

See Also:

OdiCKM, getCKM()

getCKMOptions

public java.util.List getCKMOptions()

Deprecated.

Returns the list of options of the Control Knowledge module.

Returns:

The list of CKM options.

See Also:

OdiCKM, IOptionValue

getKeyName

public java.lang.String getKeyName()

Deprecated.

Returns the name of the update key of the target datastore.

Returns:

the update key's name

setKeyName

public void setKeyName(java.lang.String pKeyName)

Deprecated.

For internal use only Used by OdiInterfaceShortcutAdapter. Sets the current key name. This is called only when the column attribtues including the key indicator have been seperatly set.

Parameters:

pKeyName - Name of the new key

setUpdateKey

public void setUpdateKey(IKey pKey)

Deprecated.

For internal use only Sets the update key of the target datastore. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pKey - a new update key

Throws:

DomainRuntimeException - if pKey refers to a column name for which no column was found in the target datastore

getColumn

public TargetColumn getColumn(java.lang.String pColumnName)

Deprecated.

Obtains the column matching the given name.

Specified by:

getColumn in interface IDataStore

Parameters:

pColumnName - the name of the column to retrieve

Returns:

the column for the given name or null

See Also:

IDataStore.getColumn(java.lang.String)

getColumns

public java.util.List getColumns()

Deprecated.

Obtains the columns owned by this data store.

Specified by:

getColumns in interface IDataStore

Returns:

a list of columns. The returned list is typically unmodifiable.

See Also:

IDataStore.getColumns()

addColumn

public void addColumn(TargetColumn pTargetColumn,
                      boolean pSetPosition,
                      java.lang.Number pPosition)

Deprecated.

For internal use only Adds a new target column to this target datastore. Only valid if target is a temporary datastore. Additionally sets the position of the column, otherwise takes the position of the column to add it at the appropriate index. If pPosition is null, then if pSetPosition is set, the column is added at the end of the column list, otherwise nothing is done regarding positions. Note that pSetPosition and pPosition are ignored for non temporary target columns. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pTargetColumn - The target column to be added.

pSetPosition - if true the position attribute is set to the column, otherwise it is not set

pPosition - the desired position, null for auto position

internalAddColumn

public void internalAddColumn(TargetColumn pTargetColumn)

Deprecated.

For internal use only.

Parameters:

pTargetColumn -

removeColumn

public void removeColumn(TargetColumn pTargetColumn)

Deprecated.

For internal use only Removes an existing target column from this target datastore. Only valid if target is a temporary datastore. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pTargetColumn - the target column to be removed

populatePersistedColumns

public void populatePersistedColumns()

Deprecated.

For internal use only Populates internal persistence objects from target columns.

getKeys

public java.util.Collection getKeys()

Deprecated.

This method in inherited from IDataStore, but is not relevant in this context, especially if the target datastore is a temporary datastore. Therefore this method always returns null and is not implemented.

Specified by:

getKeys in interface IDataStore

Returns:

null.

getName

public java.lang.String getName()

Deprecated.

Description copied from interface: IDataStore

Obtains the name of this data store.

Specified by:

getName in interface IDataStore

Returns:

data store's name

See Also:

setName(String)

getUnderlyingUpdateKey

public IKey getUnderlyingUpdateKey()

Deprecated.

Returns the underlying update key.

Returns:

The underlying key object for the update key of this target datastore, or null if no such key is defined.

getLogicalSchema

public OdiLogicalSchema getLogicalSchema()

Deprecated.

Returns the logical schema of the target datastore.

Returns:

the logical schema on which the target datastore is located

getOdiInterface

public OdiInterface getOdiInterface()

Deprecated.

Returns the parent interface owning this target datastore.

Returns:

OdiInterface for which this is the target datastore.

getInstanceId

public java.lang.Number getInstanceId()

Deprecated.

Description copied from interface: IProcedureUser

Return the internal identifier of the instance that is marked by this interface. (e.g. OdiModel implementation of that method return the modelId).

Specified by:

getInstanceId in interface IProcedureUser

Returns:

the ODI instance id.

clearColumns

public void clearColumns()

Deprecated.

For internal use only On a temporary datastore only, deletes all target columns of the datastore. To modify an OdiInterface object or its children, please refer to the description of the class.

getInternalId

public java.io.Serializable getInternalId()

Deprecated.

Description copied from interface: IInterfaceSubComponent

The internal ID of this sub component.
Returning null from this method will indicate the object has never been persisted in the repository.

Specified by:

getInternalId in interface IInterfaceSubComponent

Returns:

the persistence identity of this instance

See Also:

IInterfaceSubComponent.getInternalId()

getPartition

public OdiPartition getPartition()

Deprecated.

Returns the selected partition of this target datastore.

Returns:

the partition of the target datastore that was selected

See Also:

setPartition(OdiPartition)

setPartition

public void setPartition(OdiPartition pPartition)

Deprecated.

For internal use only Sets the partition of this target datastore. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pPartition - new Partition

See Also:

getPartition()

setPartitionId

public void setPartitionId(java.lang.Number pPartitionId)

Deprecated.

For internal use only

getFlowConstraints

public OdiInterface.CheckableFlowConstraint[] getFlowConstraints()

Deprecated.

Returns a list of checkable flow constraints for the target datastore.

Returns:

the checkable flow constraints for the target datastore

getMaxIntegrationErrors

public java.lang.Integer getMaxIntegrationErrors()

Deprecated.

Returns the maximum integration errors allowed for this target datastore.

Returns:

the maximum integration errors allowed for this target datastore.

See Also:

setMaxIntegrationErrors(Integer)

isMaxIntegrationErrorsAsPercentage

public boolean isMaxIntegrationErrorsAsPercentage()

Deprecated.

Returns whether the maximum integration errors allowed for this target datastore is defined as a percentage.

Returns:

if true, getMaxIntegrationErrors() returns a percentage rather than an absolute value

See Also:

getMaxIntegrationErrors(), setMaxIntegrationErrorsAsPercentage(boolean)

setMaxIntegrationErrors

public void setMaxIntegrationErrors(java.lang.Integer pMaxIntegrationErrors)

Deprecated.

For internal use only Sets the maximum integration errors allowed for this target datastore. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pMaxIntegrationErrors - new value for MaxIntegrationErrors

See Also:

getMaxIntegrationErrors()

setMaxIntegrationErrorsAsPercentage

public void setMaxIntegrationErrorsAsPercentage(boolean pMaxIntegrationErrorsAsPercentage)

Deprecated.

For internal use only Sets the flag to indicate that maximum integration errors allowed for this target datastore is defined as a percentage. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pMaxIntegrationErrorsAsPercentage - new value for MaxIntegrationErrorsAsPercentage

See Also:

isMaxIntegrationErrorsAsPercentage()

getDatabaseSchema

public OdiInterface.DatabaseSchema getDatabaseSchema()

Deprecated.

Returns the DatabaseSchema (user schema, temporary schema, or existing schema) on which this temporary target datastore is located.

Returns:

the DatabaseSchema on which the target is located

See Also:

OdiInterface.DatabaseSchema, setDatabaseSchema(oracle.odi.domain.project.OdiInterface.DatabaseSchema)

setDatabaseSchema

public void setDatabaseSchema(OdiInterface.DatabaseSchema pDatabaseSchema)

Deprecated.

For internal use only Set the DatabaseSchema which this temporary target datastore is located. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pDatabaseSchema - new value for Database Schema

See Also:

getDatabaseSchema()

getSubComponentDescription

public java.lang.String getSubComponentDescription()

Deprecated.

Description copied from interface: IInterfaceSubComponent

Returns the sub component's description in a human-readable way.

Specified by:

getSubComponentDescription in interface IInterfaceSubComponent

Returns:

a human-readable String giving all necessary information to identify this component

getSubComponentDescription

public java.lang.String getSubComponentDescription(java.util.Locale pLocale)

Deprecated.

Description copied from interface: IInterfaceSubComponent

Returns the sub component's description in a human-readable way for the given Locale.

Specified by:

getSubComponentDescription in interface IInterfaceSubComponent

Parameters:

pLocale - the Locale for which the description should be returned

Returns:

a human-readable String giving all necessary information to identify this component in the given Locale

getInternalTargetColumns

public java.util.List getInternalTargetColumns()

Deprecated.

This is intended for internal use only, DO NOT USE this method.

Returns:

the raw list of target columns with no initializations

resetLastPosition

public void resetLastPosition()

Deprecated.

For internal use only Resets the last position depending on the values of the positions for the columns in the table