@Entity public class Mapping extends MapRootContainer implements INamedObject, IMapping, oracle.odi.domain.shortcuts.IOdiShortcutable, oracle.odi.domain.impexp.IExportable, oracle.odi.impexp.smartie.ISmartExportable, IFlexFieldUser, IOdiScenarioSource
Modifier and Type | Field and Description |
---|---|
static int |
NAME_MAX_LENGTH
Maximum length of the name of a mapping.
|
static java.lang.String |
PROPKEY_DEFAULT_STAGING_LOCATION_NAME
Property name for default staging location name.
|
static java.lang.String |
PROPKEY_TARGET_LOAD_ORDER
Property key name value for the target load order property.
|
METADATA_VERSION_11, METADATA_VERSION_12
Constructor and Description |
---|
Mapping(java.lang.String name,
IFolder parentFolder)
Mapping constructor that takes a name and an object adapter for the external model
object that acts as the container for the new mapping.
|
Mapping(java.lang.String name,
IFolder parentFolder,
IContext defaultContext)
Mapping constructor that takes a name and an object adapter for the external model
object that acts as the container for the new mapping.
|
Mapping(java.lang.String name,
IFolder parentFolder,
Mapping referenceMapping,
IContext defaultContext)
Mapping constructor that takes a name and a reference mapping.
|
Mapping(java.lang.String name,
java.lang.Object externalContainer)
Constructor that takes a java parent container instance from an external model,
and attempts to create an adapter object for it using the current adapter, if any.
|
Modifier and Type | Method and Description |
---|---|
void |
clearDeploymentSpecs()
Remove all existing deployment specs from this mapping.
|
DeploymentSpec |
createDeploymentSpec(java.lang.String name)
Create a new deployment spec for this mapping, and add it to the list of
deployment specs for the mapping.
|
DeploymentSpec |
createDeploymentSpec(java.lang.String name,
IContext context)
Create a new deployment spec for this mapping, and add it to the list of
deployment specs for the mapping.
|
DeploymentSpec |
createDeploymentSpec(java.lang.String name,
IContext context,
boolean skipValidation)
Create a new deployment spec for this mapping, and add it to the list of
deployment specs for the mapping.
|
DeploymentSpec |
createDeploymentSpec(java.lang.String name,
IContext context,
java.util.List issues)
Create a new deployment spec for this mapping, and add it to the list of
deployment specs for the mapping.
|
DeploymentSpec |
createDeploymentSpec(java.lang.String name,
java.util.List issues)
Create a new deployment spec for this mapping, and add it to the list of
deployment specs for the mapping.
|
DeploymentSpec |
findDeploymentSpec(java.lang.String name)
Return a deployment spec whose name matches the specified name, or null if not found.
|
IContext |
getDefaultContext()
Get the default context for the mapping.
|
java.lang.String |
getDefaultStagingLocationName()
Return the preset staging location name for this mapping.
|
DeploymentSpec |
getDeploymentSpec(int index)
Get the deployment spec from the list of deployment specs owned by this mapping,
at the specified index.
|
DeploymentSpec |
getDeploymentSpec(int index,
boolean syncWithLogical)
Get the deployment spec from the list of deployment specs owned by this mapping,
at the specified index.
|
DeploymentSpec |
getDeploymentSpec(java.util.List issues,
int index,
boolean syncWithLogical)
Get the deployment spec from the list of deployment specs owned by this mapping,
at the specified index.
|
java.util.List |
getDeploymentSpecs()
Get the list of physical deployment specs owned by this mapping.
|
java.util.List |
getDeploymentSpecs(boolean syncWithLogical)
Get the list of physical deployment specs owned by this mapping.
|
java.util.List |
getDeploymentSpecs(java.util.List issues)
Get the list of physical deployment specs owned by this mapping.
|
java.util.List |
getDeploymentSpecs(java.util.List issues,
boolean syncWithLogical)
Get the list of physical deployment specs owned by this mapping.
|
java.lang.String |
getDisplayableTypeName()
Get a user-displayable type name for the object.
|
java.util.List |
getExistingDeploymentSpecs()
Get a list of the existing deployment specs.
|
java.util.Collection |
getFlexFieldsValues()
Obtains flex fields values related to this IFlexFieldUser.
|
java.lang.String |
getNamespaceId() |
IRoot |
getOwner()
Gets the mapping owner (or parent) of this object.
|
IFolder |
getParentFolder()
Get the parent folder for this mapping.
|
IProject |
getProject()
Get the owning project for this mapping object.
|
Mapping |
getRealObject() |
java.util.List |
getScenarios()
Get a list of all scenarios that are generated from this mapping.
|
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
Mapping |
getShortcutBaseObject() |
MapExpression |
getTargetLoadOrder()
Get the target load order for this mapping.
|
java.lang.String |
getTargetLoadOrderText()
Get the target load order text for this mapping.
|
boolean |
isShortcut() |
void |
removeDeploymentSpec(DeploymentSpec spec)
Remove and delete the specified deployment spec from this mapping.
|
void |
setDefaultContext(IContext ctx)
Set the default context for this mapping.
|
void |
setDefaultContextByCode(java.lang.String contextCode)
Set the default context for this mapping, specified by context code.
|
void |
setDefaultStagingLocationName(java.lang.String value)
Set the preset staging location name for this mapping.
|
void |
setName(java.lang.String name)
Set the name of the object.
|
void |
setTargetLoadOrder(MapExpression tloExpr)
Set the target load order expression for the mapping.
|
void |
setTargetLoadOrderText(java.lang.String text)
A convenience method to set the target load order text for the mapping.
|
boolean |
validate(java.util.List result,
boolean debug)
Validates the mapping.
|
getAdapter, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, isInstanceLevelSecurityNeeded, isNew
addProperty, adjustPropertyPersistency, createProperty, createProperty, delete, getAllProperties, getAllProperties, getAllPropertyMapReferenceOwners, getBooleanPropertyValue, getChildNamespaceId, getDisplayableProperties, getExpressionPropertyValue, getIntPropertyValue, getProperties, getProperties, getProperty, getPropertyMetadataOwner, getPropertyValue, getPropertyValueReference, getStringPropertyValue, initiateDynamicProperties, internalGetAllProperties, internalIsPropertyDefined, internalSetPropertyValue, invokeMethod, isPropertyDefined, notifyPropertyChange, onSave, removeAllProperties, removeProperty, removeProperty, setBooleanPropertyValue, setIntPropertyValue, setPropertyValue, validateProperties
getBusinessName, getDescription, getGlobalNamespaceId, getName, setBusinessName, setDescription
addCachedIssue, addCachedIssues, clearIssueCache, displayIssues, displayIssues, displayIssues, dump, dump, dump, dump, dumpToString, equals, getCachedErrors, getCachedIssues, getCachedSyncState, getCachedValidationErrorMessage, getDisplayableObjectName, getFCOContainer, getGUID, getInternalId, getPropertyDefinitionOwner, getRootContainer, getStrongTypeClassName, hasAdapter, hashCode, setCachedSyncState, validate
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getBusinessName, getDescription, getName, setBusinessName, setDescription
dump, dump, getDisplayableObjectName, getGUID, getStrongTypeClassName, validate
getRootContainer
getGlobalId, getInternalId
getGlobalId, getName, getNumericId
findComponent
addComponent, afterConnect, containsComponent, createComponent, createComponent, createComponent, findAllComponents, findComponentBoundTo, findComponentOfType, findConnector, findSubComponentOwner, getAllComponents, getAllComponentsOfType, getAllSubComponentOwners, getComponentCount, getComponents, getLeafLevelComponents, getLeafLevelTargets, getMapRootContainer, getSources, getTargets, getTopLevelComponentsOfType, getTopLevelSources, getTopLevelTargets, getUpstreamLeafAttributes, getUpstreamLeafAttributes, getUpstreamLeafConnectorPoints, getUpstreamLeafSources, isComponent, removeComponent, removeComponent
addProperty, createProperty, getAllProperties, getBooleanPropertyValue, getDisplayableProperties, getExpressionPropertyValue, getIntPropertyValue, getProperties, getProperty, getPropertyValue, getStringPropertyValue, isPropertyDefined, setBooleanPropertyValue, setIntPropertyValue, setPropertyValue
getFirstDate, getFirstUser, getLastDate, getLastUser, getName, isInstanceLevelSecurityNeeded
public static final int NAME_MAX_LENGTH
public static final java.lang.String PROPKEY_TARGET_LOAD_ORDER
public static final java.lang.String PROPKEY_DEFAULT_STAGING_LOCATION_NAME
public Mapping(java.lang.String name, IFolder parentFolder, IContext defaultContext) throws AdapterException, MappingException
name
- The name for the mapping.parentFolder
- The owning folder for the new mapping.defaultContext
- The context object that will be used as the
default context when validating the mapping and it's physical deployment specs.AdapterException
PropertyException
MappingException
public Mapping(java.lang.String name, IFolder parentFolder, Mapping referenceMapping, IContext defaultContext) throws AdapterException, MappingException
name
- The name for the mapping.parentFolder
- The owning folder for the new mapping.referenceMapping
- If not null, create shortcut mapping with reference mapping referenceMappingdefaultContext
- The context object that will be used as the
default context for the mapping.AdapterException
PropertyException
MappingException
public Mapping(java.lang.String name, IFolder parentFolder) throws AdapterException, MappingException
name
- The name for the mapping.parentFolder
- The owning folder for the mapping.AdapterException
PropertyException
MappingException
public Mapping(java.lang.String name, java.lang.Object externalContainer) throws AdapterException, MappingException
name
- The name of the new mapping.externalContainer
- The external model object that is the container for the mapping. It must
be an instance of IFolder.AdapterException
MappingException
public void setName(java.lang.String name) throws MappingException
INamedObject
setName
in interface INamedObject
setName
in class oracle.odi.domain.root.NamedObject
MappingException
- TODOpublic IRoot getOwner()
IRoot
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
getSecurityContainer
in class oracle.odi.domain.root.Root
public java.lang.String getNamespaceId()
getNamespaceId
in class oracle.odi.domain.root.NamedObject
public IProject getProject()
IMapRootContainer
getProject
in interface IMapRootContainer
public IFolder getParentFolder()
public IContext getDefaultContext() throws AdapterException
IMapRootContainer
getDefaultContext
in interface IMapRootContainer
AdapterException
public void setDefaultContextByCode(java.lang.String contextCode) throws AdapterException
contextCode
- The context code of the context that will be set as the default context.AdapterException
public void setDefaultContext(IContext ctx)
ctx
- The context to set as the default context.public DeploymentSpec createDeploymentSpec(java.lang.String name, IContext context, boolean skipValidation) throws MappingException, AdapterException
name
- The name of the new deployment spec.context
- The optimization context for the new deployment spec.skipValidation
- If true, the mapping will not be validated before creating the new deployment spec.PropertyException
MapPhysicalException
oracle.odi.domain.mapping.exception.MapComponentException
AdapterException
MappingException
public DeploymentSpec createDeploymentSpec(java.lang.String name, IContext context) throws MappingException, AdapterException
name
- The name of the new deployment spec.context
- The optimization context for the new deployment spec.PropertyException
MapPhysicalException
oracle.odi.domain.mapping.exception.MapComponentException
AdapterException
MappingException
public DeploymentSpec createDeploymentSpec(java.lang.String name) throws MappingException, AdapterException
name
- The name of the new deployment spec.PropertyException
MapPhysicalException
oracle.odi.domain.mapping.exception.MapComponentException
AdapterException
MappingException
public DeploymentSpec createDeploymentSpec(java.lang.String name, IContext context, java.util.List issues) throws MappingException, AdapterException
name
- The name of the new deployment spec.context
- The optimization context for the new deployment spec.issues
- An issue list to be populated with error or warning issues that are generated when creating the deployment spec.PropertyException
MapPhysicalException
oracle.odi.domain.mapping.exception.MapComponentException
AdapterException
MappingException
public DeploymentSpec createDeploymentSpec(java.lang.String name, java.util.List issues) throws MappingException, AdapterException
name
- The name of the new deployment spec.issues
- An issue list to be populated with error or warning issues that are generated when creating the deployment spec.PropertyException
MapPhysicalException
oracle.odi.domain.mapping.exception.MapComponentException
AdapterException
MappingException
public java.util.List getDeploymentSpecs()
public java.util.List getDeploymentSpecs(java.util.List issues)
issues
- An issue list that will be populated with any error issues encountered when
retrieving or initializing the specs.public java.util.List getDeploymentSpecs(boolean syncWithLogical)
syncWithLogical
- If true, causes all specs to be re-synced with the logical map.public java.util.List getDeploymentSpecs(java.util.List issues, boolean syncWithLogical)
issues
- An issue list that will be populated with any error issues encountered when
retrieving or initializing the specs.syncWithLogical
- If true, causes all specs to be re-synced with the logical map.public DeploymentSpec getDeploymentSpec(int index) throws MapPhysicalException
index
- The index into the deployment spec list.MapPhysicalException
public DeploymentSpec findDeploymentSpec(java.lang.String name)
name
- The deployment spec name.public DeploymentSpec getDeploymentSpec(int index, boolean syncWithLogical) throws MapPhysicalException
index
- The index into the deployment spec list.syncWithLogical
- If true, causes existing deployment specs to be synced with the logical map.MapPhysicalException
public DeploymentSpec getDeploymentSpec(java.util.List issues, int index, boolean syncWithLogical) throws MapPhysicalException
index
- The index into the deployment spec list.syncWithLogical
- If true, causes existing deployment specs to be synced with the logical map.MapPhysicalException
public java.util.List getExistingDeploymentSpecs()
public void clearDeploymentSpecs() throws MappingException, AdapterException
AdapterException
oracle.odi.domain.mapping.exception.MapComponentException
MappingException
public void removeDeploymentSpec(DeploymentSpec spec) throws MappingException, AdapterException
spec
- The spec to be deleted.MappingException
AdapterException
public boolean validate(java.util.List result, boolean debug)
validate
in interface IRoot
validate
in class MapComponentOwner
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.public java.lang.String getDisplayableTypeName()
IRoot
getDisplayableTypeName
in interface IPropertyOwner
getDisplayableTypeName
in interface IRoot
getDisplayableTypeName
in class oracle.odi.domain.root.PropertyOwner
public MapExpression getTargetLoadOrder() throws PropertyException
PropertyException
public java.lang.String getTargetLoadOrderText() throws PropertyException
PropertyException
public void setTargetLoadOrderText(java.lang.String text) throws MappingException, AdapterException
text
- The new target load order text.PropertyException
MappingException
AdapterException
public void setTargetLoadOrder(MapExpression tloExpr) throws PropertyException, AdapterException, oracle.odi.domain.mapping.exception.MapComponentException, MappingException
tloExpr
- The new target load order expression.PropertyException
AdapterException
oracle.odi.domain.mapping.exception.MapComponentException
MappingException
public java.util.Collection getFlexFieldsValues()
IFlexFieldUser
getFlexFieldsValues
in interface IFlexFieldUser
public java.util.List getScenarios() throws AdapterException
AdapterException
public java.lang.String getDefaultStagingLocationName() throws PropertyException
PropertyException
public void setDefaultStagingLocationName(java.lang.String value) throws PropertyException
PropertyException
public Mapping getShortcutBaseObject()
getShortcutBaseObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
public boolean isShortcut()
isShortcut
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
isShortcut
in class MapRootContainer
public Mapping getRealObject()
getRealObject
in interface oracle.odi.domain.shortcuts.IOdiShortcutable
getRealObject
in class MapRootContainer