@Entity public class DeploymentSpec extends oracle.odi.domain.root.PropertyOwner implements IDeploymentSpec, IOdiScenarioSource, oracle.odi.domain.mapping.IMapReferenceOwner
Modifier and Type | Class and Description |
---|---|
static class |
DeploymentSpec.ExecutionLocationType
A way to categorize the execution location type of an execution unit.
|
Modifier and Type | Method and Description |
---|---|
ExecutionUnit |
createExecutionUnit(ILocation location)
Create a new execution unit in this deployment spec.
|
ExecutionUnitGroup |
createExecutionUnitGroup(java.lang.String name)
Create a new execution unit group with the specified name.
|
void |
dump(java.util.logging.Level level) |
MapPhysicalNode |
findAPNode(IMapComponent targetLogicalComponent)
Find an access point (AP) node associated with the specified target logical component.
|
ExecutionUnit |
findExecutionUnit(java.lang.String name)
Finds an execution unit with the specified name in this deployment spec.
|
ExecutionUnitGroup |
findExecutionUnitGroup(java.lang.String name)
Return an execution unit group with the specified name, or null if not found.
|
ILocation |
findLocation(java.lang.String locationName)
Find a location adapter object with the specified name, if any.
|
MapPhysicalNode |
findNode(IMapComponent logicalComponent)
Get the physical node that corresponds to the specified logical component
If there are multiple nodes for the logical component, an exception is thrown.
|
MapPhysicalNode |
findNode(IMapComponent logicalComponent,
java.util.Stack rmcStack)
Get the physical node that corresponds to the specified logical component.
|
MapPhysicalNode |
findNode(MapConnectorPoint logicalCP)
Get the physical node that corresponds to the specified logical connector point
If there are multiple nodes for the logical connector point, an exception is thrown.
|
MapPhysicalNode |
findNode(MapConnectorPoint logicalCP,
java.util.Stack rmcStack)
Get the physical node that corresponds to the specified logical connector point.
|
MapPhysicalNode |
findNodeByName(java.lang.String physNodeName)
Find a node with the specified physical node name.
|
MapPhysicalNode |
findNodeByPartialName(java.lang.String physNodeName)
Find a node whose name starts with the specified physical node name.
|
java.util.Set |
findNodes(IMapComponent logicalComponent,
java.util.Stack rmcStack)
Get the list of nodes corresponding to the specified logical component, or null if
there are no nodes corresponding to the component.
|
java.util.Set |
findNodes(MapConnectorPoint logicalCP,
java.util.Stack rmcStack)
Get the list of nodes corresponding to the specified logical connector point, or null if
there are no nodes corresponding to the connector point.
|
java.util.Set |
findNodes(java.lang.String logicalName)
Find a list of physical nodes corresponding to the specified logical component name, or null if not found.
|
java.util.Set |
findNodes(java.lang.String logicalName,
java.util.Stack rmcStack)
Find a list of physical nodes corresponding to the specified logical component name and RMC stack, or null if not found.
|
IScenario |
findScenario(java.lang.String qualifiedName)
Find the scenario with the specified name if any.
|
IScenario |
findScenario(java.lang.String name,
java.lang.String version)
Find the scenario with the specified name and version if any.
|
java.util.List |
getAllAPNodes()
Return all the access point (AP) nodes owned by this spec.
|
java.util.List |
getAllMapReferences() |
java.lang.String |
getDisplayableTypeName()
Get a user-displayable type name for the object.
|
IContext |
getExecutionContext()
Get the execution context that will be used when generating and executing this deployment spec.
|
ExecutionUnit |
getExecutionUnit(java.lang.String name)
Get an execution unit with the specified name.
|
java.util.List |
getExecutionUnitGroups()
Get all execution units groups in this deployment spec.
|
java.util.List |
getExecutionUnits()
Get the execution units in this deployment spec.
|
java.util.Set |
getExecutionUnitsForLoc(ILocation loc)
Get the set of execution units associated with the specified location.
|
java.util.Set |
getExecutionUnitsForLocName(java.lang.String locName)
Get the set of execution units associated with the specified location name.
|
IFolder |
getFolder()
Gets the folder which owns this deployment specification.
|
Mapping |
getMapping()
Get the mapping that owns this deployment spec.
|
IContext |
getOptimizationContext()
Get the default context object for this deployment spec.
|
java.lang.String |
getOptimizationContextName()
Gets the default or "optimization" context name for this deployment spec.
|
IPropertyOwner |
getOwner()
Gets the mapping owner (or parent) of this object.
|
java.util.List |
getPhysicalNodes()
Get a list of all physical nodes that exist in this deployment spec physical graph.
|
ExecutionUnit |
getPresetStagingExecutionUnit()
Return the staging execution unit which is specified by the staging
location property.
|
ILocation |
getPresetStagingLocation()
Return the staging location if one is specified by the staging
location property, else return null.
|
java.util.List |
getScenarios()
Get a list of all scenarios that were generated using this deployment spec.
|
java.util.List |
getSortedExecutionUnits()
Do a topological sort on the execution units, and return the sorted list.
|
java.util.List |
getSourceExecutionUnits()
Get a list of all execution units with no upstream connections to other execution units.
|
java.util.List |
getSourceExUnitList() |
java.util.List |
getStagingExUnitList() |
java.util.List |
getTargetExecutionUnits()
Get a list of all execution units with no downstream connections to other execution units.
|
java.util.List |
getTargetExUnitList() |
java.util.List |
getTargetNodes()
Get a list of all target nodes in the graph, which are nodes with no parent node (no downstream target node).
|
boolean |
isCleanupOnError()
Returns true if cleanup tasks should be performed on error, false otherwise.
|
boolean |
isConcurrent()
Returns true if concurrency enabled, false otherwise.
|
boolean |
isFrozen() |
boolean |
moveNodes(java.util.List nodes,
ExecutionUnit exUnit,
java.util.List issues)
Move a group of physical nodes to the specified execution unit, if possible.
|
void |
notifyPropertyChange(java.lang.String key,
Property property,
java.lang.Object oldValue,
java.lang.Object newValue) |
void |
removeAllExecutionUnitGroups()
Remove all execution unit groups from this spec.
|
void |
removeAllExecutionUnits()
Remove all execution units from this deployment spec.
|
void |
removeExecutionUnit(ExecutionUnit exUnit)
Remove the specified execution unit from this deployment spec.
|
void |
removeScenario(IScenario scen)
Remove the specified scenario from the scenarios that are associated with this deployment spec.
|
void |
resetAllKMAssignments()
Set all node KM assignments back to the default assignment, if one is available.
|
void |
resetIKMs()
Reset all assigned IKMs in the spec to the default setting.
|
void |
resetSpec()
Resets the spec to the default configuration.
|
void |
resetSpec(java.util.List issues)
Resets the spec to the default configuration.
|
void |
setCleanupOnError(boolean pCleanupOnError)
Cleanup tasks should be performed on error is
pCleanupOnError is true. |
void |
setConcurrent(boolean pConcurrent)
Enables concurrency if
pConcurrent is true and disables it otherwise. |
void |
setExecutionContext(IContext context)
Set the execution context that will be used when generating and executing this deployment spec.
|
void |
setFolder(IFolder folder) |
void |
setFrozen(boolean isFrozen)
Set the frozen value for this deployment spec.
|
void |
setName(java.lang.String name)
Set the name of the object.
|
void |
setOptimizationContext(IContext context)
Set the optimization context object for this deployment spec.
|
void |
setOptimizationContextByCode(java.lang.String contextCode)
Set the default or optimization context by context code.
|
void |
setOptimizationContextByName(java.lang.String name)
Set the default or "optimization" context for this deployment spec, by name.
|
void |
setStagingLocationName(java.lang.String locName)
Set the preset staging location by name.
|
void |
syncWithLogicalMapping()
Synchronizes this deployment spec with its logical mapping.
|
void |
syncWithLogicalMapping(java.util.List issues)
Synchronizes this deployment spec with its logical mapping.
|
void |
syncWithLogicalMapping(java.util.List issues,
boolean skipValidation)
Synchronizes this deployment spec with its logical mapping.
|
boolean |
validate(java.util.List result,
boolean debug)
Validates the object, and adds all error, warning, or informational issues
that are found by validation to the specified issue list.
|
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, onSave, removeAllProperties, removeProperty, removeProperty, setBooleanPropertyValue, setIntPropertyValue, setPropertyValue, validateProperties
getBusinessName, getDescription, getGlobalNamespaceId, getName, getNamespaceId, setBusinessName, setDescription
addCachedIssue, addCachedIssues, clearIssueCache, displayIssues, displayIssues, displayIssues, dump, dump, dump, dumpToString, equals, getAdapter, getCachedErrors, getCachedIssues, getCachedSyncState, getCachedValidationErrorMessage, getDisplayableObjectName, getFCOContainer, getFullName, getGUID, getInternalId, getPropertyDefinitionOwner, getRootContainer, getSecurityContainer, getStrongTypeClassName, getSyncState, handleMapChangeEvent, hasAdapter, hashCode, isNew, setCachedSyncState, toString, validate
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getGlobalId, getName, getNumericId
getBusinessName, getDescription, getName, setBusinessName, setDescription
dump, dump, getDisplayableObjectName, getGUID, getStrongTypeClassName, validate
getRootContainer
getGlobalId, getInternalId, getSecurityContainer
public DeploymentSpec(Mapping owner, java.lang.String name, IContext context, java.util.List issues) throws MappingException, AdapterException
PropertyException
MapPhysicalException
oracle.odi.domain.mapping.exception.MapComponentException
AdapterException
MappingException
public DeploymentSpec(Mapping owner, java.lang.String name, IContext context, boolean skipInitialization, boolean skipValidation, java.util.List issues) throws MappingException, AdapterException
PropertyException
MapPhysicalException
oracle.odi.domain.mapping.exception.MapComponentException
AdapterException
MappingException
public DeploymentSpec(Mapping owner, java.lang.String name, IContext context, boolean skipInitialization, java.util.List issues) throws MappingException, AdapterException
PropertyException
MapPhysicalException
oracle.odi.domain.mapping.exception.MapComponentException
AdapterException
MappingException
public IContext getOptimizationContext() throws AdapterException
AdapterException
public java.lang.String getOptimizationContextName()
public void setOptimizationContextByName(java.lang.String name) throws AdapterException, MappingException
name
- AdapterException
MappingException
public void setExecutionContext(IContext context)
context
- The execution context.public IContext getExecutionContext() throws AdapterException
AdapterException
public void setStagingLocationName(java.lang.String locName) throws MappingException, AdapterException
locName
- The name of the staging logical schema.MappingException
AdapterException
public ExecutionUnit getPresetStagingExecutionUnit() throws AdapterException, MappingException
AdapterException
MappingException
public ILocation getPresetStagingLocation() throws PropertyException, AdapterException
PropertyException
AdapterException
public void setOptimizationContextByCode(java.lang.String contextCode) throws AdapterException, MappingException
contextCode
- The code (usually the same as the name) of the context object to
be used as the optimization context.AdapterException
MappingException
public void setOptimizationContext(IContext context) throws MappingException, AdapterException
context
- The new default context object.AdapterException
PropertyException
MapPhysicalException
oracle.odi.domain.mapping.exception.MapComponentException
MappingException
public java.util.Set findNodes(java.lang.String logicalName) throws oracle.odi.domain.mapping.exception.MapComponentException
logicalName
- The name of the logical component for which nodes will be found.oracle.odi.domain.mapping.exception.MapComponentException
public java.util.Set findNodes(java.lang.String logicalName, java.util.Stack rmcStack) throws oracle.odi.domain.mapping.exception.MapComponentException
logicalName
- The name of the logical component for which nodes will be found.rmcStack
- The reusable mapping component stack context where the component resides.oracle.odi.domain.mapping.exception.MapComponentException
public java.util.Set findNodes(IMapComponent logicalComponent, java.util.Stack rmcStack)
logicalComponent
- The logical component for which to retrieve the list of
physical nodes.rmcStack
- The reusable mapping component stack context where the component resides.public java.util.Set findNodes(MapConnectorPoint logicalCP, java.util.Stack rmcStack) throws AdapterException, MappingException
logicalCP
- The logical connector point for which to retrieve the list of
physical nodes.rmcStack
- The reusable mapping component stack context where the connector point resides.MappingException
AdapterException
public MapPhysicalNode findNode(IMapComponent logicalComponent) throws MapPhysicalException
logicalComponent
- The logical component for which to retrieve the physical node.MapPhysicalException
public MapPhysicalNode findNode(IMapComponent logicalComponent, java.util.Stack rmcStack) throws MapPhysicalException
logicalComponent
- The logical component for which to retrieve the physical node.MapPhysicalException
public MapPhysicalNode findNode(MapConnectorPoint logicalCP) throws AdapterException, MappingException
logicalCP
- The logical connector point for which to retrieve the physical node.MappingException
AdapterException
public MapPhysicalNode findNode(MapConnectorPoint logicalCP, java.util.Stack rmcStack) throws AdapterException, MappingException
logicalCP
- The logical connector point for which to retrieve the physical node.rmcStack
- The RMC stack associated with the node.MappingException
AdapterException
public MapPhysicalNode findAPNode(IMapComponent targetLogicalComponent)
targetLogicalComponent
- public MapPhysicalNode findNodeByName(java.lang.String physNodeName)
physNodeName
- public MapPhysicalNode findNodeByPartialName(java.lang.String physNodeName)
physNodeName
- public ExecutionUnit getExecutionUnit(java.lang.String name)
public void resetSpec(java.util.List issues) throws MappingException, AdapterException
issues
- The issue list to populate with any errors or warnings when resetting the spec.
If the issues list calling parameter is null, then exceptions will be thrown instead.AdapterException
PropertyException
MapPhysicalException
oracle.odi.domain.mapping.exception.MapComponentException
MappingException
public void resetSpec() throws MappingException, AdapterException
oracle.odi.domain.mapping.exception.MapComponentException
MapPhysicalException
PropertyException
AdapterException
MappingException
public ILocation findLocation(java.lang.String locationName) throws AdapterException
AdapterException
public java.util.Set getExecutionUnitsForLoc(ILocation loc)
loc
- The location (e.g. logical schema) for which to find execution units.AdapterException
public java.util.Set getExecutionUnitsForLocName(java.lang.String locName) throws AdapterException
locName
- The name of the location (e.g. logical schema).AdapterException
public boolean moveNodes(java.util.List nodes, ExecutionUnit exUnit, java.util.List issues)
nodes
- The group of nodes to be moved.exUnit
- The target execution unit for the nodes.issues
- A list of issues that will be populated with errors or warnings that occurred when
attempting to move the nodes. If there are error or fatal level issues, then the nodes will
not be moved.public java.util.List getAllAPNodes()
public void resetAllKMAssignments() throws MappingException, AdapterException
MappingException
AdapterException
public java.util.List getTargetNodes()
public void syncWithLogicalMapping(java.util.List issues) throws MappingException, AdapterException
issues
- The issue list to populate with any errors or warnings when syncing the spec.oracle.odi.domain.mapping.exception.MapComponentException
AdapterException
PropertyException
MapPhysicalException
MappingException
public void syncWithLogicalMapping(java.util.List issues, boolean skipValidation) throws MappingException, AdapterException
issues
- The issue list to populate with any errors or warnings when syncing the spec.skipValidation
- If true, then the logical mapping will not be validated before the synchronization begins.oracle.odi.domain.mapping.exception.MapComponentException
AdapterException
PropertyException
MapPhysicalException
MappingException
public void syncWithLogicalMapping() throws MappingException, AdapterException
oracle.odi.domain.mapping.exception.MapComponentException
MapPhysicalException
PropertyException
AdapterException
MappingException
public java.util.List getPhysicalNodes()
public void removeExecutionUnit(ExecutionUnit exUnit) throws AdapterException
exUnit
- The execution unit to be removed.AdapterException
public void removeAllExecutionUnits() throws AdapterException
AdapterException
public void removeAllExecutionUnitGroups()
public java.util.List getExecutionUnits()
public java.util.List getSortedExecutionUnits() throws MappingException
MapPhysicalException
MappingException
public java.util.List getSourceExecutionUnits() throws MappingException
MapPhysicalException
MappingException
public java.util.List getTargetExecutionUnits() throws MappingException
MapPhysicalException
MappingException
public ExecutionUnit createExecutionUnit(ILocation location) throws MappingException, AdapterException
location
- The location of the new execution unit. Allowed to be null if
the location is not yet known, the location can be set later.MappingException
AdapterException
public void setName(java.lang.String name) throws MappingException
INamedObject
setName
in interface INamedObject
setName
in class oracle.odi.domain.root.NamedObject
MappingException
- TODOpublic ExecutionUnit findExecutionUnit(java.lang.String name)
name
- The name of the execution unit to find.public IPropertyOwner getOwner()
IRoot
public Mapping getMapping()
public boolean validate(java.util.List result, boolean debug)
IRoot
validate
in interface IRoot
validate
in class oracle.odi.domain.root.PropertyOwner
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 void dump(java.util.logging.Level level)
dump
in class oracle.odi.domain.root.Root
public java.lang.String getDisplayableTypeName()
IRoot
getDisplayableTypeName
in interface IPropertyOwner
getDisplayableTypeName
in interface IRoot
getDisplayableTypeName
in class oracle.odi.domain.root.PropertyOwner
public ExecutionUnitGroup createExecutionUnitGroup(java.lang.String name) throws MappingException
MapPhysicalException
MappingException
public java.util.List getExecutionUnitGroups()
public ExecutionUnitGroup findExecutionUnitGroup(java.lang.String name)
public java.util.List getScenarios() throws AdapterException
AdapterException
public IScenario findScenario(java.lang.String qualifiedName) throws AdapterException
qualifiedName
- The qualified name of the scenario.AdapterException
public IScenario findScenario(java.lang.String name, java.lang.String version) throws AdapterException
name
- The name of the scenario to be found.version
- The version of the scenrio to be found.AdapterException
public void removeScenario(IScenario scen)
scen
- The scenario to be removed.public IFolder getFolder()
IDeploymentSpec
getFolder
in interface IDeploymentSpec
public void setFolder(IFolder folder)
setFolder
in interface IDeploymentSpec
folder
- owning folder.public boolean isConcurrent()
public void setConcurrent(boolean pConcurrent)
pConcurrent
is true and disables it otherwise. If concurrency is
enabled, then this spec can be run at the same time as other specs that are owned by the same mapping,
or at the same time as other specs that may create same-named staging tables. If concurrency is set,
then the C$ staging tables that are created are guaranteed to have unique names in the server where they
are created.pConcurrent
- public boolean isCleanupOnError()
public void setCleanupOnError(boolean pCleanupOnError)
pCleanupOnError
is true.pCleanupOnError
- if cleanup tasks should be performed on error.public void notifyPropertyChange(java.lang.String key, Property property, java.lang.Object oldValue, java.lang.Object newValue) throws MappingException, AdapterException
notifyPropertyChange
in class oracle.odi.domain.root.PropertyOwner
MappingException
AdapterException
public void setFrozen(boolean isFrozen)
isFrozen
- The new value for the frozen flag for this spec.public boolean isFrozen()
public void resetIKMs() throws MappingException, AdapterException
AdapterException
MappingException
public java.util.List getSourceExUnitList()
public java.util.List getStagingExUnitList()
public java.util.List getTargetExUnitList()
public java.util.List getAllMapReferences()
getAllMapReferences
in interface oracle.odi.domain.mapping.IMapReferenceOwner