oracle.odi.domain.mapping

Class MapAttribute

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.root.Root

oracle.odi.domain.root.NamedObject

oracle.odi.domain.root.PropertyOwner

oracle.odi.domain.mapping.MapAttribute

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IModelObject, IMapAttribute, IRepositoryEntity, IMapAttributeOwner, IMapExpressionOwner, oracle.odi.domain.mapping.IMapReferenceOwner, IExpressionReferencedObject, IMappingObject, INamedObject, IPropertyOwner, IRoot

@Entity
public class MapAttribute
extends oracle.odi.domain.root.PropertyOwner
implements IExpressionReferencedObject, IMapAttributeOwner, IMapExpressionOwner, IMapAttribute, oracle.odi.domain.mapping.IMapReferenceOwner

A persistent class that represents an attribute of a map connector point. The attribute contains column-level information that can be used to create a column list in a query. It represents a projected value in a query or generated code.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapAttribute.AttributeType Represents the basic type of the attribute.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTIVE_INDICATOR_PROPKEY The property name for a boolean property that indicates that this attribute will participate in code generation.
static java.lang.String	CHECK_NOTNULL_PROPKEY The property name for a boolean property that indicates that this attribute will be checked for not null during loading, if the owning component is a target data storage component.
static MapAttribute.ConnectionTypeSelector	DEFAULT_CONNECTION_TYPE_SELECTOR
static java.lang.String	EXPRESSION_PROPERTY_KEY The first expression metadata field can be accessed as a property of the attribute, using this property key name.
static java.lang.String	INSERT_INDICATOR_PROPKEY The property name for a boolean property that indicates that this attribute will participate in an insert loading operation, if the owning component is a data storage target in the map.
static java.lang.String	KEY_INDICATOR_PROPKEY The property name for a boolean property that indicates that this attribute is bound to a column that participates in a key constraint.
static java.lang.String	PROPKEY_TECHNICAL_DESCRIPTION Property key name for the technical description
static java.lang.String	UD1_PROPKEY The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #1.
static java.lang.String	UD10_PROPKEY The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #20.
static java.lang.String	UD2_PROPKEY The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #2.
static java.lang.String	UD3_PROPKEY The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #3.
static java.lang.String	UD4_PROPKEY The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #4.
static java.lang.String	UD5_PROPKEY The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #5.
static java.lang.String	UD6_PROPKEY The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #6.
static java.lang.String	UD7_PROPKEY The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #7.
static java.lang.String	UD8_PROPKEY The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #8.
static java.lang.String	UD9_PROPKEY The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #9.
static int	UNDEFINED A constant value used to represent an undefined data size value.
static java.lang.String	UPDATE_INDICATOR_PROPKEY The property name for a boolean property that indicates that this attribute will participate in an update loading operation, if the owning component is a data storage target in the map.

Fields inherited from class oracle.odi.domain.root.NamedObject

mGlobalNamespaceId

Method Summary

Methods

Modifier and Type	Method and Description
void	connectTo(IMapComponent targetComponent) Add this source attribute to the scope for the specified target component.
void	connectTo(IMapComponent targetComponent, MapPathSpecifier path) Add this source attribute to the scope for the specified target component.
void	connectTo(MapAttribute tgtAttribute) Set this source attribute as the source expression for the specified target attribute.
void	connectTo(MapAttribute tgtAttribute, MapPathSpecifier path) Set this source attribute as the source expression for the specified target attribute.
void	connectTo(MapConnectorPoint point) Connect this source attribute to the specified target connector point.
MapAttribute	createAttribute(MapAttribute sourceAttr) Create an attribute that is a copy of the specified source attribute.
MapAttribute	createAttribute(java.lang.String name)
MapAttribute	createAttribute(java.lang.String name, boolean isPersistent)
static void	dumpAttributeList(java.util.List attrList) A utility method to dump a specified list of attributes for a specified component to the console.
MapAttribute	findAttribute(java.lang.String name) Find an attribute owned by this connector point, with the specified name.
int	getAttributeCount() Get the total number of attributes owned by this connector point.
java.util.List	getAttributes() Retrieve a list of all the attributes owned by this connector point.
IColumn	getBoundColumn() Get the column object to which this attribute is bound, if any, else return null.
IModelObject	getBoundObject() Return the bound object for this attribute, or null if no bound object is defined.
java.lang.String	getBoundObjectFullName() Get the full qualified name of the bound object.
java.lang.String	getBoundObjectName() Get the attribute bound object name, if it is available from an attribute delegate, else null.
java.util.List	getChildAttributes() Returns the list of child attributes, if any.
MapAttribute	getCompositeChildAttribute() If this attribute is an output attribute of a composite component, get the corresponding attribute in the child connector point of this attribute's owning connector point, if any.
MapAttribute	getCompositeParentAttribute() If this attribute is an output attribute of a child component inside a composite component, get the corresponding parent attribute via the composite parent/child connector point relationship, if any.
java.lang.String	getContextualName(IMapComponent contextComp) Get the full qualified name of the attribute, relative to a contextual component.
IDataType	getDataType()
java.lang.String	getDataTypeString() Get the datatype name string.
java.lang.String	getDdlDataType() Get the generated DDL data type or code generation data type for the attribute, if a column is being created to match the attribute.
oracle.odi.domain.mapping.MapComponentDelegate.AttributeDelegate	getDelegate() Get the connector point delegate for this attribute, or null if no connector point delegate class is defined.
java.lang.String	getDisplayableTypeName() Get a user-displayable type name for the object.
MapExpression.ExecuteOnLocation	getExecuteOnHint() Get the execute-on hint for the expression of this attribute, for the simple case where this attribute only has one expression.
ILogicalSchema	getExecuteOnLocation() Get the execute-on location logical schema name for the expression of this attribute.
MapExpression	getExpression() Return the expression for this attribute.
MapExpression	getExpression(int pIndex) Retrieves the expression associated with this attribute at the given index.
java.util.List	getExpressions() Return the list of expressions for this attribute.
java.lang.String	getFullName() Get the full qualified name of the attribute.
MapAttribute	getLeafAttribute() Get the leaf attribute associated with this attribute.
IMapRootContainer	getMapRootContainer() Get the top-level mapping that contains this attribute.
java.lang.String	getMinimizedRefText() Gets the minimized reference text for this object.
IRoot	getOwner() Gets the mapping owner (or parent) of this object.
IMapComponent	getOwningComponent() Get the component owner for this attribute.
MapConnectorPoint	getOwningConnectorPoint() Get the connector point that owns this attribute.
java.lang.Integer	getPosition() Return the position of this attribute within its parent connector point.
java.util.Set	getProjectorSourceComponents() Return the components that act as the projector source for this attribute, based on the attribute input expression reference, or null if none found.
java.util.List	getReferencingComponents() Get a list of target components that reference this attribute.
java.lang.String	getRefName() Get the expression reference name for the attribute.
java.lang.String	getRefName(boolean minimize) Get the expression reference name for the attribute.
java.lang.String	getRefName(MapPathSpecifier path) Get the expression reference name for the attribute.
java.lang.String	getRefName(MapPathSpecifier path, boolean minimize) Get the expression reference name for the attribute.
java.lang.String	getRefText() Gets the reference text for this object.
java.lang.Integer	getScale() Get the data scale for this attribute.
java.lang.Integer	getSize() Get the data size (precision or length) of this attribute.
java.lang.String	getSQLAccessName() Get the SQL or code generation access name for this source attribute.
java.lang.String	getSQLAccessName(boolean includeTableAlias) Get the SQL or code generation access name for this source attribute.
java.lang.String	getSQLAccessName(boolean includeTableAlias, java.lang.String tableAlias) Get the SQL or code generation access name for this source attribute.
java.lang.String	getSQLAccessName(java.lang.String tableAlias) Get the SQL or code generation access name for this source attribute.
IMappingObject.SyncState	getSyncState()
java.lang.String	getTechnicalDescription() Get the technical description of this attribute.
java.lang.Object	invokeMethod(java.lang.String methodName, java.lang.Object[] args)
boolean	isActive() Get the active state of this attribute.
boolean	isBoundAttribute() Return true if this attribute is bound to a model object (e.g.
boolean	isCheckNotNull() Return true if the bound column will be checked for non-null value when loading the target data storage object.
boolean	isCheckNotNullIndicator() Return true if the attribute will be checked for non-null value when loading the target data storage object.
boolean	isInsertIndicator() Return true if the attribute participates in an insert operation when loading the target data storage object.
boolean	isKeyIndicator() Return true if this attribute acts as a key indicator in the component.
boolean	isProjectorAttribute() Return true if this attribute is a source projector attribute (not a decorator attribute).
boolean	isReferenced() Return true if this attribute is referenced by a downstream expression in the mapping graph.
boolean	isRequired() Returns true if this attribute is required to be connected when used in a mapping, else false.
boolean	isScaleSet() Return true if the scale for this attribute has ever been explicitly set, else false.
boolean	isSizeSet() Return true if the precision for this attribute has ever been explicitly set, else false.
boolean	isSourceAttribute()
boolean	isTargetAttribute() Return true if this attribute is a target attribute.
boolean	isUpdateIndicator() Return true if the attribute participates in an update operation when loading the target data storage object.
void	removeAttribute(MapAttribute attr) Remove the specified attribute from this connector point.
void	removeAttribute(MapAttribute attr, boolean removeReferencedExpressions) Remove the specified attribute from this connector point.
void	removeAttribute(java.lang.String name) Remove the attribute with the specified name from this connector point.
void	removeAttribute(java.lang.String name, boolean removeReferencedExpressions) Remove the attribute with the specified name from this connector point.
void	removeExpression(MapExpression expr) Remove the specified expression from this attribute.
void	removeExpressions() Remove all expressions associated with this attribute.
void	reorderAttribute(MapAttribute attr, java.lang.Integer newPos) Change the order of the specified attribute in the ordered list.
void	setActive(boolean isActive) Set the active state of this attribute.
void	setCheckNotNullIndicator(boolean notNullIndicator) Set the check not null indicator state for the attribute.
void	setDataType(IDataType dataType) Set the data type of this attribute.
void	setDataType(IDataType dataType, java.lang.Integer size) Set the data type of this attribute.
boolean	setDataType(IDataType dataType, java.lang.Integer size, java.lang.Integer scale) Set the data type of this attribute.
void	setDataTypeCode(java.lang.String technoCode, java.lang.String dataTypeCode) odiInternal
void	setDataTypeString(java.lang.String dataTypeName) Set the data type for the attribute by name.
void	setExecuteOnHint(MapExpression.ExecuteOnLocation loc) Set the execute location hint for the attribute expression.
void	setExecuteOnHint(MapExpression.ExecuteOnLocation loc, MapConnectorPoint scopingInputPoint) Set the execute location hint for the attribute expression.
void	setExecuteOnLocation(ILogicalSchema loc) Set the fixed execute location for the attribute expression.
void	setExecuteOnLocation(ILogicalSchema loc, MapConnectorPoint scopingInputPoint) Set the fixed execute location for the attribute expression.
void	setExecuteOnLocationByName(java.lang.String locName) Set the execute-on location logical schema name for the expression of this attribute.
void	setExpression(MapAttribute attribute) Sets the expression for a target attribute, using the specified attribute as a source.
void	setExpression(MapAttribute attribute, MapPathSpecifier path) Sets the expression for a target attribute, using the specified attribute as a source.
void	setExpression(MapConnectorPoint scopingInputPoint, MapAttribute sourceAttribute, MapPathSpecifier path) Sets an input expression with an associated scoping input connector point, for the case where there are multiple input expressions (e.g.
void	setExpression(MapConnectorPoint scopingInputPoint, MapExpression expr) Sets an expression with an associated scoping input connector point for the attribute, for the case where there are multiple expressions for an attribute (e.g.
void	setExpression(MapExpression expr) Sets the expression for the attribute, for the standard case where there is only one target input expression.
void	setExpressionText(MapConnectorPoint scopingInputPoint, java.lang.String expressionText) Sets an input expression text with an associated scoping input connector point, for the case where there are multiple input expressions (e.g.
void	setExpressionText(java.lang.String exprText) Sets the expression text for the attribute, for the standard case where there is only one target input expression.
void	setInsertIndicator(boolean insertIndicator) Set the insert indicator state for the attribute.
void	setIsRequired(boolean value) Sets a flag that indicates that this attribute is required to be connected when used in a mapping.
void	setKeyIndicator(boolean keyIndicator) Set the boolean key indicator property value to the specified value.
void	setName(java.lang.String name) Set the name of the object.
void	setPropertyValue(java.lang.String key, java.lang.Object value) An attribute which owns any property that has had a non-default value set should be persisted.
void	setScale(java.lang.Integer value) Set the data scale for this attribute.
void	setSize(java.lang.Integer value) Set the data size (precision or length) for this attribute.
void	setUpdateIndicator(boolean updateIndicator) Set the update indicator state for the attribute.
java.lang.String	toString()
boolean	validate(java.util.List result, boolean debug) Validates the object.

Methods inherited from class oracle.odi.domain.root.PropertyOwner

addProperty, adjustPropertyPersistency, createProperty, createProperty, delete, getAllProperties, getAllProperties, getAllPropertyMapReferenceOwners, getBooleanPropertyValue, getChildNamespaceId, getDisplayableProperties, getExpressionPropertyValue, getIntPropertyValue, getProperties, getProperties, getProperty, getPropertyMetadataOwner, getPropertyValue, getPropertyValueReference, getStringPropertyValue, initiateDynamicProperties, internalGetAllProperties, internalIsPropertyDefined, internalSetPropertyValue, isPropertyDefined, notifyPropertyChange, onSave, removeAllProperties, removeProperty, removeProperty, setBooleanPropertyValue, setIntPropertyValue, validateProperties

Methods inherited from class oracle.odi.domain.root.NamedObject

getBusinessName, getDescription, getGlobalNamespaceId, getName, getNamespaceId, setBusinessName, setDescription

Methods inherited from class oracle.odi.domain.root.Root

addCachedIssue, addCachedIssues, clearIssueCache, displayIssues, displayIssues, displayIssues, dump, dump, dump, dump, dumpToString, equals, getAdapter, getCachedErrors, getCachedIssues, getCachedSyncState, getCachedValidationErrorMessage, getDisplayableObjectName, getFCOContainer, getGUID, getInternalId, getPropertyDefinitionOwner, getRootContainer, getSecurityContainer, getStrongTypeClassName, handleMapChangeEvent, hasAdapter, hashCode, isNew, setCachedSyncState, validate

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

getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor

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

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.odi.domain.mapping.xreference.IExpressionReferencedObject

getName, getNumericId

Methods inherited from interface oracle.odi.domain.mapping.IMapExpressionOwner

getName

Methods inherited from interface oracle.odi.domain.root.IRoot

dump, dump, getDisplayableObjectName, getGUID, getStrongTypeClassName, validate

Methods inherited from interface oracle.odi.domain.root.IMappingObject

getRootContainer

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getInternalId, getSecurityContainer

Methods inherited from interface oracle.odi.domain.adapter.IModelObject

getGlobalId, getName, getNumericId

Methods inherited from interface oracle.odi.domain.root.INamedObject

getBusinessName, getDescription, getName, setBusinessName, setDescription

Field Detail

EXPRESSION_PROPERTY_KEY

public static final java.lang.String EXPRESSION_PROPERTY_KEY

The first expression metadata field can be accessed as a property of the attribute, using this property key name.

See Also:

Constant Field Values

PROPKEY_TECHNICAL_DESCRIPTION

public static final java.lang.String PROPKEY_TECHNICAL_DESCRIPTION

Property key name for the technical description

See Also:

Constant Field Values

UNDEFINED

public static final int UNDEFINED

A constant value used to represent an undefined data size value.

See Also:

Constant Field Values

DEFAULT_CONNECTION_TYPE_SELECTOR

public static final MapAttribute.ConnectionTypeSelector DEFAULT_CONNECTION_TYPE_SELECTOR

KEY_INDICATOR_PROPKEY

public static final java.lang.String KEY_INDICATOR_PROPKEY

The property name for a boolean property that indicates that this attribute is bound to a column that participates in a key constraint.

See Also:

Constant Field Values

INSERT_INDICATOR_PROPKEY

public static final java.lang.String INSERT_INDICATOR_PROPKEY

The property name for a boolean property that indicates that this attribute will participate in an insert loading operation, if the owning component is a data storage target in the map.

See Also:

Constant Field Values

UPDATE_INDICATOR_PROPKEY

public static final java.lang.String UPDATE_INDICATOR_PROPKEY

The property name for a boolean property that indicates that this attribute will participate in an update loading operation, if the owning component is a data storage target in the map.

See Also:

Constant Field Values

ACTIVE_INDICATOR_PROPKEY

public static final java.lang.String ACTIVE_INDICATOR_PROPKEY

The property name for a boolean property that indicates that this attribute will participate in code generation. If the active property is set to false, then the column corresponding to this attribute will not be loaded if it is a target, and will not be included in the source query if the owning component is a source or intermediate component.

See Also:

Constant Field Values

UD1_PROPKEY

public static final java.lang.String UD1_PROPKEY

The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #1.

See Also:

Constant Field Values

UD2_PROPKEY

public static final java.lang.String UD2_PROPKEY

The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #2.

See Also:

Constant Field Values

UD3_PROPKEY

public static final java.lang.String UD3_PROPKEY

The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #3.

See Also:

Constant Field Values

UD4_PROPKEY

public static final java.lang.String UD4_PROPKEY

The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #4.

See Also:

Constant Field Values

UD5_PROPKEY

public static final java.lang.String UD5_PROPKEY

The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #5.

See Also:

Constant Field Values

UD6_PROPKEY

public static final java.lang.String UD6_PROPKEY

The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #6.

See Also:

Constant Field Values

UD7_PROPKEY

public static final java.lang.String UD7_PROPKEY

The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #7.

See Also:

Constant Field Values

UD8_PROPKEY

public static final java.lang.String UD8_PROPKEY

The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #8.

See Also:

Constant Field Values

UD9_PROPKEY

public static final java.lang.String UD9_PROPKEY

The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #9.

See Also:

Constant Field Values

UD10_PROPKEY

public static final java.lang.String UD10_PROPKEY

The property name for a boolean property that indicates that this attribute functions as user-defined attribute role #20.

See Also:

Constant Field Values

CHECK_NOTNULL_PROPKEY

public static final java.lang.String CHECK_NOTNULL_PROPKEY

The property name for a boolean property that indicates that this attribute will be checked for not null during loading, if the owning component is a target data storage component.

See Also:

Constant Field Values

Method Detail

getDelegate

public oracle.odi.domain.mapping.MapComponentDelegate.AttributeDelegate getDelegate()
                                                                             throws MappingException

Get the connector point delegate for this attribute, or null if no connector point delegate class is defined. The connector point delegate class can be defined in the main component delegate class for specific types.

Returns:

The delegate for this attribute.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

MappingException

setName

public void setName(java.lang.String name)
             throws MappingException

Description copied from interface: INamedObject

Set the name of the object.

Specified by:

setName in interface INamedObject

Overrides:

setName in class oracle.odi.domain.root.NamedObject

Throws:

MappingException - TODO

getFullName

public java.lang.String getFullName()

Get the full qualified name of the attribute. The qualifiers include composite component owners, plus the component name, plus the connector point name.

Overrides:

getFullName in class oracle.odi.domain.root.Root

getContextualName

public java.lang.String getContextualName(IMapComponent contextComp)

Get the full qualified name of the attribute, relative to a contextual component. The qualifiers include composite component owners (if different from the contextual component owner), plus the component name, plus the connector point name.

getRefName

public java.lang.String getRefName()

Get the expression reference name for the attribute. This will be in the form: ..[.] The reference is assumed to be from the top level, not relative to any particular composite component. The connector point name is only necessary if the owning component has multiple output connector points. be included.

getRefName

public java.lang.String getRefName(boolean minimize)

Get the expression reference name for the attribute. This will be in the form: ..[.] The reference is assumed to be from the top level, not relative to any particular composite component. The connector point name is only necessary if the owning component has multiple output connector points.

Parameters:

minimize - If true, any owning composite component (dataset) qualifier will not be included.

getRefName

public java.lang.String getRefName(MapPathSpecifier path)

Get the expression reference name for the attribute. This will be in the form: ..[.] The reference is assumed to be from the top level, not relative to any particular composite component. The connector point name is only necessary if the owning component has multiple output connector points.

Parameters:

path - If non-null, specifies a context path for the ref name.

getRefName

public java.lang.String getRefName(MapPathSpecifier path,
                          boolean minimize)

Get the expression reference name for the attribute. This will be in the form: ..[.] The reference is assumed to be from the top level, not relative to any particular composite component. The connector point name is only necessary if the owning component has multiple output connector points.

Parameters:

path - If non-null, specifies a context path for the ref name.

minimize - If true, any owning composite component (dataset) qualifier will not be included.

getSQLAccessName

public java.lang.String getSQLAccessName(boolean includeTableAlias,
                                java.lang.String tableAlias)
                                  throws MappingException,
                                         AdapterException

Get the SQL or code generation access name for this source attribute. This will be the bound column name, if any, or the attribute name if no bound column name can be found.

Parameters:

includeTableAlias - If true, a table alias will be included in the name.

tableAlias - If not null, this is a table alias that will be used as a prefix for the name.

Returns:

The SQL access name for the source attribute.

Throws:

MappingException

AdapterException

getSQLAccessName

public java.lang.String getSQLAccessName(boolean includeTableAlias)
                                  throws MappingException,
                                         AdapterException

Get the SQL or code generation access name for this source attribute. This will be the bound column name, if any, or the attribute name if no bound column name can be found.

Parameters:

includeTableAlias - If true, a table alias will be included in the name.

Returns:

The SQL access name for the source attribute.

Throws:

MappingException

AdapterException

getSQLAccessName

public java.lang.String getSQLAccessName()
                                  throws MappingException,
                                         AdapterException

Get the SQL or code generation access name for this source attribute. This will be the bound column name, if any, or the attribute name if no bound column name can be found.

Returns:

The SQL access name for the source attribute.

Throws:

MappingException

AdapterException

getSQLAccessName

public java.lang.String getSQLAccessName(java.lang.String tableAlias)
                                  throws MappingException,
                                         AdapterException

Get the SQL or code generation access name for this source attribute. This will be the bound column name, if any, or the attribute name if no bound column name can be found.

Parameters:

tableAlias - If not null, this is a table alias that will be used as a prefix for the name.

Returns:

The SQL access name for the source attribute.

Throws:

MappingException

AdapterException

getOwningConnectorPoint

public MapConnectorPoint getOwningConnectorPoint()

Get the connector point that owns this attribute.

getOwningComponent

public IMapComponent getOwningComponent()

Get the component owner for this attribute. In most cases this will be the component that owns the connector point that directly owns this attribute.

getOwner

public IRoot getOwner()

Description copied from interface: IRoot

Gets the mapping owner (or parent) of this object. Some objects may have an external adapter owner and would return null from this method - for example the mapping object is owned by an adapter container (e.g. OdiFolder) object, which is not an instance of IRoot, so null would be returned.

Specified by:

getOwner in interface IRoot

Specified by:

getOwner in class oracle.odi.domain.root.Root

Returns:

The owner class instance.

getPosition

public java.lang.Integer getPosition()
                              throws oracle.odi.domain.mapping.exception.MapComponentException

Return the position of this attribute within its parent connector point.

Returns:

The position of the attribute

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

getChildAttributes

public java.util.List getChildAttributes()

Returns the list of child attributes, if any. If there are no child attributes an empty list is returned. The child attributes can be used to define an attribute with complex data type.

getCompositeChildAttribute

public MapAttribute getCompositeChildAttribute()
                                        throws MappingException,
                                               AdapterException

If this attribute is an output attribute of a composite component, get the corresponding attribute in the child connector point of this attribute's owning connector point, if any.

Returns:

The composite child attribute, if any, else null.

Throws:

AdapterException

MappingException

getCompositeParentAttribute

public MapAttribute getCompositeParentAttribute()
                                         throws MappingException,
                                                AdapterException

If this attribute is an output attribute of a child component inside a composite component, get the corresponding parent attribute via the composite parent/child connector point relationship, if any.

Returns:

The composite parent attribute, if any, else null.

Throws:

AdapterException

MappingException

getLeafAttribute

public MapAttribute getLeafAttribute()
                              throws MappingException,
                                     AdapterException

Get the leaf attribute associated with this attribute. If this attribute is owned by an output connector point of a composite component, then the corresponding attribute owned by the child connector point will be returned. Otherwise, just return this attribute.

Throws:

AdapterException

MappingException

setExpression

public void setExpression(MapExpression expr)
                   throws oracle.odi.domain.mapping.exception.MapComponentException

Sets the expression for the attribute, for the standard case where there is only one target input expression.

Parameters:

expr - The expression to set.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

setExpressionText

public void setExpressionText(java.lang.String exprText)
                       throws MappingException

Sets the expression text for the attribute, for the standard case where there is only one target input expression.

Parameters:

exprText - The expression text to set.

Throws:

PropertyException

MappingException

setExpression

public void setExpression(MapAttribute attribute)
                   throws MappingException,
                          AdapterException

Sets the expression for a target attribute, using the specified attribute as a source. Will attempt to create a connection that will put the source attribute in scope for the target, if possible. If it is not possible to get the source attribute into scope, a MapConnectionException is thrown.

Parameters:

attribute - The source attribute.

Throws:

PropertyException

AdapterException

MappingException

setExpression

public void setExpression(MapAttribute attribute,
                 MapPathSpecifier path)
                   throws MappingException,
                          AdapterException

Sets the expression for a target attribute, using the specified attribute as a source. Will attempt to create a connection that will put the source attribute in scope for the target, if possible. If it is not possible to get the source attribute into scope, a MapConnectionException is thrown.

Parameters:

attribute - The source attribute.

path - The path specifier to specify the path for the source attribute, which will be converted into a path qualifier in the expression text.

Throws:

PropertyException

AdapterException

MappingException

removeExpressions

public void removeExpressions()
                       throws oracle.odi.domain.mapping.exception.MapComponentException

Remove all expressions associated with this attribute.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

removeExpression

public void removeExpression(MapExpression expr)
                      throws oracle.odi.domain.mapping.exception.MapComponentException

Remove the specified expression from this attribute.

Parameters:

expr - The expression to remove.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

setExpression

public void setExpression(MapConnectorPoint scopingInputPoint,
                 MapExpression expr)
                   throws oracle.odi.domain.mapping.exception.MapComponentException

Sets an expression with an associated scoping input connector point for the attribute, for the case where there are multiple expressions for an attribute (e.g. set operator).

Parameters:

scopingInputPoint - An input point of the owning component, that will be associated with the expression.

expr - The expression to set.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

setExpression

public void setExpression(MapConnectorPoint scopingInputPoint,
                 MapAttribute sourceAttribute,
                 MapPathSpecifier path)
                   throws MappingException,
                          AdapterException

Sets an input expression with an associated scoping input connector point, for the case where there are multiple input expressions (e.g. set operator). The expression value is specified by a source attribute, and component-level auto-connection to the target owner of this attribute is done, if possible.

Parameters:

scopingInputPoint - The scoping input point associated with the expression value.

sourceAttribute - The source attribute to be connected.

path - The path specifier that specifies the path to connect, if necessary, else null.

Throws:

PropertyException

oracle.odi.domain.mapping.exception.MapComponentException

AdapterException

MappingException

setExpressionText

public void setExpressionText(MapConnectorPoint scopingInputPoint,
                     java.lang.String expressionText)
                       throws MappingException

Sets an input expression text with an associated scoping input connector point, for the case where there are multiple input expressions (e.g. set operator).

Parameters:

scopingInputPoint - The scoping input point associated with the expression.

expressionText - The new expression text.

Throws:

PropertyException

oracle.odi.domain.mapping.exception.MapComponentException

MappingException

getExpressions

public java.util.List getExpressions()

Return the list of expressions for this attribute.

getExpression

public MapExpression getExpression()

Return the expression for this attribute. For use in the common case when only one expression is defined for the attribute.

getExpression

public MapExpression getExpression(int pIndex)

Retrieves the expression associated with this attribute at the given index. Many attributes will have only one expression with index of 0. However some attributes such as a set component attribute, will have multiple expressions representing the different scoping input points that are combined to produce the projected value.

Parameters:

pIndex - The expression index.

Returns:

null if the index is greater than expressions list size.

getMapRootContainer

public IMapRootContainer getMapRootContainer()

Get the top-level mapping that contains this attribute.

Specified by:

getMapRootContainer in interface IMapExpressionOwner

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

getProjectorSourceComponents

public java.util.Set getProjectorSourceComponents()
                                           throws MappingException,
                                                  AdapterException

Return the components that act as the projector source for this attribute, based on the attribute input expression reference, or null if none found.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

oracle.odi.domain.mapping.expression.parser.ExpressionParseException

PropertyException

AdapterException

MappingException

isProjectorAttribute

public boolean isProjectorAttribute()

Return true if this attribute is a source projector attribute (not a decorator attribute).

getBoundObject

public IModelObject getBoundObject()
                            throws AdapterException

Return the bound object for this attribute, or null if no bound object is defined. A bound object for an attribute would typically be a column or related object.

Throws:

AdapterException

isBoundAttribute

public boolean isBoundAttribute()

Return true if this attribute is bound to a model object (e.g. column).

getBoundObjectName

public java.lang.String getBoundObjectName()
                                    throws MappingException,
                                           AdapterException

Get the attribute bound object name, if it is available from an attribute delegate, else null.

Returns:

The bound object name for the attribute.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

AdapterException

MappingException

getBoundObjectFullName

public java.lang.String getBoundObjectFullName()
                                        throws oracle.odi.domain.mapping.exception.MapComponentException,
                                               AdapterException

Get the full qualified name of the bound object.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

AdapterException

setIsRequired

public void setIsRequired(boolean value)

Sets a flag that indicates that this attribute is required to be connected when used in a mapping.

Parameters:

value -

isRequired

public boolean isRequired()

Returns true if this attribute is required to be connected when used in a mapping, else false.

getBoundColumn

public IColumn getBoundColumn()
                       throws AdapterException

Get the column object to which this attribute is bound, if any, else return null.

Throws:

AdapterException

getDataType

public IDataType getDataType()
                      throws AdapterException,
                             MappingException

Throws:

AdapterException

MappingException

setDataType

public void setDataType(IDataType dataType)
                 throws MappingException,
                        AdapterException

Set the data type of this attribute. This should only be called for unbound attributes. The data type of a bound attribute will be the data type of the bound column, if any.

Parameters:

dataType - The data type to set for this attribute.

Throws:

MappingException

AdapterException

setDataType

public void setDataType(IDataType dataType,
               java.lang.Integer size)
                 throws MappingException,
                        AdapterException

Set the data type of this attribute. This should only be called for unbound attributes. The data type of a bound attribute will be the data type of the bound column, if any.

Parameters:

dataType - The data type to set for this attribute.

size - The data size (precision or length) for this attribute. Should be called only when data size is relevant. Setting data size to null has meaning, it means that the value is not set and a default value will be used during code generation.

Throws:

MappingException

AdapterException

setDataType

public boolean setDataType(IDataType dataType,
                  java.lang.Integer size,
                  java.lang.Integer scale)
                    throws MappingException,
                           AdapterException

Set the data type of this attribute. This should only be called for unbound attributes. The data type of a bound attribute will be the data type of the bound column, if any.

Parameters:

dataType - The data type to set for this attribute.

size - The data size (precision or length) for this attribute. Should be called only when data size is relevant. Setting data size to null has meaning, it means that the value is not set and a default value will be used during code generation.

scale - The scale value for this attribute. A null Setting data scale to null has meaning, it means that the value is not set and a default value will be used during code generation.

Returns:

True if the data type has changed.

Throws:

MappingException

AdapterException

getDataTypeString

public java.lang.String getDataTypeString()

Get the datatype name string. Called by attribute datatype property definition.

Returns:

The datatype string.

setDataTypeString

public void setDataTypeString(java.lang.String dataTypeName)
                       throws MappingException,
                              AdapterException

Set the data type for the attribute by name. The bound column technology will be searched, or if there is no bound column, the mapping generic technology will be searched to find the data type with the specified name.

Parameters:

dataTypeName -

Throws:

MappingException

AdapterException

setDataTypeCode

public void setDataTypeCode(java.lang.String technoCode,
                   java.lang.String dataTypeCode)
                     throws MappingException,
                            AdapterException

odiInternal

Parameters:

technoCode -

dataTypeCode -

Throws:

MappingException

AdapterException

getDdlDataType

public java.lang.String getDdlDataType()
                                throws AdapterException,
                                       MappingException

Get the generated DDL data type or code generation data type for the attribute, if a column is being created to match the attribute.

Returns:

The DDL data type string.

Throws:

AdapterException

MappingException

getSize

public java.lang.Integer getSize()
                          throws AdapterException,
                                 MappingException

Get the data size (precision or length) of this attribute. A value of null means that the value is not explicitly set, and a default value will be used for code generation.

Throws:

AdapterException

MappingException

setSize

public void setSize(java.lang.Integer value)
             throws AdapterException

Set the data size (precision or length) for this attribute. A value of null means that the value is not explicitly set, and a default value will be used for code generation.

Parameters:

value - The data size value to be set.

Throws:

AdapterException

getScale

public java.lang.Integer getScale()
                           throws AdapterException,
                                  MappingException

Get the data scale for this attribute. A value of null means that the value is not explicitly set, and a default value will be used for code generation.

Throws:

AdapterException

MappingException

setScale

public void setScale(java.lang.Integer value)
              throws AdapterException

Set the data scale for this attribute. A value of null means that the value is not explicitly set, and a default value will be used for code generation.

Throws:

AdapterException

MappingException

isScaleSet

public boolean isScaleSet()

Return true if the scale for this attribute has ever been explicitly set, else false.

Throws:

AdapterException

isSizeSet

public boolean isSizeSet()

Return true if the precision for this attribute has ever been explicitly set, else false.

isReferenced

public boolean isReferenced()

Return true if this attribute is referenced by a downstream expression in the mapping graph.

connectTo

public void connectTo(MapAttribute tgtAttribute,
             MapPathSpecifier path)
               throws MappingException,
                      AdapterException

Set this source attribute as the source expression for the specified target attribute. Connections will be added as necessary to put the source component into scope for the target component, and the expression for the target will be set so that it references the source attribute.
Specific component delegates may override this method to implement special behavior.
This method will do the following:

• 1) Check to see if the source component is in scope for the target component if not, then make the necessary connections to put it into scope.
• 2) Set the expression for the target attribute, so that it references the source attribute.

Parameters:

tgtAttribute - The target attribute.

path - The path that should be used to connect components, if connection must be made. If null, then it is assumed that only one path is possible.

Throws:

AdapterException

PropertyException

oracle.odi.domain.mapping.exception.MapComponentException

oracle.odi.domain.mapping.expression.parser.ExpressionParseException

MappingException

connectTo

public void connectTo(MapAttribute tgtAttribute)
               throws MappingException,
                      AdapterException

Set this source attribute as the source expression for the specified target attribute. Connections will be added as necessary to put the source component into scope for the target component, and the expression for the target will be set so that it references the source attribute.
Specific component delegates may override this method to implement special behavior.
This method will do the following:

• 1) Check to see if the target component is somehow connected to the source, and if not, then make the connection.
• 2) Set the expression for the target attribute, so that it references the source attribute.

Parameters:

tgtAttribute - The target attribute.

Throws:

AdapterException

PropertyException

oracle.odi.domain.mapping.exception.MapComponentException

oracle.odi.domain.mapping.expression.parser.ExpressionParseException

MappingException

connectTo

public void connectTo(IMapComponent targetComponent,
             MapPathSpecifier path)
               throws MappingException,
                      AdapterException

Add this source attribute to the scope for the specified target component. Connections will be made as necessary to put the source attribute into scope for the target. Also, a new target attribute will be created if the target component allows attributes to be added. The new attribute name will match the source attribute name as closely as possible (a uniqueness suffix will be added if necessary to make the name unique in the connector point), and the expression for the new target attribute will be set to a simple reference of the source attribute.

Parameters:

targetComponent - The target component.

path - The path specifier which specifies the connection path if necessary, or null.

Throws:

AdapterException

PropertyException

oracle.odi.domain.mapping.exception.MapComponentException

oracle.odi.domain.mapping.expression.parser.ExpressionParseException

MappingException

connectTo

public void connectTo(IMapComponent targetComponent)
               throws MappingException,
                      AdapterException

Add this source attribute to the scope for the specified target component. Connections will be made as necessary to put the source attribute into scope for the target. Also, a new target attribute will be created if the target component allows attributes to be added. The new attribute name will match the source attribute name as closely as possible (a uniqueness suffix will be added if necessary to make the name unique in the connector point), and the expression for the new target attribute will be set to a simple reference of the source attribute.

Parameters:

targetComponent - The target component.

Throws:

AdapterException

PropertyException

oracle.odi.domain.mapping.exception.MapComponentException

oracle.odi.domain.mapping.expression.parser.ExpressionParseException

MappingException

connectTo

public void connectTo(MapConnectorPoint point)
               throws MappingException,
                      AdapterException

Connect this source attribute to the specified target connector point. The ODI mapping does not technically support attribute-level connectivity, but the attribute will be connected to the connector point in the sense of making sure that the source attribute is in scope for the target component expressions.
Specific component delegates may override this method to implement special behavior.
This method will do the following:

• 1) Check to see if the source component is somehow connected to the target connector point, and if not, then make the connection. The connection may be made through some selector components.

Parameters:

point - The target connector point.

Throws:

AdapterException

PropertyException

oracle.odi.domain.mapping.exception.MapComponentException

MappingException

validate

public boolean validate(java.util.List result,
               boolean debug)

Validates the object. Check all properties, parse all expressions and check for reference or connection errors. If errors or warnings are found, they are returned as a list of RootIssue instances.

Specified by:

validate in interface IRoot

Overrides:

validate in class oracle.odi.domain.root.PropertyOwner

Parameters:

result - A list of issues that were found by validation.

debug - If true, then informational issues are added that provide information about the structure of the metadata and the state of this object.

Returns:

true if any errors were found, else false.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

reorderAttribute

public void reorderAttribute(MapAttribute attr,
                    java.lang.Integer newPos)
                      throws oracle.odi.domain.mapping.exception.MapComponentException,
                             PropertyException,
                             AdapterException

Description copied from interface: IMapAttributeOwner

Change the order of the specified attribute in the ordered list. The attribute must be contained by this connector point, or an exception is thrown. If the zero-based index is out of range, an exception is thrown.
Note: Bound attributes that are not referenced by any expression may be transient attributes. In that case, the order will only be changed for the current client session, but will not be permanently changed.

Specified by:

reorderAttribute in interface IMapAttributeOwner

Parameters:

attr - The attribute whose order is to be changed.

newPos - The new index of the attribute. Null represents undefined/unset/unknown.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

AdapterException

getAttributeCount

public int getAttributeCount()
                      throws oracle.odi.domain.mapping.exception.MapComponentException,
                             PropertyException,
                             AdapterException

Description copied from interface: IMapAttributeOwner

Get the total number of attributes owned by this connector point.

Specified by:

getAttributeCount in interface IMapAttributeOwner

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

AdapterException

createAttribute

public MapAttribute createAttribute(java.lang.String name,
                           boolean isPersistent)
                             throws MappingException,
                                    AdapterException

Specified by:

createAttribute in interface IMapAttributeOwner

Parameters:

name - The name for the new projector attribute.

isPersistent - If true, a persistent attribute is created, else a transient attribute is created.

Returns:

The newly created attribute. Transient attributes should be created for bound attributes that are not referenced by any expression. They can be recreated using the information from the component's bound object when the interface is reloaded. The attribute will be automatically changed to be persistent if a reference to it is created by an expression.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

MappingException

AdapterException

createAttribute

public MapAttribute createAttribute(MapAttribute sourceAttr)
                             throws MappingException,
                                    AdapterException

Description copied from interface: IMapAttributeOwner

Create an attribute that is a copy of the specified source attribute. The name and data type are copied.

Specified by:

createAttribute in interface IMapAttributeOwner

Returns:

The newly created attribute.

Throws:

MappingException

AdapterException

createAttribute

public MapAttribute createAttribute(java.lang.String name)
                             throws MappingException,
                                    AdapterException

Specified by:

createAttribute in interface IMapAttributeOwner

Parameters:

name - The name for the new projector attribute.

Returns:

The newly created attribute.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

MappingException

AdapterException

removeAttribute

public void removeAttribute(MapAttribute attr)
                     throws oracle.odi.domain.mapping.exception.MapComponentException

Description copied from interface: IMapAttributeOwner

Remove the specified attribute from this connector point.

Specified by:

removeAttribute in interface IMapAttributeOwner

Parameters:

attr - The attribute to be removed.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

removeAttribute

public void removeAttribute(MapAttribute attr,
                   boolean removeReferencedExpressions)
                     throws oracle.odi.domain.mapping.exception.MapComponentException

Description copied from interface: IMapAttributeOwner

Remove the specified attribute from this connector point.

Specified by:

removeAttribute in interface IMapAttributeOwner

Parameters:

attr - The attribute to be removed.

removeReferencedExpressions - If true, then any expressions that reference the removed attribute will be removed.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

removeAttribute

public void removeAttribute(java.lang.String name)
                     throws oracle.odi.domain.mapping.exception.MapComponentException

Description copied from interface: IMapAttributeOwner

Remove the attribute with the specified name from this connector point.

Specified by:

removeAttribute in interface IMapAttributeOwner

Parameters:

name - The name of the attribute to be removed.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

removeAttribute

public void removeAttribute(java.lang.String name,
                   boolean removeReferencedExpressions)
                     throws oracle.odi.domain.mapping.exception.MapComponentException

Description copied from interface: IMapAttributeOwner

Remove the attribute with the specified name from this connector point.

Specified by:

removeAttribute in interface IMapAttributeOwner

Parameters:

name - The name of the attribute to be removed.

removeReferencedExpressions - If true, then any expressions that reference the removed attribute will be removed.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

getAttributes

public java.util.List getAttributes()
                             throws oracle.odi.domain.mapping.exception.MapComponentException,
                                    PropertyException,
                                    AdapterException

Description copied from interface: IMapAttributeOwner

Retrieve a list of all the attributes owned by this connector point.

Specified by:

getAttributes in interface IMapAttributeOwner

Returns:

The list of all the attributes.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

AdapterException

findAttribute

public MapAttribute findAttribute(java.lang.String name)
                           throws oracle.odi.domain.mapping.exception.MapComponentException,
                                  PropertyException,
                                  AdapterException

Description copied from interface: IMapAttributeOwner

Find an attribute owned by this connector point, with the specified name.

Specified by:

findAttribute in interface IMapAttributeOwner

Parameters:

name - The name of the attribute to fetch.

Returns:

The attribute with the specified name, or null if not found.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

AdapterException

getDisplayableTypeName

public java.lang.String getDisplayableTypeName()

Description copied from interface: IRoot

Get a user-displayable type name for the object.

Specified by:

getDisplayableTypeName in interface IPropertyOwner

Specified by:

getDisplayableTypeName in interface IRoot

Specified by:

getDisplayableTypeName in class oracle.odi.domain.root.PropertyOwner

Returns:

The displayable type name.

getExecuteOnHint

public MapExpression.ExecuteOnLocation getExecuteOnHint()
                                                 throws MappingException

Get the execute-on hint for the expression of this attribute, for the simple case where this attribute only has one expression.

Throws:

MappingException

setExecuteOnHint

public void setExecuteOnHint(MapExpression.ExecuteOnLocation loc)
                      throws MappingException

Set the execute location hint for the attribute expression. Can only be used if this attribute only has one expression.

Parameters:

loc - The hint location.

Throws:

MappingException

setExecuteOnHint

public void setExecuteOnHint(MapExpression.ExecuteOnLocation loc,
                    MapConnectorPoint scopingInputPoint)
                      throws MappingException

Set the execute location hint for the attribute expression. If a scoping input point is specified, then use it to choose a specific expression for which to set the hint.

Parameters:

loc - The hint location.

scopingInputPoint - The scoping input point for the expression, or null if there is only one expression for this attribute, or if all expressions will get the same hint.

Throws:

MappingException

getExecuteOnLocation

public ILogicalSchema getExecuteOnLocation()
                                    throws MappingException,
                                           AdapterException

Get the execute-on location logical schema name for the expression of this attribute. Use only in the simple case where this attribute only has one expression.

Throws:

MappingException

AdapterException

setExecuteOnLocationByName

public void setExecuteOnLocationByName(java.lang.String locName)
                                throws MappingException,
                                       AdapterException

Set the execute-on location logical schema name for the expression of this attribute. Use only in the simple case where this attribute only has one expression.

Parameters:

locName - The name of the logical schema to set as the expression location.

Throws:

MappingException

AdapterException

setExecuteOnLocation

public void setExecuteOnLocation(ILogicalSchema loc)
                          throws MappingException,
                                 AdapterException

Set the fixed execute location for the attribute expression.

Parameters:

loc - The fixed location.

Throws:

MappingException

AdapterException

setExecuteOnLocation

public void setExecuteOnLocation(ILogicalSchema loc,
                        MapConnectorPoint scopingInputPoint)
                          throws MappingException,
                                 AdapterException

Set the fixed execute location for the attribute expression. If a scoping input point is specified, then use it to choose a specific expression for which to set the location.

Parameters:

loc - The fixed location.

scopingInputPoint - The scoping input point for the expression, or null if there is only one expression for this attribute, or if all expressions will get the same hint.

Throws:

MappingException

AdapterException

getReferencingComponents

public java.util.List getReferencingComponents()
                                        throws oracle.odi.domain.mapping.exception.MapComponentException

Get a list of target components that reference this attribute.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

dumpAttributeList

public static void dumpAttributeList(java.util.List attrList)
                              throws PropertyException

A utility method to dump a specified list of attributes for a specified component to the console.

Parameters:

attrList - The list of attributes to be dumped.

Throws:

PropertyException

isKeyIndicator

public boolean isKeyIndicator()
                       throws PropertyException

Return true if this attribute acts as a key indicator in the component.

Throws:

PropertyException

setKeyIndicator

public void setKeyIndicator(boolean keyIndicator)
                     throws PropertyException

Set the boolean key indicator property value to the specified value. The key indicator indicates that this attribute's bound column participates in a key constraint.

Parameters:

keyIndicator -

Throws:

PropertyException

setActive

public void setActive(boolean isActive)
               throws PropertyException

Set the active state of this attribute. The active state determines whether the attribute will be used during code generation, or ignored.

Parameters:

isActive - The active state value to set.

Throws:

PropertyException

isInsertIndicator

public boolean isInsertIndicator()
                          throws PropertyException

Return true if the attribute participates in an insert operation when loading the target data storage object.

Throws:

PropertyException

setInsertIndicator

public void setInsertIndicator(boolean insertIndicator)
                        throws PropertyException

Set the insert indicator state for the attribute. The insert indicator state will indicate whether this attribute's value will participate in an insert operation when loading the target data storage object.

Throws:

PropertyException

isUpdateIndicator

public boolean isUpdateIndicator()
                          throws PropertyException

Return true if the attribute participates in an update operation when loading the target data storage object.

Throws:

PropertyException

setUpdateIndicator

public void setUpdateIndicator(boolean updateIndicator)
                        throws PropertyException

Set the update indicator state for the attribute. The update indicator state will indicate whether this attribute's value will participate in an update operation when loading the target data storage object.

Throws:

PropertyException

isCheckNotNullIndicator

public boolean isCheckNotNullIndicator()
                                throws PropertyException

Return true if the attribute will be checked for non-null value when loading the target data storage object.

Throws:

PropertyException

setCheckNotNullIndicator

public void setCheckNotNullIndicator(boolean notNullIndicator)
                              throws PropertyException

Set the check not null indicator state for the attribute. The check not null indicator state will indicate whether this attribute's value will be checked for a null value when loading the target data storage object.

Throws:

PropertyException

isActive

public boolean isActive()
                 throws PropertyException

Get the active state of this attribute. The active state determines whether this attribute will participate in the loading of the target data storage object.

Throws:

PropertyException

isSourceAttribute

public boolean isSourceAttribute()
                          throws MappingException

Throws:

MappingException

isTargetAttribute

public boolean isTargetAttribute()
                          throws MappingException

Return true if this attribute is a target attribute. A target attribute is simple an attribute owned by a target component.

Throws:

MappingException

getRefText

public java.lang.String getRefText()
                            throws AdapterException

Description copied from interface: IExpressionReferencedObject

Gets the reference text for this object. The reference text is the text that would be used in an expression to reference this object.

Specified by:

getRefText in interface IExpressionReferencedObject

Returns:

the reference text.

Throws:

AdapterException

getMinimizedRefText

public java.lang.String getMinimizedRefText()
                                     throws AdapterException

Description copied from interface: IExpressionReferencedObject

Gets the minimized reference text for this object. The minimized reference text is the text that would be used in an expression to reference this object, without any parent composite component (dataset) qualifiers.

Specified by:

getMinimizedRefText in interface IExpressionReferencedObject

Returns:

the minimized reference text.

Throws:

AdapterException

isCheckNotNull

public boolean isCheckNotNull()

Return true if the bound column will be checked for non-null value when loading the target data storage object.

Throws:

PropertyException

toString

public java.lang.String toString()

Overrides:

toString in class oracle.odi.domain.root.Root

setPropertyValue

public void setPropertyValue(java.lang.String key,
                    java.lang.Object value)
                      throws PropertyException

An attribute which owns any property that has had a non-default value set should be persisted.

Specified by:

setPropertyValue in interface IPropertyOwner

Overrides:

setPropertyValue in class oracle.odi.domain.root.PropertyOwner

Parameters:

key - The name of the property whose value will be set.

value - The object value of the property. The interpretation of the object type will be determined by the type of the property.

Throws:

PropertyException

getSyncState

public IMappingObject.SyncState getSyncState()

Specified by:

getSyncState in interface IMappingObject

Overrides:

getSyncState in class oracle.odi.domain.root.Root

getTechnicalDescription

public java.lang.String getTechnicalDescription()
                                         throws PropertyException

Get the technical description of this attribute.

Throws:

PropertyException

invokeMethod

public java.lang.Object invokeMethod(java.lang.String methodName,
                            java.lang.Object[] args)
                              throws PropertyException

Specified by:

invokeMethod in interface IPropertyOwner

Overrides:

invokeMethod in class oracle.odi.domain.root.PropertyOwner

Returns:

The return object of the invoked method, if any.

Throws:

PropertyException