oracle.odi.domain.mapping

Interface IMapComponentOwner

All Superinterfaces:

IMappingObject, INamedObject, IPropertyOwner, IRepositoryEntity, IRoot

All Known Subinterfaces:

IMapComponent, IMapRootContainer, IMapSignatureOwner

All Known Implementing Classes:

CubeComponent, DimensionComponent, ExpandableComponentDelegate, ReusableMapping

public interface IMapComponentOwner
extends IPropertyOwner

An mapping used to specify an ODI mapping component owner. A component owner is an object that owns logical mapping components.

Method Summary

Modifier and Type	Method and Description
void	addComponent(IMapComponent comp) Adds a component to the mapping.
boolean	containsComponent(IMapComponent comp) Return true if this component owner (may be a composite component) contains the specified component as an sub-component.
IMapComponent	createComponent(java.lang.String type, IModelObject boundObject) Creates a component with the specified type and name, bound to the specified object.
IMapComponent	createComponent(java.lang.String type, IModelObject boundObject, boolean enableAutoJoin) Creates a component with the specified type and name, bound to the specified object.
IMapComponent	createComponent(java.lang.String type, java.lang.String name) Creates a component with the specified type and name.
java.util.List	findAllComponents(java.lang.String name) Finds all component owned by this component owner and any sub-component owners, with the specified name.
IMapComponent	findComponent(java.lang.String name) Finds a component owned by this component owner, with the specified name.
IMapComponent	findComponentBoundTo(IModelObject modelObj) Find a component that is bound to the specified model object, and directly owned by this component owner.
IMapComponent	findComponentOfType(java.lang.String name, java.lang.String type) Find the named component of the specified type, within the component owner.
java.util.List	findComponentsBoundTo(IModelObject modelObj) Find all components that are bound to the specified model object, and directly owned by this component owner.
MapConnector	findConnector(java.lang.String name) Find a named connector with the specified name.
IMapComponentOwner	findSubComponentOwner(java.lang.String name) Find the sub-component owner with the specified name.
java.util.List	getAllComponents() Return a list containing all the components owned by this object, including subcomponents of the directly owned components.
java.util.List	getAllComponentsOfType(java.lang.String typeName) Get a list of all the components of the specified type that are owned by this object and it's sub-objects.
java.util.List	getAllSignatureOwnerHolders() Return a list of components that are signature owner holder type components, for example reusable mapping or expandable mapping.
java.util.List	getAllSubComponentOwners() Return a list containing all composite components that are also component owners.
int	getComponentCount() Get the number of components that are directly owned by this component owner.
java.util.List	getComponents() Return a list containing just the top level components, that are directly owned by this object.
java.util.List	getLeafLevelComponents() Return a list of the leaf-level (lowest-level) components owned by this component owner.
java.util.List	getLeafLevelEndpoints() Get a list of leaf-level components that are end points in the graph.
java.util.List	getLeafLevelTargets() Get a list of leaf-level components that are targets.
IMapRootContainer	getMapRootContainer() Get the parent mapping for this component owner.
java.util.List	getSources() Get a list of all components that have output connections but no input connections, not including passive components.
java.util.List	getTargets() Get a list of all components that have input connections but no output connections.
java.util.List	getTopLevelComponentsOfType(java.lang.String typeName) Get a list of all the components of the specified type, that are directly owned by this object
java.util.List	getTopLevelSources() Get a list of top level components that have output connections but no input connections, not including passive components.
java.util.List	getTopLevelTargets() Get a list of top level components that have input connections but no output connections.
java.util.List	getUpstreamLeafAttributes(IMapComponent component) Get all upstream attributes for the specified target component.
java.util.List	getUpstreamLeafAttributes(MapConnectorPoint point) Get all upstream leaf attributes for the specified target connector point.
java.util.List	getUpstreamLeafConnectorPoints(MapConnectorPoint point) Get all upstream leaf connector points for the specified target connector point.
java.util.List	getUpstreamLeafSources(IMapComponent comp) Get the upstream leaf component sources for the specified component.
boolean	isComponent() Return true if this component owner is also a mappingComponent instance.
boolean	isExpandableComponent() Return true if this component owner is an expandable mapping component.
boolean	isSignatureOwner() Return true if this component owner supports owning signature components.
void	removeComponent(IMapComponent comp) Removes a component from the mapping.
void	removeComponent(IMapComponent comp, boolean removeReferencingExpressions) Removes a component from the mapping.

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

addProperty, createProperty, getAllProperties, getBooleanPropertyValue, getDisplayableProperties, getDisplayableTypeName, getExpressionPropertyValue, getIntPropertyValue, getProperties, getProperty, getPropertyValue, getStringPropertyValue, isPropertyDefined, setBooleanPropertyValue, setIntPropertyValue, setPropertyValue

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

getBusinessName, getDescription, getName, setBusinessName, setDescription, setName

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

dump, dump, getDisplayableObjectName, getGUID, getOwner, getStrongTypeClassName, validate, validate, validate

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

getRootContainer

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getInternalId, getParent

Method Detail

getAllComponents

java.util.List getAllComponents()
                         throws MapComponentException

Return a list containing all the components owned by this object, including subcomponents of the directly owned components.

Throws:

MapComponentException

getComponents

java.util.List getComponents()
                      throws MappingException

Return a list containing just the top level components, that are directly owned by this object.

Throws:

MapComponentException

MappingException

getAllSubComponentOwners

java.util.List getAllSubComponentOwners()
                                 throws MapComponentException

Return a list containing all composite components that are also component owners. Includes all recursively defined owners.

Throws:

MapComponentException

getAllSignatureOwnerHolders

java.util.List getAllSignatureOwnerHolders()
                                    throws MappingException

Return a list of components that are signature owner holder type components, for example reusable mapping or expandable mapping.

Throws:

MappingException

getComponentCount

int getComponentCount()

Get the number of components that are directly owned by this component owner.

getAllComponentsOfType

java.util.List getAllComponentsOfType(java.lang.String typeName)
                               throws MappingException

Get a list of all the components of the specified type that are owned by this object and it's sub-objects.

Parameters:

typeName - The name of the component type to return.

Throws:

MapComponentException

MappingException

getTopLevelComponentsOfType

java.util.List getTopLevelComponentsOfType(java.lang.String typeName)
                                    throws MappingException

Get a list of all the components of the specified type, that are directly owned by this object

Parameters:

typeName - The name of the component type to return.

Throws:

MapComponentException

MappingException

createComponent

IMapComponent createComponent(java.lang.String type,
                              java.lang.String name)
                       throws MappingException,
                              AdapterException

Creates a component with the specified type and name. This method is recommended for creating components which are not bound to a model object. The returned instance will be a component delegate that implements the IMapComponent interface, so it can be cast to a specific delegate class type.
Example:
LookupComponent lookup = (LookupComponent) mapping.createComponent(LookupComponent.COMPONENT_TYPE_NAME, "dept_lookup");

Parameters:

type - The type name of the component. The type name is not a full class name, it is a short component type name string recognized by the component type registry. The component name for each component is part of its definition. The component type names are normally defined as a static variable in the component delegate class. For example the component type name for the join component is found in JoinComponent.COMPONENT_TYPE_NAME. The standard built-in component delegate classes are found in package oracle.odi.domain.mapping.component. The built-in types are:

• AggregateComponent.COMPONENT_TYPE_NAME
• Dataset.COMPONENT_TYPE_NAME
• DatastoreComponent.COMPONENT_TYPE_NAME
• DistinctComponent.COMPONENT_TYPE_NAME
• ExpressionComponent.COMPONENT_TYPE_NAME
• FileComponent.COMPONENT_TYPE_NAME
• FilterComponent.COMPONENT_TYPE_NAME
• InputSignature.COMPONENT_TYPE_NAME
• JoinComponent.COMPONENT_TYPE_NAME
• LookupComponent.COMPONENT_TYPE_NAME
• OutputSignature.COMPONENT_TYPE_NAME
• PivotComponent.COMPONENT_TYPE_NAME
• ReusableMappingComponent.COMPONENT_TYPE_NAME
• SetComponent.COMPONENT_TYPE_NAME
• SorterComponent.COMPONENT_TYPE_NAME
• SplitterComponent.COMPONENT_TYPE_NAME
• SubqueryFilterComponent.COMPONENT_TYPE_NAME
• TableFunctionComponent.COMPONENT_TYPE_NAME
• UnpivotComponent.COMPONENT_TYPE_NAME

name - The name of the new component.

Throws:

MapComponentException

PropertyException

AdapterException

MappingException

createComponent

IMapComponent createComponent(java.lang.String type,
                              IModelObject boundObject,
                              boolean enableAutoJoin)
                       throws AdapterException,
                              MappingException

Creates a component with the specified type and name, bound to the specified object. The returned instance will be a strong-typed component delegate that implements the IMapComponent interface, so it can be cast to a specific delegate class type.
Example:
DatastoreComponent inventorySource = (DatastoreComponent)mapping.createComponent(DatastoreComponent.COMPONENT_TYPE_NAME, inventory_datastore, true);

Parameters:

type - The type name of the component. The type name is not a full class name, it is a short component type name string recognized by the component type registry. The component name for each component is part of its definition. The component type names are normally defined as a static variable in the component delegate class. For example the component type name for the join component is found in JoinComponent.COMPONENT_TYPE_NAME. The standard built-in component delegate classes are found in package oracle.odi.domain.mapping.component. The built-in types are:

• AggregateComponent.COMPONENT_TYPE_NAME
• Dataset.COMPONENT_TYPE_NAME
• DatastoreComponent.COMPONENT_TYPE_NAME
• DistinctComponent.COMPONENT_TYPE_NAME
• ExpressionComponent.COMPONENT_TYPE_NAME
• FileComponent.COMPONENT_TYPE_NAME
• FilterComponent.COMPONENT_TYPE_NAME
• InputSignature.COMPONENT_TYPE_NAME
• JoinComponent.COMPONENT_TYPE_NAME
• LookupComponent.COMPONENT_TYPE_NAME
• OutputSignature.COMPONENT_TYPE_NAME
• PivotComponent.COMPONENT_TYPE_NAME
• ReusableMappingComponent.COMPONENT_TYPE_NAME
• SetComponent.COMPONENT_TYPE_NAME
• SorterComponent.COMPONENT_TYPE_NAME
• SplitterComponent.COMPONENT_TYPE_NAME
• SubqueryFilterComponent.COMPONENT_TYPE_NAME
• TableFunctionComponent.COMPONENT_TYPE_NAME
• UnpivotComponent.COMPONENT_TYPE_NAME

boundObject - An object to which the component is bound. The bound object will typically be a repository object that is associated with this component and from which this component will derive attribute information. The bound object must implement the IModelObject mapping. It can be a native ODI object, a native non-ODI repository object, or an adapter that wraps a native repository object and implements IModelObject. Objects of type IDataStore are the most common bound objects used with a component. If a raw native object that does not implement IModelObject is passed in, the appropriate adapter will be invoked to attempt to create an adapter wrapper object for it. If this cannot be done, an exception will be thrown.

enableAutoJoin - If true, enables the auto-creation of join components that that join new source components based on relationships between the bound objects.

Throws:

MapComponentException

PropertyException

ExpressionParseException

AdapterException

MapPhysicalException

MappingException

createComponent

IMapComponent createComponent(java.lang.String type,
                              IModelObject boundObject)
                       throws AdapterException,
                              MappingException

Creates a component with the specified type and name, bound to the specified object. This default version of the method does not enable auto-join creation. This method is recommended for creating components such as FileComponent, DatastoreComponent, and ReusableMappingComponent, which are bound to model objects used as a source or target. The returned instance will be a strong-typed component delegate that implements the IMapComponent interface, so it can be cast to a specific delegate class type.
Example:
ReusableMappingComponent rmc = (ReusableMappingComponent) mapping.createComponent(ReusableMappingComponent.COMPONENT_TYPE_NAME, myReusableMapping);

Parameters:

type - The type name of the component. The type name is not a full class name, it is a short component type name string recognized by the component type registry. The component name for each component is part of its definition. The component type names are normally defined as a static variable in the component delegate class. For example the component type name for the join component is found in JoinComponent.COMPONENT_TYPE_NAME. The standard built-in component delegate classes are found in package oracle.odi.domain.mapping.component. The built-in types are:

• AggregateComponent.COMPONENT_TYPE_NAME
• Dataset.COMPONENT_TYPE_NAME
• DatastoreComponent.COMPONENT_TYPE_NAME
• DistinctComponent.COMPONENT_TYPE_NAME
• ExpressionComponent.COMPONENT_TYPE_NAME
• FileComponent.COMPONENT_TYPE_NAME
• FilterComponent.COMPONENT_TYPE_NAME
• InputSignature.COMPONENT_TYPE_NAME
• JoinComponent.COMPONENT_TYPE_NAME
• LookupComponent.COMPONENT_TYPE_NAME
• OutputSignature.COMPONENT_TYPE_NAME
• PivotComponent.COMPONENT_TYPE_NAME
• ReusableMappingComponent.COMPONENT_TYPE_NAME
• SetComponent.COMPONENT_TYPE_NAME
• SorterComponent.COMPONENT_TYPE_NAME
• SplitterComponent.COMPONENT_TYPE_NAME
• SubqueryFilterComponent.COMPONENT_TYPE_NAME
• TableFunctionComponent.COMPONENT_TYPE_NAME
• UnpivotComponent.COMPONENT_TYPE_NAME

boundObject - An object to which the component is bound. The bound object will typically be a repository object that is associated with this component and from which this component will derive attribute information. The bound object must implement the IModelObject mapping. It can be a native ODI object, a native non-ODI repository object, or an adapter that wraps a native repository object and implements IModelObject. Objects of type IDataStore are the most common bound objects used with a component. If a raw native object that does not implement IModelObject is passed in, the appropriate adapter will be invoked to attempt to create an adapter wrapper object for it. If this cannot be done, an exception will be thrown.

Throws:

MapComponentException

PropertyException

ExpressionParseException

AdapterException

MapPhysicalException

MappingException

addComponent

void addComponent(IMapComponent comp)
           throws MappingException,
                  MapComponentException

Adds a component to the mapping. The component to be added will have already been created using a constructor call.

Parameters:

comp - The component to be added.

Throws:

MapComponentException

MappingException

removeComponent

void removeComponent(IMapComponent comp)
              throws MappingException,
                     AdapterException

Removes a component from the mapping.

Parameters:

comp - The component to be removed.

Throws:

MappingException

AdapterException

removeComponent

void removeComponent(IMapComponent comp,
                     boolean removeReferencingExpressions)
              throws MappingException,
                     AdapterException

Removes a component from the mapping.

Parameters:

comp - The component to be removed.

removeReferencingExpressions - If true, all downstream expressions that reference the removed component will have their expression text set to blank.

Throws:

MappingException

AdapterException

findComponent

IMapComponent findComponent(java.lang.String name)
                     throws MapComponentException

Finds a component owned by this component owner, with the specified name. Will not find components owned by lower level hierarchical component owners.

Parameters:

name -

Throws:

MapComponentException

findComponentBoundTo

IMapComponent findComponentBoundTo(IModelObject modelObj)
                            throws MapComponentException,
                                   AdapterException

Find a component that is bound to the specified model object, and directly owned by this component owner. If no such component is found, return null. If multiple components are found, arbitrarily return the first one found.

Parameters:

modelObj - The bound object to search for.

Returns:

The component that is bound to the specified object (e.g. IDataStore object).

Throws:

MapComponentException

AdapterException

findComponentsBoundTo

java.util.List findComponentsBoundTo(IModelObject modelObj)
                              throws MapComponentException,
                                     AdapterException

Find all components that are bound to the specified model object, and directly owned by this component owner.

Parameters:

modelObj - The bound object to search for.

Returns:

The component that is bound to the specified object (e.g. IDataStore object).

Throws:

MapComponentException

AdapterException

findSubComponentOwner

IMapComponentOwner findSubComponentOwner(java.lang.String name)
                                  throws MapComponentException

Find the sub-component owner with the specified name. Returns null if not found.

Parameters:

name - The name of the sub-component owner.

Throws:

MapComponentException

findComponentOfType

IMapComponent findComponentOfType(java.lang.String name,
                                  java.lang.String type)
                           throws MappingException

Find the named component of the specified type, within the component owner.

Parameters:

name - The name of the component to find.

type - The type of the component to find, e.g. FilterComponent.COMPONENT_TYPE_NAME.

Returns:

The component of the specified type with the specified name, if any, else null.

Throws:

MappingException

findAllComponents

java.util.List findAllComponents(java.lang.String name)
                          throws MapComponentException

Finds all component owned by this component owner and any sub-component owners, with the specified name.

Parameters:

name -

Returns:

The list of all components with the specified name.

Throws:

MapComponentException

findConnector

MapConnector findConnector(java.lang.String name)
                    throws MapComponentException

Find a named connector with the specified name. Will not find connectors owned by lower level hierarchical component owners.

Parameters:

name -

Throws:

MapComponentException

getUpstreamLeafAttributes

java.util.List getUpstreamLeafAttributes(IMapComponent component)
                                  throws MappingException,
                                         AdapterException

Get all upstream attributes for the specified target component. The returned list includes all attributes that are owned by components that are connected through selector components to the specified target.

Parameters:

component - The target component.

Throws:

MappingException

AdapterException

getUpstreamLeafAttributes

java.util.List getUpstreamLeafAttributes(MapConnectorPoint point)
                                  throws MappingException,
                                         AdapterException

Get all upstream leaf attributes for the specified target connector point. The returned list includes all attributes that are owned by connector points that are connected through selector components to the specified target. A leaf attribute is defined as an attribute that is owned by a leaf component. The graph is flattened with respect to composite components, to find the leaf components. The reusable mapping components are not expanded.

Parameters:

point - The target connector point.

Throws:

MappingException

AdapterException

getUpstreamLeafConnectorPoints

java.util.List getUpstreamLeafConnectorPoints(MapConnectorPoint point)
                                       throws MappingException,
                                              AdapterException

Get all upstream leaf connector points for the specified target connector point. The returned list includes all source connector points that are connected to the specified target. The graph is flattened with respect to composite components, to find the leaf components. The reusable mapping components are not expanded.

Parameters:

point - The target connector point.

Throws:

MappingException

AdapterException

getTargets

java.util.List getTargets()
                   throws MappingException

Get a list of all components that have input connections but no output connections.

Returns:

The list of all target components.

Throws:

MapComponentException

MappingException

getTopLevelTargets

java.util.List getTopLevelTargets()
                           throws MapComponentException,
                                  MappingException

Get a list of top level components that have input connections but no output connections.

Returns:

The list of top level target components.

Throws:

MapComponentException

MappingException

getSources

java.util.List getSources()
                   throws MapComponentException

Get a list of all components that have output connections but no input connections, not including passive components.

Returns:

The list of all source components.

Throws:

MapComponentException

getTopLevelSources

java.util.List getTopLevelSources()
                           throws MapComponentException

Get a list of top level components that have output connections but no input connections, not including passive components.

Returns:

The list of top level source components.

Throws:

MapComponentException

containsComponent

boolean containsComponent(IMapComponent comp)
                   throws MapComponentException

Return true if this component owner (may be a composite component) contains the specified component as an sub-component.

Parameters:

comp - The subcomponent for which to check.

Throws:

MapComponentException

isComponent

boolean isComponent()

Return true if this component owner is also a mappingComponent instance.

getMapRootContainer

IMapRootContainer getMapRootContainer()
                               throws MapComponentException

Get the parent mapping for this component owner. It may be the component owner itself.

Returns:

The parent mapping.

Throws:

MapComponentException

getLeafLevelComponents

java.util.List getLeafLevelComponents()
                               throws MapComponentException

Return a list of the leaf-level (lowest-level) components owned by this component owner. These are the components of the "flattened out" map.

Returns:

The list of leaf-level components.

Throws:

MapComponentException

getLeafLevelTargets

java.util.List getLeafLevelTargets()
                            throws MappingException

Get a list of leaf-level components that are targets. The component is considered a target if it has some input connections and no output connections, and is a data storage-type component. The graph is flattened with respect to composite components, to find the leaf components. The reusable mapping components are not expanded.

Returns:

The list of leaf-level target components.

Throws:

MapComponentException

MappingException

getLeafLevelEndpoints

java.util.List getLeafLevelEndpoints()
                              throws MappingException

Get a list of leaf-level components that are end points in the graph. The component is considered an end point if it has some input connections and no output connections. The graph is flattened with respect to composite components, to find the leaf components. The reusable mapping components are not expanded.

Returns:

The list of leaf-level target components.

Throws:

MapComponentException

MappingException

getUpstreamLeafSources

java.util.List getUpstreamLeafSources(IMapComponent comp)
                               throws MapComponentException

Get the upstream leaf component sources for the specified component. The graph is walked upstream starting from the inputs of the specified component, looking for projector component or passive sources on the graph. The graph traversal will stop at projector or passive component sources. The graph is flattened with respect to composite components, to find the leaf components. The reusable mapping components are not expanded.

Parameters:

comp - The component for which to get the upstream leaf components.

Returns:

The list of upstream sources for the component.

Throws:

MapComponentException

isSignatureOwner

boolean isSignatureOwner()

Return true if this component owner supports owning signature components. For example, return true for ReusableMapping, or an expandable map component.

isExpandableComponent

boolean isExpandableComponent()

Return true if this component owner is an expandable mapping component.