oracle.odi.domain.mapping

Class ReusableMapping

java.lang.Object

MapRootContainer

oracle.odi.domain.mapping.ReusableMapping

All Implemented Interfaces:

IModelObject, IModelObjectBase, IShortcutableModelObject, IMapping, IReusableMapping, IOdiEntity, IRepositoryEntity, IMapComponentOwner, IMapSignatureOwner, IMappingObject, INamedObject, IPropertyOwner, IRoot

public class ReusableMapping
extends MapRootContainer
implements IReusableMapping, IMapSignatureOwner, IShortcutableModelObject

A Reusable Mapping is a special sub mapping that can be reused in other mappings or other reusable mappings. A reusable mapping can contain any mapping component that can be contained by a Mapping, plus 2 additional components: InputSignature and OutputSignature. A reusable mapping component must be used in association with a reusable mapping, as an interface to the parent mapping.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_MAX_LENGTH Maximum length of a reusable mapping.
static java.lang.String	PROPKEY_TARGET_LOAD_ORDER Property key name value for the target load order property.

Constructor Summary

Constructors

Constructor and Description
ReusableMapping(java.lang.String pName) Constructs a new reusable mapping in the global workspace.
ReusableMapping(java.lang.String pName, IFolder pFolder) Constructs a new reusable mapping under the specified folder.
ReusableMapping(java.lang.String pName, IFolder pFolder, ReusableMapping referenceReusableMapping) Constructs a new shortcut reusable mapping under the specified folder, referencing the specified reusable mapping.

Method Summary

Modifier and Type	Method and Description
boolean	changeShortcutReferenceObject(ReusableMapping pReferenceObject)
void	checkValidReference(ReusableMapping pReferenceObject)
void	deleteReferencesTo(IMapComponent comp)
void	deleteReferencesTo(MapConnectorPoint point)
void	deleteReferencesTo(MapExpression expr)
java.util.List	findReferencingMappings(AdapterBase adapter) Return a list of all mappings that use this reusable map in a reusable mapping component, including nested usages.
IContext	getDefaultContext()
java.lang.String	getDisplayableTypeName() Get a displayable type name for the property owner object.
java.lang.String	getFullName()
IRoot	getOwner() Gets the mapping owner (or parent) of this object.
IProject	getProject() Gets the project owning this reusable mapping.
IModelObject	getRealModelObject() Returns the real model object of the current shortcut
ReusableMapping	getRealObject()
IReleaseTag	getReleaseTag()
IRepositoryEntity	getSecurityContainer()
ReusableMapping	getShortcutBaseObject()
java.lang.Number	getShortcutBigNumericId() Gets a numeric ID of the shortcut object, for repositories that support numeric id.
java.lang.String	getShortcutGlobalId() Gets the global ID of the shortcut object, which should be unique across the repository.
java.lang.Integer	getShortcutNumericId() Deprecated.
ReusableMapping	getShortcutOrigObject() Deprecated.
ReusableMapping	getShortcutReferenceObject()
boolean	isShortcut() Returns true if this reusable mapping is a shortcut.
boolean	isShortcutModelObject() Returns true if the model object is shortcut.
void	setName(java.lang.String name) Set the name of the object.
boolean	setShortcutBaseObject(ReusableMapping pBaseObject)
boolean	setShortcutReferenceObject(ReusableMapping pReferenceObject)
boolean	supportComponentOfType(java.lang.String type) Determine if this component owner can support (own) a component of the given type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.odi.domain.adapter.project.IReusableMapping

getFolder

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

getName

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

getBigNumericId, getGlobalId, getNumericId

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

addComponent, containsComponent, createComponent, createComponent, createComponent, findAllComponents, findComponent, findComponentBoundTo, findComponentOfType, findComponentsBoundTo, findConnector, findSubComponentOwner, getAllComponents, getAllComponentsOfType, getAllSignatureOwnerHolders, getAllSubComponentOwners, getComponentCount, getComponents, getLeafLevelComponents, getLeafLevelEndpoints, getLeafLevelTargets, getMapRootContainer, getSources, getTargets, getTopLevelComponentsOfType, getTopLevelSources, getTopLevelTargets, getUpstreamLeafAttributes, getUpstreamLeafAttributes, getUpstreamLeafConnectorPoints, getUpstreamLeafSources, isComponent, isExpandableComponent, isSignatureOwner, removeComponent, removeComponent

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

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

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

getBusinessName, getDescription, getName, setBusinessName, setDescription

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

dump, dump, getDisplayableObjectName, getGUID, 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

Methods inherited from interface oracle.odi.domain.IOdiEntity

getFirstDate, getFirstUser, getLastDate, getLastUser, getName, isInstanceLevelSecurityNeeded

Field Detail

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Maximum length of a reusable mapping.

See Also:

Constant Field Values

PROPKEY_TARGET_LOAD_ORDER

public static final java.lang.String PROPKEY_TARGET_LOAD_ORDER

Property key name value for the target load order property. Must match the property name in Definitions.xml

See Also:

Constant Field Values

Constructor Detail

ReusableMapping

public ReusableMapping(java.lang.String pName)
                throws MappingException

Constructs a new reusable mapping in the global workspace.

Parameters:

pName - the name of the Reusable Mapping

Throws:

PropertyException

MappingException

ReusableMapping

public ReusableMapping(java.lang.String pName,
                       IFolder pFolder)
                throws MappingException

Constructs a new reusable mapping under the specified folder.

Parameters:

pName - the name of the Reusable Mapping

pFolder - the folder in which the Reusable Mapping will be created.

Throws:

PropertyException

MappingException

ReusableMapping

public ReusableMapping(java.lang.String pName,
                       IFolder pFolder,
                       ReusableMapping referenceReusableMapping)
                throws MappingException

Constructs a new shortcut reusable mapping under the specified folder, referencing the specified reusable mapping.

Parameters:

pName - the name of the Reusable Mapping

pFolder - the folder in which the Reusable Mapping will be created.

referenceReusableMapping - the reusable mapping referenced by this shortcut.

Throws:

PropertyException

MappingException

Method Detail

getFullName

public java.lang.String getFullName()

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

Throws:

MappingException - TODO

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

Returns:

The owner class instance.

getDisplayableTypeName

public java.lang.String getDisplayableTypeName()

Description copied from interface: IPropertyOwner

Get a displayable type name for the property owner object.

Specified by:

getDisplayableTypeName in interface IPropertyOwner

Specified by:

getDisplayableTypeName in interface IRoot

Returns:

The displayable type name.

getDefaultContext

public IContext getDefaultContext()
                           throws AdapterException

Throws:

AdapterException

getProject

public IProject getProject()

Description copied from interface: IReusableMapping

Gets the project owning this reusable mapping. Some reusable mappings may be global and will not be owned by a project.

Specified by:

getProject in interface IReusableMapping

Returns:

owning project, or null if this is a global reusable mapping.

getShortcutBaseObject

public ReusableMapping getShortcutBaseObject()

setShortcutBaseObject

public boolean setShortcutBaseObject(ReusableMapping pBaseObject)

getShortcutReferenceObject

public ReusableMapping getShortcutReferenceObject()

setShortcutReferenceObject

public boolean setShortcutReferenceObject(ReusableMapping pReferenceObject)

getShortcutOrigObject

public ReusableMapping getShortcutOrigObject()

Deprecated.

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

container entity

isShortcut

public boolean isShortcut()

Description copied from interface: IReusableMapping

Returns true if this reusable mapping is a shortcut.

Specified by:

isShortcut in interface IReusableMapping

Returns:

true if this object is a shortcut, false otherwise

getReleaseTag

public IReleaseTag getReleaseTag()

getRealObject

public ReusableMapping getRealObject()

Specified by:

getRealObject in interface IMapSignatureOwner

checkValidReference

public void checkValidReference(ReusableMapping pReferenceObject)

changeShortcutReferenceObject

public boolean changeShortcutReferenceObject(ReusableMapping pReferenceObject)

getRealModelObject

public IModelObject getRealModelObject()

Description copied from interface: IShortcutableModelObject

Returns the real model object of the current shortcut

Specified by:

getRealModelObject in interface IShortcutableModelObject

Returns:

IModelObject

getShortcutGlobalId

public java.lang.String getShortcutGlobalId()

Description copied from interface: IShortcutableModelObject

Gets the global ID of the shortcut object, which should be unique across the repository. The global ID, or GUID, is used as the primary way to look up references to the shortcut model object.

Specified by:

getShortcutGlobalId in interface IShortcutableModelObject

Returns:

global ID of the object.

getShortcutNumericId

@Deprecated
public java.lang.Integer getShortcutNumericId()

Deprecated.

Specified by:

getShortcutNumericId in interface IShortcutableModelObject

Returns:

numeric ID of the object, or null if not supported.

getShortcutBigNumericId

public java.lang.Number getShortcutBigNumericId()

Description copied from interface: IShortcutableModelObject

Gets a numeric ID of the shortcut object, for repositories that support numeric id. Otherwise return null.

Specified by:

getShortcutBigNumericId in interface IShortcutableModelObject

Returns:

numeric ID of the object, or null if not supported.

isShortcutModelObject

public boolean isShortcutModelObject()

Description copied from interface: IShortcutableModelObject

Returns true if the model object is shortcut.

Specified by:

isShortcutModelObject in interface IShortcutableModelObject

Returns:

true if this object is a shortcut, otherwise false.

deleteReferencesTo

public void deleteReferencesTo(IMapComponent comp)

deleteReferencesTo

public void deleteReferencesTo(MapConnectorPoint point)

deleteReferencesTo

public void deleteReferencesTo(MapExpression expr)

findReferencingMappings

public java.util.List findReferencingMappings(AdapterBase adapter)
                                       throws AdapterException

Return a list of all mappings that use this reusable map in a reusable mapping component, including nested usages.

Returns:

A list of mappings that use this reusable map via binding to a reusable mapping component.

Throws:

AdapterException

supportComponentOfType

public boolean supportComponentOfType(java.lang.String type)

Determine if this component owner can support (own) a component of the given type.

Parameters:

type - The component type for the component.

Returns:

True if this component can own a component of the given type, false otherwise.