oracle.odi.domain.mapping

Interface IMapAttributeOwner

All Known Implementing Classes:

InputConnectorPoint, MapAttribute, MapConnectorPoint, OutputConnectorPoint

public interface IMapAttributeOwner

An interface to represent an object that owns MapAttribute instances, typically a MapConnectorPoint, but it can also be a MapAttribute for complex data types.

Method Summary

Modifier and Type	Method and Description
MapAttribute	createAttribute(MapAttribute sourceAttr) Create an attribute that is a copy of the specified source attribute.
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.
void	removeAttribute(MapAttribute attr) Remove the specified attribute from this connector point.
void	removeAttribute(MapAttribute attr, boolean removeReferencingExpressions) 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 removeReferencingExpressions) Remove the attribute with the specified name from this connector point.
void	reorderAttribute(MapAttribute attr, java.lang.Integer newIndex) Change the order of the specified attribute in the ordered list.

Method Detail

reorderAttribute

void reorderAttribute(MapAttribute attr,
                      java.lang.Integer newIndex)
               throws MappingException,
                      AdapterException

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.

Parameters:

attr - The attribute whose order is to be changed.

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

Throws:

AdapterException

PropertyException

oracle.odi.domain.mapping.exception.MapComponentException

MappingException

getAttributeCount

int getAttributeCount()
               throws MappingException,
                      AdapterException

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

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

AdapterException

MappingException

removeAttribute

void removeAttribute(MapAttribute attr)
              throws MappingException

Remove the specified attribute from this connector point.

Parameters:

attr - The attribute to be removed.

Throws:

MappingException

removeAttribute

void removeAttribute(MapAttribute attr,
                     boolean removeReferencingExpressions)
              throws MappingException

Remove the specified attribute from this connector point.

Parameters:

attr - The attribute to be removed.

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

Throws:

MappingException

removeAttribute

void removeAttribute(java.lang.String name)
              throws MappingException

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

Parameters:

name - The name of the attribute to be removed.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

MappingException

removeAttribute

void removeAttribute(java.lang.String name,
                     boolean removeReferencingExpressions)
              throws MappingException

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

Parameters:

name - The name of the attribute to be removed.

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

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

MappingException

getAttributes

java.util.List getAttributes()
                      throws MappingException,
                             AdapterException

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

Returns:

The list of all the attributes.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

PropertyException

AdapterException

MappingException

findAttribute

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

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

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

MappingException

createAttribute

MapAttribute createAttribute(MapAttribute sourceAttr)
                      throws MappingException,
                             AdapterException

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

Parameters:

sourceAttr -

Returns:

The newly created attribute.

Throws:

MappingException

AdapterException