oracle.odi.domain.project
Class OdiInterface.StagingArea

java.lang.Object
  oracle.odi.domain.project.OdiInterface.StagingArea

All Implemented Interfaces:

oracle.odi.domain.procusage.IProcedureUser, IInterfaceSubComponent

Enclosing class:

OdiInterface

public class OdiInterface.StagingArea
extends java.lang.Object
implements oracle.odi.domain.procusage.IProcedureUser, IInterfaceSubComponent

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.

Since:

11.1.1.3.0

Method Summary

OdiLKM	getActualLKM() For internal use only Returns the actual LKM set for the staging area.
java.lang.Number	getInstanceId()
java.io.Serializable	getInternalId() The internal ID of this sub component. Returning null from this method will indicate the object has never been persisted in the repository.
OdiLKM	getLKM() Returns the Load Knowledge module associated to this OdiInterface.StagingArea instance.
java.util.List<IOptionValue>	getLKMOptions() Returns the list of options of the Load Knowledge module.
OdiLogicalSchema	getLogicalSchema() Returns the logical schema of the staging area.
java.lang.String	getSubComponentDescription() Returns the sub component's description in a human-readable way.
java.lang.String	getSubComponentDescription(java.util.Locale pLocale) Returns the sub component's description in a human-readable way for the given Locale.
boolean	isCommitOnWork() Returns the commit on work flag.
boolean	isDistinctRows() Returns the distinct rows setting for the staging area.
boolean	isOnTarget() Returns whether the staging area is located on the same logical schema as the target datastore.
void	setCommitOnWork(boolean pCommitOnWork) For internal use only Sets the commit on work flag.
void	setDistinctRows(boolean pDistinctRows) For internal use only Sets the distinct rows setting for the staging area.
void	setLKM(OdiLKM pLKM) For internal use only Sets the Load Knowledge module associated to this OdiInterface.StagingArea instance.
void	setLogicalSchema(OdiLogicalSchema pLogicalSchema) For internal use only Sets the logical schema of the staging area.
void	setOnTarget(boolean pIsOnTarget) For internal use only Sets whether the staging area is on the same logical schema as the target datastore.

Methods inherited from class java.lang.Object

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

Method Detail

getActualLKM

public OdiLKM getActualLKM()

For internal use only Returns the actual LKM set for the staging area. Use getLKM() instead.

Returns:

the actual LKM stored on the staging area

See Also:

getLKM()

getInstanceId

public java.lang.Number getInstanceId()

Specified by:

getInstanceId in interface oracle.odi.domain.procusage.IProcedureUser

getInternalId

public java.io.Serializable getInternalId()

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()

getLKM

public OdiLKM getLKM()

Returns the Load Knowledge module associated to this OdiInterface.StagingArea instance.

Returns:

The Load Knowledge module for this staging area.

See Also:

OdiLKM, setLKM(OdiLKM)

getLKMOptions

public java.util.List<IOptionValue> getLKMOptions()

Returns the list of options of the Load Knowledge module.

Returns:

The list of LKM options.

See Also:

OdiLKM, IOptionValue

getLogicalSchema

public OdiLogicalSchema getLogicalSchema()

Returns the logical schema of the staging area.

Returns:

The logical schema of the staging area.

See Also:

setLogicalSchema(OdiLogicalSchema)

getSubComponentDescription

public java.lang.String getSubComponentDescription()

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)

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

isCommitOnWork

public boolean isCommitOnWork()

Returns the commit on work flag. This is currently not used.

Returns:

The value of commit on work flag.

isDistinctRows

public boolean isDistinctRows()

Returns the distinct rows setting for the staging area. If true, only distinct rows will be used to load the target datastore.

Returns:

THe distinct rows setting for the staging area.

isOnTarget

public boolean isOnTarget()

Returns whether the staging area is located on the same logical schema as the target datastore.

Returns:

true if this is a temporary interface, or the staging area is located on the same logical schema as the target datastore.

setCommitOnWork

public void setCommitOnWork(boolean pCommitOnWork)

For internal use only Sets the commit on work flag. This flag is currently not used. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pCommitOnWork - new value for Commit On Work

setDistinctRows

public void setDistinctRows(boolean pDistinctRows)

For internal use only Sets the distinct rows setting for the staging area. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pDistinctRows - new value for distinct row setting.

setLKM

public void setLKM(OdiLKM pLKM)

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

Parameters:

pLKM - the new LKM

See Also:

OdiLKM, getLKM()

setLogicalSchema

public void setLogicalSchema(OdiLogicalSchema pLogicalSchema)

For internal use only Sets the logical schema of the staging area. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pLogicalSchema - the new Logical Schema

See Also:

getLogicalSchema()

setOnTarget

public void setOnTarget(boolean pIsOnTarget)

For internal use only Sets whether the staging area is on the same logical schema as the target datastore. To modify an OdiInterface object or its children, please refer to the description of the class.

Parameters:

pIsOnTarget - true if the staging area is on the same logical schema as the target datastore.