Skip navigation links

oracle.odi.domain.project.interfaces
Class TargetColumn

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity, IInterfaceSubComponent, IOptionnallyPersistedObject, OdiInterface.IPersistenceComparable<TargetColumn>, IColumn<OdiInterface.TargetDataStore>

public class TargetColumn

extends oracle.odi.domain.support.AbstractRepositoryEntity

implements IInterfaceSubComponent, IColumn<OdiInterface.TargetDataStore>, IOptionnallyPersistedObject, OdiInterface.IPersistenceComparable<TargetColumn>

A target column is a column of a OdiInterface.TargetDataStore in an OdiInterface.
It contains information about how the column is mapped (indicators, potentially a target SQL mapping text).
When the target datastore has an underlying OdiDataStore, each TargetMapping points to one OdiColumn of this OdiDataStore.
In this case, TargetColumns are persisted according to an IMappingPersistencePolicy for obvious performance reasons (on a target datastore with 500 columns on which only 10 columns are mapped, this can make a difference).
On temporary target datastores, target columns do not reflect an OdiColumn and are systematically persisted.
Note that all setters in this class should not be used directly. To create, modify or delete a target column of an OdiInterface, use IInterfaceActions on an IInteractiveInterfaceHelperWithActions.

Since:

11.1.1.3.0

See Also:

OdiInterface.TargetDataStore, TargetMapping, IMappingPersistencePolicy, Serialized Form

Constructor Summary

TargetColumn(OdiInterface pParentInterface, OdiColumn pRealColumn, OdiInterface.ExecutionLocation pExecutionLocation)
Internal use only Creates a new target column object.

TargetColumn(OdiInterface pParentInterface, OdiInterface.ExecutionLocation pExecutionLocation)
Internal use only Creates a new target column object.

TargetColumn(OdiInterface pParentInterface, java.lang.String pName, OdiInterface.ExecutionLocation pExecutionLocation)
Internal use only Creates a new target column object.

Method Summary

void	addTargetMapping(TargetMapping pTargetMapping) Internal use only Adds a target mapping to this target column.
void	changeToTemporaryColumn() Internal use only Modifies an existing target column for use when the target datastore is changed to temporary.
java.lang.String	getBusinessRule() Returns the business rule of this target column. The business rule is a custom functional description of what this column represents.
OdiDataType	getDataType() Returns the datatype of this target column.
OdiInterface.ExecutionLocation	getExecutionLocation() Returns the location of the execution of the mapping, if any. If no mapping is set for this target column, null is returned. If this column is mapped on the target then OdiInterface.ExecutionLocation.TARGET is returned. If this column is mapped on the Staging Area or on Source, then null is returned, you will need to fetch the execution location for each DataSet on the corresponding TargetMappings, either by fetching them from getTargetMappings() either from DataSet.getMapping(String).
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.
java.lang.Integer	getInternalLength() Returns the length of the column. Unlike getLength(), this method will return null rather than throwing an exception if the length is not allowed.
java.lang.Integer	getInternalScale() Returns the scale of the column. Unlike getScale(), this method will return null rather than throwing an exception if the scale is not allowed.
java.lang.Integer	getLength() Returns the length of the column. If the datatype is not set or doesn't allow length, a call to this method will cause an IllegalStateException.
java.lang.String	getName() Returns the name of the target column.
Expression	getNonPersistedSql() Returns the non persisted expression on this target column. The difference between the persisted and non persisted versions lie in the cross-references, as some cross-references are not persisted in the repository.
OdiInterface	getParentInterface() Returns the parent interface of this target column.
java.lang.Integer	getPosition() Getter for the column's position.
java.lang.Integer	getScale() Returns the scale of the column. If the datatype is not set or doesn't allow scale, a call to this method will cause an IllegalStateException.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
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.
OdiInterface.TargetDataStore	getTable() Returns the target datastore of the interface owning this target column.
java.lang.Number	getTargetColumnId() Returns the target column's ID in the repository.
java.util.Collection<TargetMapping>	getTargetMappings() Returns all target mappings for this target column. When the target column is mapped and is not executed on TARGET, then there is one mapping for each DataSet.
java.lang.String	getTargetSql() Returns the target mapping as a String for mappings executed on the target.
Expression	getTargetSqlMappingExpression() When the mapping on this TargetColumn is executed on TARGET, obtains the SQL mapping for this column.
java.lang.Number	getTargetSqlMappingExpressionId() Returns the ID of the target expression for the mapping when executed on the target.
OdiColumn	getUnderlyingOdiColumn() The underlying OdiColumn. If the TargetDataStore is a temporary datastore, null is returned as there is no underlying OdiColumn.
void	initializeMappingsFromPersisted() Internal use only Initialize internal persistence mapping.
boolean	internalPersistenceEquals(TargetColumn t2) Returns true if this instance is equal to i2 in terms of persisted fields only
boolean	isCheckNotNullIndicator() If true then the column will be checked for not null during the loading of the data in the target datastore. For this to happen, you need to have a CKM defined on the interface and to make sure that the IKM is enabled for flow control (please refer to the documentation of the IKM). Additionally, you may want to make sure that flow control and/or static control are enabled on the OdiColumn in the model if the datastore is not temporary.
boolean	isEnable() Returns whether this target column is mapped or not.
boolean	isInsertIndicator() Returns whether this column is tagged for insert.
boolean	isModified()
boolean	isPersisted() Returns whether this object should be persisted in the repository or not.
boolean	isTemporaryColumn() Returns whether this is a temporary column. true means that this column has no underlying OdiColumn.
boolean	isUpdateIndicator() Returns whether this column is tagged for update.
boolean	isUpdateKeyIndicator() Returns whether this column will be used as key when doing updates on the target datastore.
boolean	isUserDefinedIndicator1() Returns whether this column has the User Defined Indicator 1 set.
boolean	isUserDefinedIndicator10() Returns whether this column has the User Defined Indicator 10 set.
boolean	isUserDefinedIndicator2() Returns whether this column has the User Defined Indicator 2 set.
boolean	isUserDefinedIndicator3() Returns whether this column has the User Defined Indicator 3 set.
boolean	isUserDefinedIndicator4() Returns whether this column has the User Defined Indicator 1 set.
boolean	isUserDefinedIndicator5() Returns whether this column has the User Defined Indicator 5 set.
boolean	isUserDefinedIndicator6() Returns whether this column has the User Defined Indicator 6 set.
boolean	isUserDefinedIndicator7() Returns whether this column has the User Defined Indicator 7 set.
boolean	isUserDefinedIndicator8() Returns whether this column has the User Defined Indicator 8 set.
boolean	isUserDefinedIndicator9() Returns whether this column has the User Defined Indicator 9 set.
void	populatePersistedMappings() Internal use only Populate internal persistence mapping.
void	removeTargetMapping(TargetMapping pTargetMapping) Internal use only Removes a target mapping from this target column.
void	resetLength() Internal use only Resets the length value to 0.
void	resetScale() Internal use only Resets the scale value to 0.
void	setBusinessRule(java.lang.String pBusinessRule) Internal use only Sets the business rule for this target column. Use InterfaceActionOnTargetColumnSetBusinessRule to set this property.
void	setCheckNotNullIndicator(boolean pCheckNotNullIndicator) Internal use only Sets a new value for the check not null indicator. To set this property, use InterfaceActionOnTargetColumnSetIndicator with the indicator type InterfaceActionOnTargetColumnSetIndicator.IndicatorType.CHECK_NOT_NULL.
void	setDataType(OdiDataType pOdiDataType) Internal use only Sets the data type of the target column.
void	setEnable(boolean pEnable) Internal use only Mapped columns need to have a mapping SQL expression set, which will be executed either on target, either on the Staging Area or on the Source.
void	setExecutionLocation(OdiInterface.ExecutionLocation pExecutionLocation) Internal use only Sets the execution location for this target column. To set the execution location on target columns, use InterfaceActionOnTargetMappingSetLocation.
void	setInsertIndicator(boolean pInsertIndicator) Internal use only Sets whether this column will participate in insert operations. To set this property, use InterfaceActionOnTargetColumnSetIndicator with the type InterfaceActionOnTargetColumnSetIndicator.IndicatorType.INSERT.
void	setLength(java.lang.Integer pLength) Internal use only Sets the length of the column.
void	setModified(boolean pModified)
void	setName(java.lang.String pName) For internal use only Sets the name of the target column.
void	setPersisted(boolean pPersisted) Internal use only Sets whether the target column is persisted.
void	setPosition(java.lang.Integer pPosition) Internal use only Setter for the column's position.
void	setScale(java.lang.Integer pScale) Internal use only Sets the scale of the target column.
void	setTargetSqlMappingExpression(Expression pTargetSQLMapping) Internal use only Sets the mapping expression to be executed on target on this target column. To set this property, use InterfaceActionOnTargetMappingSetSql with a null DataSet (provided that you really want to set a mapping on the target). Note that mappings should comply with a few basic rules: - mappings executed on the SOURCE should not reference columns from different physical schemas, - mappings executed on the SOURCE should reference at least a source column, otherwise the target column should be manually assigned to a SourceDataStore using InterfaceActionOnTargetMappingSetAttachedDataStore, - mappings executed on the TARGET should not reference any source columns, since the source columns are not available on the target.
void	setUnderlyingOdiColumn(OdiColumn pColumn) Internal use only Sets the underlying column for this target column.
void	setUpdateIndicator(boolean pUpdateIndicator) Internal use only Sets whether this column will participate in Update operations. To set this property, use InterfaceActionOnTargetColumnSetIndicator with the type InterfaceActionOnTargetColumnSetIndicator.IndicatorType.UPDATE.
void	setUpdateKeyIndicator(boolean pUpdateKeyIndicator) Internal use only Sets whether this column will be used as key when doing updates on the target datastore. To set this property, use InterfaceActionOnTargetColumnSetIndicator with the type InterfaceActionOnTargetColumnSetIndicator.IndicatorType.UPDATE_KEY.
void	setUserDefinedIndicator1(boolean pUserDefinedIndicator1) Internal use only Sets whether this column has the User Defined Indicator 1 set. To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=1.
void	setUserDefinedIndicator10(boolean pUserDefinedIndicator10) Internal use only Sets whether this column has the User Defined Indicator 10 set. To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=10.
void	setUserDefinedIndicator2(boolean pUserDefinedIndicator2) Internal use only Sets whether this column has the User Defined Indicator 2 set. To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=2.
void	setUserDefinedIndicator3(boolean pUserDefinedIndicator3) Internal use only Sets whether this column has the User Defined Indicator 3 set. To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=3.
void	setUserDefinedIndicator4(boolean pUserDefinedIndicator4) Internal use only Sets whether this column has the User Defined Indicator 4 set. To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=4.
void	setUserDefinedIndicator5(boolean pUserDefinedIndicator5) Internal use only Sets whether this column has the User Defined Indicator 5 set. To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=5.
void	setUserDefinedIndicator6(boolean pUserDefinedIndicator6) Internal use only Sets whether this column has the User Defined Indicator 6 set. To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=6.
void	setUserDefinedIndicator7(boolean pUserDefinedIndicator7) Internal use only Sets whether this column has the User Defined Indicator 7 set. To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=7.
void	setUserDefinedIndicator8(boolean pUserDefinedIndicator8) Internal use only Sets whether this column has the User Defined Indicator 8 set. To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=8.
void	setUserDefinedIndicator9(boolean pUserDefinedIndicator9) Internal use only Sets whether this column has the User Defined Indicator 9 set. To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=9.
void	updateColNameFromUnderlying() For internal use only Updates the target column's name to be the one of the underlying column

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

TargetColumn

public TargetColumn(OdiInterface pParentInterface,
                    OdiColumn pRealColumn,
                    OdiInterface.ExecutionLocation pExecutionLocation)

Internal use only Creates a new target column object.

Parameters:

pParentInterface - the parent interface of this column

pRealColumn - the real underlying OdiColumn

pExecutionLocation - the execution location for the mapping of this column

TargetColumn

public TargetColumn(OdiInterface pParentInterface,
                    OdiInterface.ExecutionLocation pExecutionLocation)

Internal use only Creates a new target column object.

Parameters:

pParentInterface - the parent interface of this column

pExecutionLocation - the execution location for the mapping of this column

TargetColumn

public TargetColumn(OdiInterface pParentInterface,
                    java.lang.String pName,
                    OdiInterface.ExecutionLocation pExecutionLocation)

Internal use only Creates a new target column object.

Parameters:

pParentInterface - the parent interface of this column

pName - the name for this temporary column

pExecutionLocation - the execution location for the mapping of this column

Method Detail

getTable

public OdiInterface.TargetDataStore getTable()

Returns the target datastore of the interface owning this target column.

Specified by:

getTable in interface IColumn<OdiInterface.TargetDataStore>

Returns:

the target datastore of the interface owning this target column.

See Also:

IColumn.getTable()

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

isCheckNotNullIndicator

public boolean isCheckNotNullIndicator()

If true then the column will be checked for not null during the loading of the data in the target datastore.
For this to happen, you need to have a CKM defined on the interface and to make sure that the IKM is enabled for flow control (please refer to the documentation of the IKM).
Additionally, you may want to make sure that flow control and/or static control are enabled on the OdiColumn in the model if the datastore is not temporary.

Returns:

whether this column should be checked for not null

See Also:

setCheckNotNullIndicator(boolean)

setCheckNotNullIndicator

public void setCheckNotNullIndicator(boolean pCheckNotNullIndicator)

Internal use only
Sets a new value for the check not null indicator.
To set this property, use InterfaceActionOnTargetColumnSetIndicator with the indicator type InterfaceActionOnTargetColumnSetIndicator.IndicatorType.CHECK_NOT_NULL.

Parameters:

pCheckNotNullIndicator - the new value for the check not null indicator

See Also:

isCheckNotNullIndicator(), InterfaceActionOnTargetColumnSetIndicator.InterfaceActionOnTargetColumnSetIndicator(IndicatorType, String, boolean)

getBusinessRule

public java.lang.String getBusinessRule()

Returns the business rule of this target column.
The business rule is a custom functional description of what this column represents.

Returns:

the business rule of this target column

See Also:

setBusinessRule(String)

getTargetSqlMappingExpression

public Expression getTargetSqlMappingExpression()

When the mapping on this TargetColumn is executed on TARGET, obtains the SQL mapping for this column.

Returns:

the expression of the mapping for this target column. If the expression is not executed on OdiInterface.ExecutionLocation.TARGET, then returns null

See Also:

setTargetSqlMappingExpression(Expression)

getTargetSqlMappingExpressionId

public java.lang.Number getTargetSqlMappingExpressionId()

Returns the ID of the target expression for the mapping when executed on the target.

Returns:

the ID of the target expression for the mapping when executed on the target

getTargetSql

public java.lang.String getTargetSql()

Returns the target mapping as a String for mappings executed on the target. Similar to getTargetSqlMappingExpression().getAsString() (when the expression is not null).

Returns:

the target mapping as a String

See Also:

getTargetSqlMappingExpression()

setBusinessRule

public void setBusinessRule(java.lang.String pBusinessRule)

Internal use only Sets the business rule for this target column.
Use InterfaceActionOnTargetColumnSetBusinessRule to set this property.

Parameters:

pBusinessRule - the business rule to be set

See Also:

getBusinessRule()

setTargetSqlMappingExpression

public void setTargetSqlMappingExpression(Expression pTargetSQLMapping)

Internal use only Sets the mapping expression to be executed on target on this target column.
To set this property, use InterfaceActionOnTargetMappingSetSql with a null DataSet (provided that you really want to set a mapping on the target).
Note that mappings should comply with a few basic rules:
- mappings executed on the SOURCE should not reference columns from different physical schemas,
- mappings executed on the SOURCE should reference at least a source column, otherwise the target column should be manually assigned to a SourceDataStore using InterfaceActionOnTargetMappingSetAttachedDataStore,
- mappings executed on the TARGET should not reference any source columns, since the source columns are not available on the target.

Parameters:

pTargetSQLMapping - the expression for the target mapping

See Also:

getTargetSqlMappingExpression()

isEnable

public boolean isEnable()

Returns whether this target column is mapped or not.

Returns:

true if this target column is mapped, false otherwise

See Also:

setEnable(boolean)

setEnable

public void setEnable(boolean pEnable)

Internal use only Mapped columns need to have a mapping SQL expression set, which will be executed either on target, either on the Staging Area or on the Source. An enabled TargetColumn with no mapping expression generates a critical error in the interface, thus preventing it from being executed. To set an expression, use InterfaceActionOnTargetMappingSetSql, and to map/unmap columns, use InterfaceActionOnTargetColumnSetEnabled.

Parameters:

pEnable - whether this target column should be mapped

See Also:

isEnable(), InterfaceActionOnTargetColumnSetEnabled

getExecutionLocation

public OdiInterface.ExecutionLocation getExecutionLocation()

Returns the location of the execution of the mapping, if any.
If no mapping is set for this target column, null is returned.
If this column is mapped on the target then OdiInterface.ExecutionLocation.TARGET is returned.
If this column is mapped on the Staging Area or on Source, then null is returned, you will need to fetch the execution location for each DataSet on the corresponding TargetMappings, either by fetching them from getTargetMappings() either from DataSet.getMapping(String).

Returns:

the execution location of the target column. null indicates that this column is either not mapped at all, either not executed on the TARGET

See Also:

setExecutionLocation(oracle.odi.domain.project.OdiInterface.ExecutionLocation), setExecutionLocation(OdiInterface.ExecutionLocation)

setExecutionLocation

public void setExecutionLocation(OdiInterface.ExecutionLocation pExecutionLocation)

Internal use only Sets the execution location for this target column.
To set the execution location on target columns, use InterfaceActionOnTargetMappingSetLocation.

Parameters:

pExecutionLocation - the new execution location for this target column

See Also:

getExecutionLocation()

isInsertIndicator

public boolean isInsertIndicator()

Returns whether this column is tagged for insert.

Returns:

true if this column will participate in inserts, false otherwise

See Also:

setInsertIndicator(boolean)

setInsertIndicator

public void setInsertIndicator(boolean pInsertIndicator)

Internal use only Sets whether this column will participate in insert operations.
To set this property, use InterfaceActionOnTargetColumnSetIndicator with the type InterfaceActionOnTargetColumnSetIndicator.IndicatorType.INSERT.

Parameters:

pInsertIndicator - the new insert indicator

See Also:

isInsertIndicator(), InterfaceActionOnTargetColumnSetIndicator

getTargetColumnId

public java.lang.Number getTargetColumnId()

Returns the target column's ID in the repository.

Returns:

the target column's ID in the repository.

isUpdateIndicator

public boolean isUpdateIndicator()

Returns whether this column is tagged for update.

Returns:

true if this column will participate in updates, false otherwise

See Also:

setUpdateIndicator(boolean)

setUpdateIndicator

public void setUpdateIndicator(boolean pUpdateIndicator)

Internal use only Sets whether this column will participate in Update operations.
To set this property, use InterfaceActionOnTargetColumnSetIndicator with the type InterfaceActionOnTargetColumnSetIndicator.IndicatorType.UPDATE.

Parameters:

pUpdateIndicator - the new insert indicator

See Also:

isUpdateIndicator(), InterfaceActionOnTargetColumnSetIndicator

isUpdateKeyIndicator

public boolean isUpdateKeyIndicator()

Returns whether this column will be used as key when doing updates on the target datastore.

Returns:

true if this column will participate in the update key, false otherwise

See Also:

setUpdateKeyIndicator(boolean)

setUpdateKeyIndicator

public void setUpdateKeyIndicator(boolean pUpdateKeyIndicator)

Internal use only Sets whether this column will be used as key when doing updates on the target datastore.
To set this property, use InterfaceActionOnTargetColumnSetIndicator with the type InterfaceActionOnTargetColumnSetIndicator.IndicatorType.UPDATE_KEY.

Parameters:

pUpdateKeyIndicator - the new insert indicator

See Also:

isUpdateKeyIndicator(), InterfaceActionOnTargetColumnSetIndicator

isUserDefinedIndicator1

public boolean isUserDefinedIndicator1()

Returns whether this column has the User Defined Indicator 1 set.

Returns:

true if this column has UD1 set, false otherwise

See Also:

setUserDefinedIndicator1(boolean)

setUserDefinedIndicator1

public void setUserDefinedIndicator1(boolean pUserDefinedIndicator1)

Internal use only Sets whether this column has the User Defined Indicator 1 set.
To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=1.

Parameters:

pUserDefinedIndicator1 - the new insert indicator

See Also:

isUserDefinedIndicator1(), InterfaceActionOnTargetColumnSetUD

isUserDefinedIndicator2

public boolean isUserDefinedIndicator2()

Returns whether this column has the User Defined Indicator 2 set.

Returns:

true if this column has UD2 set, false otherwise

See Also:

setUserDefinedIndicator2(boolean)

setUserDefinedIndicator2

public void setUserDefinedIndicator2(boolean pUserDefinedIndicator2)

Internal use only Sets whether this column has the User Defined Indicator 2 set.
To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=2.

Parameters:

pUserDefinedIndicator2 - the new insert indicator

See Also:

isUserDefinedIndicator2(), InterfaceActionOnTargetColumnSetUD

isUserDefinedIndicator3

public boolean isUserDefinedIndicator3()

Returns whether this column has the User Defined Indicator 3 set.

Returns:

true if this column has UD3 set, false otherwise

See Also:

setUserDefinedIndicator3(boolean)

setUserDefinedIndicator3

public void setUserDefinedIndicator3(boolean pUserDefinedIndicator3)

Internal use only Sets whether this column has the User Defined Indicator 3 set.
To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=3.

Parameters:

pUserDefinedIndicator3 - the new insert indicator

See Also:

isUserDefinedIndicator3(), InterfaceActionOnTargetColumnSetUD

isUserDefinedIndicator4

public boolean isUserDefinedIndicator4()

Returns whether this column has the User Defined Indicator 1 set.

Returns:

true if this column has UD1 set, false otherwise

See Also:

setUserDefinedIndicator1(boolean)

setUserDefinedIndicator4

public void setUserDefinedIndicator4(boolean pUserDefinedIndicator4)

Internal use only Sets whether this column has the User Defined Indicator 4 set.
To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=4.

Parameters:

pUserDefinedIndicator4 - the new insert indicator

See Also:

isUserDefinedIndicator4(), InterfaceActionOnTargetColumnSetUD

isUserDefinedIndicator5

public boolean isUserDefinedIndicator5()

Returns whether this column has the User Defined Indicator 5 set.

Returns:

true if this column has UD5 set, false otherwise

See Also:

setUserDefinedIndicator5(boolean)

setUserDefinedIndicator5

public void setUserDefinedIndicator5(boolean pUserDefinedIndicator5)

Internal use only Sets whether this column has the User Defined Indicator 5 set.
To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=5.

Parameters:

pUserDefinedIndicator5 - the new insert indicator

See Also:

isUserDefinedIndicator5(), InterfaceActionOnTargetColumnSetUD

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

getParentInterface

public OdiInterface getParentInterface()

Returns the parent interface of this target column.

Returns:

the parent interface of this target column

getUnderlyingOdiColumn

public OdiColumn getUnderlyingOdiColumn()

The underlying OdiColumn.
If the TargetDataStore is a temporary datastore, null is returned as there is no underlying OdiColumn.

Returns:

The underlying OdiColumn reference, null on temporary target columns

See Also:

setUnderlyingOdiColumn(OdiColumn)

setUnderlyingOdiColumn

public void setUnderlyingOdiColumn(OdiColumn pColumn)

Internal use only Sets the underlying column for this target column.

Parameters:

pColumn - the new underlying OdiColumn

See Also:

getUnderlyingOdiColumn()

changeToTemporaryColumn

public void changeToTemporaryColumn()

Internal use only Modifies an existing target column for use when the target datastore is changed to temporary.

isTemporaryColumn

public boolean isTemporaryColumn()

Returns whether this is a temporary column.
true means that this column has no underlying OdiColumn.

Returns:

true if this TargetColumn is a temporary column

getTargetMappings

public java.util.Collection<TargetMapping> getTargetMappings()

Returns all target mappings for this target column.
When the target column is mapped and is not executed on TARGET, then there is one mapping for each DataSet.

Returns:

the target mappings for this target column

See Also:

addTargetMapping(TargetMapping), removeTargetMapping(TargetMapping), DataSet.getMapping(String)

addTargetMapping

public void addTargetMapping(TargetMapping pTargetMapping)

Internal use only Adds a target mapping to this target column.

Parameters:

pTargetMapping - the new target mapping for this column

removeTargetMapping

public void removeTargetMapping(TargetMapping pTargetMapping)

Internal use only Removes a target mapping from this target column.

Parameters:

pTargetMapping - the target mapping to remove

getLength

public java.lang.Integer getLength()

Returns the length of the column.
If the datatype is not set or doesn't allow length, a call to this method will cause an IllegalStateException.

Specified by:

getLength in interface IColumn<OdiInterface.TargetDataStore>

Returns:

column's length

Throws:

java.lang.IllegalStateException - if the OdiDataType of this column is not set or doesn't allow length

See Also:

IColumn.getLength(), setLength(Integer)

setLength

public void setLength(java.lang.Integer pLength)

Internal use only Sets the length of the column.

Specified by:

setLength in interface IColumn<OdiInterface.TargetDataStore>

Parameters:

pLength - the length

See Also:

IColumn.setLength(java.lang.Integer), getLength()

resetLength

public void resetLength()

Internal use only Resets the length value to 0. The default length value for a new temporary column is 50, set in the constructor. However if a source column is moved to the temporary target, there must be a way to reset the length to 0 if length is not allowed, otherwise it shows up as 50 in the property inspector. bug# 9727830

getInternalLength

public java.lang.Integer getInternalLength()

Returns the length of the column.
Unlike getLength(), this method will return null rather than throwing an exception if the length is not allowed.

Returns:

the length of the column

getName

public java.lang.String getName()

Returns the name of the target column.

Specified by:

getName in interface IColumn<OdiInterface.TargetDataStore>

Returns:

the name of the target column.

See Also:

IColumn.getName(), setName(String)

setName

public void setName(java.lang.String pName)

For internal use only Sets the name of the target column.

Parameters:

pName - the name of the target column.

See Also:

getName()

updateColNameFromUnderlying

public void updateColNameFromUnderlying()

For internal use only Updates the target column's name to be the one of the underlying column

getScale

public java.lang.Integer getScale()

Returns the scale of the column.
If the datatype is not set or doesn't allow scale, a call to this method will cause an IllegalStateException.

Specified by:

getScale in interface IColumn<OdiInterface.TargetDataStore>

Returns:

column' scale

Throws:

DomainRuntimeException - if the OdiDataType of this column is not set or doesn't allow scale

See Also:

IColumn.getScale(), setScale(Integer)

setScale

public void setScale(java.lang.Integer pScale)

Internal use only Sets the scale of the target column.

Specified by:

setScale in interface IColumn<OdiInterface.TargetDataStore>

Parameters:

pScale - the scale

See Also:

IColumn.setScale(java.lang.Integer), getScale()

resetScale

public void resetScale()

Internal use only Resets the scale value to 0. The default length value for a new temporary column is 50, set in the constructor. However if a source column is moved to the temporary target, there must be a way to reset the length to 0 if length is not allowed, otherwise it shows up as 50 in the property inspector. bug# 9727830

getInternalScale

public java.lang.Integer getInternalScale()

Returns the scale of the column.
Unlike getScale(), this method will return null rather than throwing an exception if the scale is not allowed.

Returns:

the scale of the column

getDataType

public OdiDataType getDataType()

Returns the datatype of this target column.

Specified by:

getDataType in interface IColumn<OdiInterface.TargetDataStore>

Returns:

the datatype of this target column.

See Also:

IColumn.getDataType(), setDataType(OdiDataType)

setDataType

public void setDataType(OdiDataType pOdiDataType)

Internal use only Sets the data type of the target column.

Specified by:

setDataType in interface IColumn<OdiInterface.TargetDataStore>

Parameters:

pOdiDataType - the data type

See Also:

IColumn.setDataType(oracle.odi.domain.topology.OdiDataType), getDataType()

getNonPersistedSql

public Expression getNonPersistedSql()

Returns the non persisted expression on this target column.
The difference between the persisted and non persisted versions lie in the cross-references, as some cross-references are not persisted in the repository.

Returns:

the non persisted expression on this target column.

isPersisted

public boolean isPersisted()

Description copied from interface: IOptionnallyPersistedObject

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

Specified by:

isPersisted in interface IOptionnallyPersistedObject

Returns:

true if this object should be persisted, false otherwise

setPersisted

public void setPersisted(boolean pPersisted)

Internal use only Sets whether the target column is persisted.

Specified by:

setPersisted in interface IOptionnallyPersistedObject

Parameters:

pPersisted - true if the target column is persisted, false otherwise.

See Also:

IOptionnallyPersistedObject.setPersisted(boolean)

initializeMappingsFromPersisted

public void initializeMappingsFromPersisted()

Internal use only Initialize internal persistence mapping.

populatePersistedMappings

public void populatePersistedMappings()

Internal use only Populate internal persistence mapping.

isUserDefinedIndicator10

public boolean isUserDefinedIndicator10()

Returns whether this column has the User Defined Indicator 10 set.

Returns:

true if this column has UD10 set, false otherwise

See Also:

setUserDefinedIndicator10(boolean)

setUserDefinedIndicator10

public void setUserDefinedIndicator10(boolean pUserDefinedIndicator10)

Internal use only Sets whether this column has the User Defined Indicator 10 set.
To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=10.

Parameters:

pUserDefinedIndicator10 - the new insert indicator

See Also:

isUserDefinedIndicator10(), InterfaceActionOnTargetColumnSetUD

isUserDefinedIndicator6

public boolean isUserDefinedIndicator6()

Returns whether this column has the User Defined Indicator 6 set.

Returns:

true if this column has UD6 set, false otherwise

See Also:

setUserDefinedIndicator6(boolean)

setUserDefinedIndicator6

public void setUserDefinedIndicator6(boolean pUserDefinedIndicator6)

Internal use only Sets whether this column has the User Defined Indicator 6 set.
To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=6.

Parameters:

pUserDefinedIndicator6 - the new insert indicator

See Also:

isUserDefinedIndicator6(), InterfaceActionOnTargetColumnSetUD

isUserDefinedIndicator7

public boolean isUserDefinedIndicator7()

Returns whether this column has the User Defined Indicator 7 set.

Returns:

true if this column has UD7 set, false otherwise

See Also:

setUserDefinedIndicator7(boolean)

setUserDefinedIndicator7

public void setUserDefinedIndicator7(boolean pUserDefinedIndicator7)

Internal use only Sets whether this column has the User Defined Indicator 7 set.
To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=7.

Parameters:

pUserDefinedIndicator7 - the new insert indicator

See Also:

isUserDefinedIndicator7(), InterfaceActionOnTargetColumnSetUD

isUserDefinedIndicator8

public boolean isUserDefinedIndicator8()

Returns whether this column has the User Defined Indicator 8 set.

Returns:

true if this column has UD8 set, false otherwise

See Also:

setUserDefinedIndicator8(boolean)

setUserDefinedIndicator8

public void setUserDefinedIndicator8(boolean pUserDefinedIndicator8)

Internal use only Sets whether this column has the User Defined Indicator 8 set.
To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=8.

Parameters:

pUserDefinedIndicator8 - the new insert indicator

See Also:

isUserDefinedIndicator8(), InterfaceActionOnTargetColumnSetUD

isUserDefinedIndicator9

public boolean isUserDefinedIndicator9()

Returns whether this column has the User Defined Indicator 9 set.

Returns:

true if this column has UD9 set, false otherwise

See Also:

setUserDefinedIndicator9(boolean)

setUserDefinedIndicator9

public void setUserDefinedIndicator9(boolean pUserDefinedIndicator9)

Internal use only Sets whether this column has the User Defined Indicator 9 set.
To set this property, use InterfaceActionOnTargetColumnSetUD with UDNumber=9.

Parameters:

pUserDefinedIndicator9 - the new insert indicator

See Also:

isUserDefinedIndicator9(), InterfaceActionOnTargetColumnSetUD

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

getPosition

public java.lang.Integer getPosition()

Getter for the column's position.

Returns:

the position for this column

Since:

11.1.1.5.0

setPosition

public void setPosition(java.lang.Integer pPosition)

Internal use only Setter for the column's position.

Parameters:

pPosition - the new position for the column

Since:

11.1.1.5.0

isModified

public boolean isModified()

Since:

11.1.1.5.0

setModified

public void setModified(boolean pModified)

Since:

11.1.1.5.0

internalPersistenceEquals

public boolean internalPersistenceEquals(TargetColumn t2)

Description copied from interface: OdiInterface.IPersistenceComparable

Returns true if this instance is equal to i2 in terms of persisted fields only

Specified by:

internalPersistenceEquals in interface OdiInterface.IPersistenceComparable<TargetColumn>

Returns:

true if this equals to i2

Since:

11.1.1.5.0

Skip navigation links