oracle.odi.domain.mapping.physical

Class MapPhysicalDesign

java.lang.Object

PropertyOwner

oracle.odi.domain.mapping.physical.MapPhysicalDesign

All Implemented Interfaces:

IModelObject, IModelObjectBase, IMapPhysicalDesign, IOdiScenarioSource

@Entity
public class MapPhysicalDesign
extends PropertyOwner
implements IMapPhysicalDesign, IOdiScenarioSource

A physical design is a persistent set of physical configuration parameters for a logical mapping. The physical design contains a graph of physical nodes, each of which corresponds to a logical component. Each physical node is contained inside an execution unit that groups the nodes by the physical server that will actually generate the code for the contained nodes. When a physical design is first created, a default graph of physical nodes and a default execution unit configuration is automatically created. The user is then allowed to move nodes and expressions to non-default execution units, move execution units to non-default parallelization groups, and set various other physical execution parameter values that will be used to generate executable sessions and scenarios for the mapping. The physical design also contains information about which nodes and expressions have been pushed to other execution units so that they will be executed in a non-default physical location.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapPhysicalDesign.ExecutionLocationType A way to categorize the execution location type of an execution unit.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NULL_STAGING_LOC_NAME

Method Summary

Modifier and Type	Method and Description
ExecutionUnit	createExecutionUnit(ILocation location) Create a new execution unit in this physical design.
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 physical design.
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()
MapExpression	getBeginCmd() Gets the begin mapping command expression
ILogicalSchema	getBeginCmdLogicalSchema() Gets the logical schema assigned to begin mapping command.
ITechnology	getBeginCmdTechnology() Gets the technology assigned to begin mapping command.
java.lang.String	getDisplayableTypeName()
MapExpression	getEndCmd() Gets the end mapping command expression.
ILogicalSchema	getEndCmdLogicalSchema() Gets the logical schema assigned to end mapping command.
ITechnology	getEndCmdTechnology() Gets the technology assigned to begin mapping command.
IContext	getExecutionContext() Get the execution context that will be used when generating and executing this physical design.
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 physical design.
java.util.List	getExecutionUnits() Get the execution units in this physical design.
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 physical designification.
java.lang.String	getFullName()
Mapping	getMapping() Get the mapping that owns this physical design.
IContext	getOptimizationContext() Get the default context object for this physical design.
java.lang.String	getOptimizationContextName() Gets the default or "optimization" context name for this physical design.
IPropertyOwner	getOwner()
java.util.List	getPhysicalNodes() Get a list of all physical nodes that exist in this physical design 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 physical design.
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.Date	getSynchronizationDate()
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	removeAllExecutionUnitGroups() Remove all execution unit groups from this spec.
void	removeAllExecutionUnits() Remove all execution units from this physical design.
void	removeExecutionUnit(ExecutionUnit exUnit) Remove the specified execution unit from this physical design.
void	removeScenario(IScenario scen) Remove the specified scenario from the scenarios that are associated with this physical design.
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	setBeginCmd(java.lang.String beginCmd) Sets the begin mapping command in text form.
void	setBeginCmdLogicalSchema(ILogicalSchema lSchema) Sets the logical schema for begin mapping command.
void	setBeginCmdTechnology(ITechnology techno) Sets the technology for begin mapping command.
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	setEndCmd(java.lang.String endCmd) Sets the end mapping command in text form.
void	setEndCmdLogicalSchema(ILogicalSchema lSchema) Sets the logical schema for end mapping command.
void	setEndCmdTechnology(ITechnology techno) Sets the technology for begin mapping command.
void	setExecutionContext(IContext context) Set the execution context that will be used when generating and executing this physical design.
void	setFrozen(boolean isFrozen) Set the frozen value for this physical design.
void	setName(java.lang.String name)
void	setOptimizationContext(IContext context) Set the optimization context object for this physical design.
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 physical design, by name.
void	setStagingLocationName(java.lang.String locName) Set the preset staging location by name.
void	setSynchronizationDate(java.util.Date synchronizationDate)
void	syncWithLogicalMapping() Synchronizes this physical design with its logical mapping.
void	syncWithLogicalMapping(java.util.List issues) Synchronizes this physical design with its logical mapping.
void	syncWithLogicalMapping(java.util.List issues, boolean skipValidation) Synchronizes this physical design with its logical mapping.
java.lang.String	toString()
boolean	validate(java.util.List result, boolean debug)

Methods inherited from class java.lang.Object

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

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

getName

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

getBigNumericId, getGlobalId, getNumericId

Field Detail

NULL_STAGING_LOC_NAME

public static final java.lang.String NULL_STAGING_LOC_NAME

Method Detail

getSynchronizationDate

public java.util.Date getSynchronizationDate()

setSynchronizationDate

public void setSynchronizationDate(java.util.Date synchronizationDate)

getOptimizationContext

public IContext getOptimizationContext()
                                throws AdapterException

Get the default context object for this physical design. This context will be used when validating and generating the physical design, unless a specific execution context is specified.

Returns:

The default context object.

Throws:

AdapterException

getOptimizationContextName

public java.lang.String getOptimizationContextName()

Gets the default or "optimization" context name for this physical design.

setOptimizationContextByName

public void setOptimizationContextByName(java.lang.String name)
                                  throws AdapterException,
                                         MappingException

Set the default or "optimization" context for this physical design, by name. If an existing context object is not found with the specified name, then do nothing.

Parameters:

name -

Throws:

AdapterException

MappingException

setExecutionContext

public void setExecutionContext(IContext context)

Set the execution context that will be used when generating and executing this physical design.

Parameters:

context - The execution context.

getExecutionContext

public IContext getExecutionContext()
                             throws AdapterException

Get the execution context that will be used when generating and executing this physical design.

Throws:

AdapterException

setStagingLocationName

public void setStagingLocationName(java.lang.String locName)
                            throws MappingException,
                                   AdapterException

Set the preset staging location by name. The preset staging location will be used to determining the staging location for the data, if appropriate. If no location is found with the specified name, a staging logical schema with the specified name will be created by default during the map execution.

Parameters:

locName - The name of the staging logical schema.

Throws:

MappingException

AdapterException

getPresetStagingExecutionUnit

public ExecutionUnit getPresetStagingExecutionUnit()
                                            throws AdapterException,
                                                   MappingException

Return the staging execution unit which is specified by the staging location property. Return null if no staging execution unit exists. If there are multiple staging execution units, return the one closest to a target unit.

Throws:

AdapterException

MappingException

getPresetStagingLocation

public ILocation getPresetStagingLocation()
                                   throws PropertyException,
                                          AdapterException

Return the staging location if one is specified by the staging location property, else return null.

Returns:

The preset staging location.

Throws:

PropertyException

AdapterException

setOptimizationContextByCode

public void setOptimizationContextByCode(java.lang.String contextCode)
                                  throws AdapterException,
                                         MappingException

Set the default or optimization context by context code.

Parameters:

contextCode - The code (usually the same as the name) of the context object to be used as the optimization context.

Throws:

AdapterException

MappingException

setOptimizationContext

public void setOptimizationContext(IContext context)
                            throws MappingException,
                                   AdapterException

Set the optimization context object for this physical design. This context will be used when validating and generating the physical design, unless a specific execution context is specified.

Parameters:

context - The new default context object.

Throws:

AdapterException

PropertyException

MapPhysicalException

MapComponentException

MappingException

findNodes

public java.util.Set findNodes(java.lang.String logicalName)
                        throws MapComponentException

Find a list of physical nodes corresponding to the specified logical component name, or null if not found. Will find all nodes corresponding to the top-level node in the logical graph with the specified name. There may be multiple physical nodes if the node has multiple output connector points. Will not find nodes corresponding to logical components that are contained in a sub-component owner such as a dataset.

Parameters:

logicalName - The name of the logical component for which nodes will be found.

Returns:

The list of nodes with this name.

Throws:

MapComponentException

findNodes

public java.util.Set findNodes(java.lang.String logicalName,
                               java.util.Stack rmcStack)
                        throws MapComponentException

Find a list of physical nodes corresponding to the specified logical component name and RMC stack, or null if not found. Will find all nodes corresponding to the top-level node in the logical graph with the specified name. There may be multiple physical nodes if the node has multiple output connector points. Will not find nodes corresponding to logical components that are contained in a sub-component owner such as a dataset.

Parameters:

logicalName - The name of the logical component for which nodes will be found.

rmcStack - The reusable mapping component stack context where the component resides.

Returns:

The list of nodes with this name.

Throws:

MapComponentException

findNodes

public 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.

Parameters:

logicalComponent - The logical component for which to retrieve the list of physical nodes.

rmcStack - The reusable mapping component stack context where the component resides.

Returns:

The list of nodes.

findNodes

public java.util.Set findNodes(MapConnectorPoint logicalCP,
                               java.util.Stack rmcStack)
                        throws AdapterException,
                               MappingException

Get the list of nodes corresponding to the specified logical connector point, or null if there are no nodes corresponding to the connector point.

Parameters:

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.

Returns:

The list of nodes.

Throws:

MappingException

AdapterException

findNode

public MapPhysicalNode findNode(IMapComponent logicalComponent)
                         throws MapPhysicalException

Get the physical node that corresponds to the specified logical component If there are multiple nodes for the logical component, an exception is thrown.

Parameters:

logicalComponent - The logical component for which to retrieve the physical node.

Returns:

The physical node corresponding to the logical component.

Throws:

MapPhysicalException

findNode

public MapPhysicalNode findNode(IMapComponent logicalComponent,
                                java.util.Stack rmcStack)
                         throws MapPhysicalException

Get the physical node that corresponds to the specified logical component. If there are multiple nodes for the logical component, an exception is thrown.

Parameters:

logicalComponent - The logical component for which to retrieve the physical node.

Returns:

The physical node corresponding to the logical component.

Throws:

MapPhysicalException

findNode

public MapPhysicalNode findNode(MapConnectorPoint logicalCP)
                         throws AdapterException,
                                MappingException

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.

Parameters:

logicalCP - The logical connector point for which to retrieve the physical node.

Returns:

The physical node corresponding to the logical connector point.

Throws:

MappingException

AdapterException

findNode

public MapPhysicalNode findNode(MapConnectorPoint logicalCP,
                                java.util.Stack rmcStack)
                         throws AdapterException,
                                MappingException

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.

Parameters:

logicalCP - The logical connector point for which to retrieve the physical node.

rmcStack - The RMC stack associated with the node.

Returns:

The physical node corresponding to the logical connector point.

Throws:

MappingException

AdapterException

findAPNode

public MapPhysicalNode findAPNode(IMapComponent targetLogicalComponent)

Find an access point (AP) node associated with the specified target logical component. Return null if no AP node is connected to the node associated specified target component. If the target component has multiple upstream AP nodes, the first one found is returned. An AP node is a node representing a data transfer between 2 servers. It is always connected to nodes in 2 different execution units.

Parameters:

targetLogicalComponent -

Returns:

The AP node if found, else null.

findNodeByName

public MapPhysicalNode findNodeByName(java.lang.String physNodeName)

Find a node with the specified physical node name. The physical node name will match the referenced logical name in many cases, but possibly not if there are multiple output connector points or same-named logical components inside sub-component owners.

Parameters:

physNodeName -

Returns:

The node with the specified physical node name, or null if not found.

findNodeByPartialName

public MapPhysicalNode findNodeByPartialName(java.lang.String physNodeName)

Find a node whose name starts with the specified physical node name. The physical node name will match the referenced logical name in many cases, but possibly not if there are multiple output connector points or same-named logical components inside sub-component owners.

Parameters:

physNodeName -

Returns:

The node with the specified physical node name, or null if not found. If an exact match is not found, will look for a node which starts with the specified name text, and has a uniqueness qualifier like "_1".

getExecutionUnit

public ExecutionUnit getExecutionUnit(java.lang.String name)

Get an execution unit with the specified name. If no execution unit exists with the specified name, return null.

resetSpec

public void resetSpec(java.util.List issues)
               throws MappingException,
                      AdapterException

Resets the spec to the default configuration.

Parameters:

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.

Throws:

AdapterException

PropertyException

MapPhysicalException

MapComponentException

MappingException

resetSpec

public void resetSpec()
               throws MappingException,
                      AdapterException

Resets the spec to the default configuration.

Throws:

MapComponentException

MapPhysicalException

PropertyException

AdapterException

MappingException

findLocation

public ILocation findLocation(java.lang.String locationName)
                       throws AdapterException

Find a location adapter object with the specified name, if any. If not found, return null. A location adapter is a holder for a logical location, which may also contain a context reference.

Throws:

AdapterException

getExecutionUnitsForLoc

public java.util.Set getExecutionUnitsForLoc(ILocation loc)

Get the set of execution units associated with the specified location.

Parameters:

loc - The location (e.g. logical schema) for which to find execution units.

Throws:

AdapterException

getExecutionUnitsForLocName

public java.util.Set getExecutionUnitsForLocName(java.lang.String locName)
                                          throws AdapterException

Get the set of execution units associated with the specified location name.

Parameters:

locName - The name of the location (e.g. logical schema).

Throws:

AdapterException

moveNodes

public 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.

Parameters:

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.

Returns:

true if the move was successful, else false.

getAllAPNodes

public java.util.List getAllAPNodes()

Return all the access point (AP) nodes owned by this spec. An AP node is a node that represents a transition from one execution unit (and server) to another execution unit. At execution time, it represents a transfer of data between one server and another.

Returns:

The list of all AP nodes in the graph.

resetAllKMAssignments

public void resetAllKMAssignments()
                           throws MappingException,
                                  AdapterException

Set all node KM assignments back to the default assignment, if one is available. User settings will be retained if they are still valid.

Throws:

MappingException

AdapterException

getTargetNodes

public 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).

syncWithLogicalMapping

public void syncWithLogicalMapping(java.util.List issues)
                            throws MappingException,
                                   AdapterException

Synchronizes this physical design with its logical mapping. If any changes have been made to the logical mapping since the spec was created or last synchronized, the changes will be synchronized to this spec. For example, if a new logical component was added to the logical mapping, then a corresponding new physical node will be added to the physical graph for this spec.

Parameters:

issues - The issue list to populate with any errors or warnings when syncing the spec.

Throws:

MapComponentException

AdapterException

PropertyException

MapPhysicalException

MappingException

syncWithLogicalMapping

public void syncWithLogicalMapping(java.util.List issues,
                                   boolean skipValidation)
                            throws MappingException,
                                   AdapterException

Synchronizes this physical design with its logical mapping. If any changes have been made to the logical mapping since the spec was created or last synchronized, the changes will be synchronized to this spec. For example, if a new logical component was added to the logical mapping, then a corresponding new physical node will be added to the physical graph for this spec.

Parameters:

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.

Throws:

MapComponentException

AdapterException

PropertyException

MapPhysicalException

MappingException

syncWithLogicalMapping

public void syncWithLogicalMapping()
                            throws MappingException,
                                   AdapterException

Synchronizes this physical design with its logical mapping. If any changes have been made to the logical mapping since the spec was created or last synchronized, the changes will be synchronized to this spec. For example, if a new logical component was added to the logical mapping, then a corresponding new physical node will be added to the physical graph for this spec.

Throws:

MapComponentException

MapPhysicalException

PropertyException

AdapterException

MappingException

getPhysicalNodes

public java.util.List getPhysicalNodes()

Get a list of all physical nodes that exist in this physical design physical graph. The nodes are not guaranteed to be sorted in any particular order.

removeExecutionUnit

public void removeExecutionUnit(ExecutionUnit exUnit)
                         throws AdapterException

Remove the specified execution unit from this physical design. The nodes that were contained in the specified execution unit, if any, will be moved to another execution unit.

Parameters:

exUnit - The execution unit to be removed.

Throws:

AdapterException

removeAllExecutionUnits

public void removeAllExecutionUnits()
                             throws AdapterException

Remove all execution units from this physical design. A new group of default execution units will be created after this call.

Throws:

AdapterException

removeAllExecutionUnitGroups

public void removeAllExecutionUnitGroups()

Remove all execution unit groups from this spec. A new default set of execution unit groups will be created after this is called.

getExecutionUnits

public java.util.List getExecutionUnits()

Get the execution units in this physical design. An execution unit is a group of physical nodes in the graph that are all executed by the same server, which is the execution unit location.
The ordered list of execution units is guaranteed not to violate the dependency order of the directed graph of execution units. In other words, the order basically goes along the data flow from source to target.

Returns:

The list of execution units.

getSortedExecutionUnits

public java.util.List getSortedExecutionUnits()
                                       throws MappingException

Do a topological sort on the execution units, and return the sorted list. The returned list is sorted in order from source to target in the graph.

Throws:

MapPhysicalException

MappingException

getSourceExecutionUnits

public java.util.List getSourceExecutionUnits()
                                       throws MappingException

Get a list of all execution units with no upstream connections to other execution units.

Returns:

The list of source execution units.

Throws:

MapPhysicalException

MappingException

getTargetExecutionUnits

public java.util.List getTargetExecutionUnits()
                                       throws MappingException

Get a list of all execution units with no downstream connections to other execution units.

Returns:

The list of the target execution units.

Throws:

MapPhysicalException

MappingException

createExecutionUnit

public ExecutionUnit createExecutionUnit(ILocation location)
                                  throws MappingException,
                                         AdapterException

Create a new execution unit in this physical design. Warning: The new execution unit may be deleted after the next physical design recalculation, if no nodes have been added to it.

Parameters:

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.

Returns:

The newly created execution unit.

Throws:

MappingException

AdapterException

setName

public void setName(java.lang.String name)
             throws MappingException

Throws:

MappingException

findExecutionUnit

public ExecutionUnit findExecutionUnit(java.lang.String name)

Finds an execution unit with the specified name in this physical design. If no unit is found, null is returned.

Parameters:

name - The name of the execution unit to find.

Returns:

The execution unit.

getOwner

public IPropertyOwner getOwner()

getMapping

public Mapping getMapping()

Get the mapping that owns this physical design.

validate

public boolean validate(java.util.List result,
                        boolean debug)

dump

public void dump(java.util.logging.Level level)

getDisplayableTypeName

public java.lang.String getDisplayableTypeName()

createExecutionUnitGroup

public ExecutionUnitGroup createExecutionUnitGroup(java.lang.String name)
                                            throws MappingException

Create a new execution unit group with the specified name. An execution unit group is a group of execution units that will be executed in parallel. The name will be changed if necessary to ensure uniqueness.

Returns:

The newly created group.

Throws:

MapPhysicalException

MappingException

getExecutionUnitGroups

public java.util.List getExecutionUnitGroups()

Get all execution units groups in this physical design. An execution unit group is a group of execution units that will be executed in parallel.

findExecutionUnitGroup

public ExecutionUnitGroup findExecutionUnitGroup(java.lang.String name)

Return an execution unit group with the specified name, or null if not found.

Returns:

The group, if found.

getScenarios

public java.util.List getScenarios()
                            throws AdapterException

Get a list of all scenarios that were generated using this physical design.

Throws:

AdapterException

findScenario

public IScenario findScenario(java.lang.String qualifiedName)
                       throws AdapterException

Find the scenario with the specified name if any. If not found, return null.

Parameters:

qualifiedName - The qualified name of the scenario.

Returns:

The scenario, if found, else null.

Throws:

AdapterException

findScenario

public IScenario findScenario(java.lang.String name,
                              java.lang.String version)
                       throws AdapterException

Find the scenario with the specified name and version if any. If not found, return null.

Parameters:

name - The name of the scenario to be found.

version - The version of the scenrio to be found.

Returns:

The scenario, if found, else null.

Throws:

AdapterException

removeScenario

public void removeScenario(IScenario scen)

Remove the specified scenario from the scenarios that are associated with this physical design.

Parameters:

scen - The scenario to be removed.

getFullName

public java.lang.String getFullName()

getFolder

public IFolder getFolder()

Description copied from interface: IMapPhysicalDesign

Gets the folder which owns this physical designification.

Specified by:

getFolder in interface IMapPhysicalDesign

Returns:

owning folder.

isConcurrent

public boolean isConcurrent()

Returns true if concurrency enabled, false otherwise.

Returns:

if concurrency enabled.

setConcurrent

public void setConcurrent(boolean pConcurrent)

Enables concurrency if 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.

Parameters:

pConcurrent -

isCleanupOnError

public boolean isCleanupOnError()

Returns true if cleanup tasks should be performed on error, false otherwise.

Returns:

if cleanup tasks should be performed.

setCleanupOnError

public void setCleanupOnError(boolean pCleanupOnError)

Cleanup tasks should be performed on error is pCleanupOnError is true.

Parameters:

pCleanupOnError - if cleanup tasks should be performed on error.

setFrozen

public void setFrozen(boolean isFrozen)

Set the frozen value for this physical design. If the spec is frozen, it cannot be altered.

Parameters:

isFrozen - The new value for the frozen flag for this spec.

isFrozen

public boolean isFrozen()

Returns:

true if this physical design is frozen. If the spec is frozen, it cannot be altered.

resetIKMs

public void resetIKMs()
               throws MappingException,
                      AdapterException

Reset all assigned IKMs in the spec to the default setting.

Throws:

AdapterException

MappingException

getSourceExUnitList

public java.util.List getSourceExUnitList()

Returns:

A list of all execution units in the spec that are considered to be source units. The execution unit is considered to be a source unit if its execute on location is SOURCE.

getStagingExUnitList

public java.util.List getStagingExUnitList()

Returns:

A list of all execution units in the spec that are considered to be staging units. An execution unit is considered to be a staging unit if its execute-on location is STAGING.

getTargetExUnitList

public java.util.List getTargetExUnitList()

Returns:

A list of all execution units in the spec that are considered to be target units. An execution unit is considered to be a target unit if its execute-on location is TARGET.

getAllMapReferences

public java.util.List getAllMapReferences()

toString

public java.lang.String toString()

getBeginCmd

public MapExpression getBeginCmd()
                          throws PropertyException

Gets the begin mapping command expression

Returns:

the expression for begin mapping command

Throws:

PropertyException

setBeginCmd

public void setBeginCmd(java.lang.String beginCmd)
                 throws PropertyException

Sets the begin mapping command in text form.

Parameters:

beginCmd - the text for begin mapping command

Throws:

PropertyException

getBeginCmdTechnology

public ITechnology getBeginCmdTechnology()
                                  throws PropertyException

Gets the technology assigned to begin mapping command.

Returns:

a technology assigned to begin mapping command, null if such technology has not been assigned.

Throws:

PropertyException

setBeginCmdTechnology

public void setBeginCmdTechnology(ITechnology techno)
                           throws PropertyException

Sets the technology for begin mapping command.

Parameters:

techno - a technology to be assigned to begin mapping command.

Throws:

PropertyException

getBeginCmdLogicalSchema

public ILogicalSchema getBeginCmdLogicalSchema()
                                        throws PropertyException

Gets the logical schema assigned to begin mapping command.

Returns:

a logical schema assigned to begin mapping command, null if such schema has not been assigned.

Throws:

PropertyException

setBeginCmdLogicalSchema

public void setBeginCmdLogicalSchema(ILogicalSchema lSchema)
                              throws PropertyException

Sets the logical schema for begin mapping command.

Parameters:

lSchema - a logical schema to be assigned to begin mapping command.

Throws:

PropertyException

getEndCmd

public MapExpression getEndCmd()
                        throws PropertyException

Gets the end mapping command expression.

Returns:

the expression for end mapping command

Throws:

PropertyException

setEndCmd

public void setEndCmd(java.lang.String endCmd)
               throws PropertyException

Sets the end mapping command in text form.

Parameters:

endCmd - the text for end mapping command

Throws:

PropertyException

getEndCmdTechnology

public ITechnology getEndCmdTechnology()
                                throws PropertyException

Gets the technology assigned to begin mapping command.

Returns:

a technology ssigned to begin mapping command, null if such technology has not been assigned.

Throws:

PropertyException

setEndCmdTechnology

public void setEndCmdTechnology(ITechnology techno)
                         throws PropertyException

Sets the technology for begin mapping command.

Parameters:

techno - a technology to be assigned to begin mapping command.

Throws:

PropertyException

getEndCmdLogicalSchema

public ILogicalSchema getEndCmdLogicalSchema()
                                      throws PropertyException

Gets the logical schema assigned to end mapping command.

Returns:

a logical schema assigned to end mapping command, null if such schema has not been assigned.

Throws:

PropertyException

setEndCmdLogicalSchema

public void setEndCmdLogicalSchema(ILogicalSchema lSchema)
                            throws PropertyException

Sets the logical schema for end mapping command.

Parameters:

lSchema - a logical schema to be assigned to end mapping command.

Throws:

PropertyException