oracle.odi.domain.project.interfaces
Class TargetMapping

java.lang.Object
  oracle.odi.domain.support.BusinessObject
      oracle.odi.domain.support.AbstractRepositoryEntity
          oracle.odi.domain.project.interfaces.TargetMapping

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity, IInterfaceSubComponent, IOptionnallyPersistedObject

public class TargetMapping
extends oracle.odi.domain.support.AbstractRepositoryEntity
implements IInterfaceSubComponent, IOptionnallyPersistedObject

This class represents a mapping in an interface.
The mapping is in a dataset and has an execution location.
Created on 20 dec. 07

Since:

11.1.1.3.0

See Also:

Serialized Form

Constructor Summary

TargetMapping(DataSet pParentDataSet, TargetColumn pTargetColumn, Expression pSqlExpression, OdiInterface.ExecutionLocation pExecutionLocation)
Internal use only Builds a TargetMapping for a TargetColumn on a DataSet with a given SQL String expression.

TargetMapping(DataSet pParentDataSet, TargetColumn pTargetColumn, java.lang.String pSql, OdiInterface.ExecutionLocation pExecutionLocation)
Internal use only Builds a TargetMapping for a TargetColumn on a DataSet with a given SQL String expression.

Method Summary

SourceDataStore	getAttachedSourceDataStore() Returns the SourceDataStore to which this mapping is attached.
OdiInterface.ExecutionLocation	getExecutionLocation() Returns the execution location of this mapping.
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.
Expression	getNonPersistedSql() Returns the non persisted SQL expression for this mapping as an Expression. The difference with the getSqlExpression is that some cross-references (to journalized columns, for instance) will be present in this expression, whereas they are not present in the getSqlExpression (which is the expression as it will be persisted in the repository).
DataSet	getParentDataSet() Returns the parent DataSet of this mapping.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
SourceSet	getSourceSet() Returns the SourceSet to which this mapping is attached.
java.lang.String	getSql() Returns the SQL expression for this mapping as a String.
Expression	getSqlExpression() Obtains the SQL expression of this.
java.lang.Number	getSqlExpressionId() Returns the ID of the SQL Expression for this mapping.
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.
TargetColumn	getTargetColumn() Returns the TargetColumn to which this mapping is attached.
java.lang.String	getTechnicalDescription() Returns the technical description for this mapping. The technical description is a computed description from the SQL expression in which all column names are replaced with the column's descriptions. For instance, the expression "CUST.COMP_NAME" would be replaced with "CUST.Name of the company".
boolean	isPersisted() Returns whether this object should be persisted to the repository or not.
void	setAttachedSourceDataStore(SourceDataStore pSourceDataStore) Internal use only Sets the SourceDataStore to which this mapping should be attached.
void	setExecutionLocation(OdiInterface.ExecutionLocation pExecutionLocation) Internal use only Sets the execution location for this mapping.
void	setPersisted(boolean pPersisted) Internal use only Returns whether this object should be persisted to the repository or not.
void	setSourceSet(SourceSet pSourceSet) Internal use only Sets the source set to which this mapping should be attached.
void	setSqlExpression(Expression pExpression) Internal use only Sets the new SQL expression for this mapping.

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

clone

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetMapping

public TargetMapping(DataSet pParentDataSet,
                     TargetColumn pTargetColumn,
                     Expression pSqlExpression,
                     OdiInterface.ExecutionLocation pExecutionLocation)

Internal use only Builds a TargetMapping for a TargetColumn on a DataSet with a given SQL String expression.

Parameters:

pParentDataSet - the DataSet in which this mapping will be created

pTargetColumn - the TargetColumn for which this mapping will be created

pSqlExpression - the SQL mapping text as an Expression

pExecutionLocation - the ExecutionLocation of the mapping, should be SOURCE or WORK

TargetMapping

public TargetMapping(DataSet pParentDataSet,
                     TargetColumn pTargetColumn,
                     java.lang.String pSql,
                     OdiInterface.ExecutionLocation pExecutionLocation)

Internal use only Builds a TargetMapping for a TargetColumn on a DataSet with a given SQL String expression.

Parameters:

pParentDataSet - the DataSet in which this mapping will be created

pTargetColumn - the TargetColumn for which this mapping will be created

pSql - the SQL mapping text as a String

pExecutionLocation - the ExecutionLocation of the mapping, should be SOURCE or WORK

Method Detail

getAttachedSourceDataStore

public SourceDataStore getAttachedSourceDataStore()

Returns the SourceDataStore to which this mapping is attached.

Returns:

the SourceDataStore to which this mapping is attached

See Also:

setAttachedSourceDataStore(SourceDataStore)

getExecutionLocation

public OdiInterface.ExecutionLocation getExecutionLocation()

Returns the execution location of this mapping. It can only be SOURCE or WORK.

Returns:

the execution location of this mapping

See Also:

setExecutionLocation(OdiInterface.ExecutionLocation)

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 IRepositoryEntity

Specified by:

getInternalId in interface IInterfaceSubComponent

Returns:

the persistence identity of this instance

getNonPersistedSql

public Expression getNonPersistedSql()

Returns the non persisted SQL expression for this mapping as an Expression.
The difference with the getSqlExpression is that some cross-references (to journalized columns, for instance) will be present in this expression, whereas they are not present in the getSqlExpression (which is the expression as it will be persisted in the repository).

Returns:

the non persisted SQL expression for this mapping as an Expression

getParentDataSet

public DataSet getParentDataSet()

Returns the parent DataSet of this mapping.

Returns:

the parent DataSet of this mapping

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

container entity

getSourceSet

public SourceSet getSourceSet()

Returns the SourceSet to which this mapping is attached.

Returns:

the SourceSet to which this mapping is attached

See Also:

setSourceSet(SourceSet)

getSql

public java.lang.String getSql()

Returns the SQL expression for this mapping as a String.

Returns:

the SQL expression for this mapping as a String

getSqlExpression

public Expression getSqlExpression()

Obtains the SQL expression of this.

Returns:

the SQL expression for this mapping as an Expression

See Also:

setSqlExpression(Expression)

getSqlExpressionId

public java.lang.Number getSqlExpressionId()

Returns the ID of the SQL Expression for this mapping.

Returns:

the ID of the SQL Expression for this mapping

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

getTargetColumn

public TargetColumn getTargetColumn()

Returns the TargetColumn to which this mapping is attached.

Returns:

the TargetColumn to which this mapping is attached

getTechnicalDescription

public java.lang.String getTechnicalDescription()

Returns the technical description for this mapping.
The technical description is a computed description from the SQL expression in which all column names are replaced with the column's descriptions.
For instance, the expression "CUST.COMP_NAME" would be replaced with "CUST.Name of the company".

Returns:

the technical description for this mapping

isPersisted

public boolean isPersisted()

Returns whether this object should be persisted to the repository or not.

Specified by:

isPersisted in interface IOptionnallyPersistedObject

Returns:

true if this object should be persisted, false otherwise

See Also:

IOptionnallyPersistedObject.isPersisted(), setPersisted(boolean)

setAttachedSourceDataStore

public void setAttachedSourceDataStore(SourceDataStore pSourceDataStore)

Internal use only Sets the SourceDataStore to which this mapping should be attached.

Parameters:

pSourceDataStore - the SourceDataStore to which this mapping should be attached

See Also:

getAttachedSourceDataStore()

setExecutionLocation

public void setExecutionLocation(OdiInterface.ExecutionLocation pExecutionLocation)

Internal use only Sets the execution location for this mapping.

Parameters:

pExecutionLocation - the execution location of this mapping. Should not be null and can only be SOURCE or WORK.

See Also:

getExecutionLocation()

setPersisted

public void setPersisted(boolean pPersisted)

Internal use only Returns whether this object should be persisted to the repository or not.

Specified by:

setPersisted in interface IOptionnallyPersistedObject

Parameters:

pPersisted - true if this object should be persisted, false otherwise

See Also:

IOptionnallyPersistedObject.setPersisted(boolean), isPersisted()

setSourceSet

public void setSourceSet(SourceSet pSourceSet)

Internal use only Sets the source set to which this mapping should be attached.

Parameters:

pSourceSet - the source set to which this mapping should be attached

See Also:

getSourceSet()

setSqlExpression

public void setSqlExpression(Expression pExpression)

Internal use only Sets the new SQL expression for this mapping.

Parameters:

pExpression - the new SQL Expression for this mapping

See Also:

getSqlExpression()