com.ibm.xtools.transform.core

Class DCMP

java.lang.Object

com.ibm.xtools.transform.core.DCMP

public class DCMP
extends java.lang.Object

This class is responsible for providing access to the Design Contract Management Protocols, DCMPs. It implements the typesafe enum pattern. Each instance of this class represents one of the supported DCMPs. In the context of a transformation configuration, a DCMP is used to control the availability of the reverse transformation and the replace UML elements utility.

Field Summary

Fields

Modifier and Type	Field and Description
static DCMP	CONCEPTUAL The conceptual DCMP.
static DCMP	MIXED The mixed DCMP.
static java.lang.String	PROP_ID The id used in a transformation context to store a DCMP property.
static java.util.List<DCMP>	PROTOCOLS A public list of the supported DCMPs.
static DCMP	RECONCILED The reconciled DCMP.

Method Summary

Modifier and Type	Method and Description
static DCMP	getDCMP(int theId) Returns the DCMP with the given id.
static DCMP	getDCMP(java.lang.String name) Returns the DCMP with the given name.
java.lang.String	getDescription() Returns the description of the DCMP.
int	getId() Returns the id of the DCMP.
java.lang.String	getName() Returns the name of the DCMP.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONCEPTUAL

public static final DCMP CONCEPTUAL

The conceptual DCMP. This is used when the user does not want to use the reverse transformation or the replace UML elements utility.

MIXED

public static final DCMP MIXED

The mixed DCMP. This is used when the user does not want to use the reverse transformation but does want to use the replace UML elements utility.

RECONCILED

public static final DCMP RECONCILED

The reconciled DCMP. This is used when the user wants to use the reverse transformation but does not want to use the replace UML elements utility.

PROTOCOLS

public static final java.util.List<DCMP> PROTOCOLS

A public list of the supported DCMPs.

PROP_ID

public static final java.lang.String PROP_ID

The id used in a transformation context to store a DCMP property.

See Also:

Constant Field Values

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getId

public int getId()

Returns the id of the DCMP.

Returns:

The id of the DCMP.

getName

public java.lang.String getName()

Returns the name of the DCMP.

Returns:

The name of the DCMP.

getDescription

public java.lang.String getDescription()

Returns the description of the DCMP.

Returns:

The description of the DCMP.

getDCMP

public static DCMP getDCMP(int theId)

Returns the DCMP with the given id.

Parameters:

theId - The id of the DCMP to find.

Returns:

The matching DCMP.

getDCMP

public static DCMP getDCMP(java.lang.String name)

Returns the DCMP with the given name.

Parameters:

name - The name of the DCMP to find.

Returns:

The matching DCMP.