org.argouml.model
Class Model

java.lang.Object
  org.argouml.model.Model

public final class Model
extends java.lang.Object

This is the root class of the Model subsystem. All other subsystems can retrieve the correct version of the API from this class.

Notice that all API's returned from this class are to be independent of and specific UML model implementation.

For this to work the Model subsystem needs to be initialized with a ModelImplementation. This is done by calling the static member setImplementation(ModelImplementation).

Since:

0.15.5

Stereotype:

utility

setImplementation

public static void setImplementation(ModelImplementation newImpl)

Selects the implementation.

This must be called with a working ModelImplementation to make the Model subsystem operational.

Parameters:

newImpl - The ModelImplementation object of the selected implementation.

getFacade

public static Facade getFacade()

Get the facade.

The facade is probably the most used interface. It contains recognizers and getters for all method kinds.

Returns:

The facade object.

getPump

public static ModelEventPump getPump()

Get the event pump.

Returns:

the current ModelEventPump.

getDiagramInterchangeModel

public static DiagramInterchangeModel getDiagramInterchangeModel()

Getter for DiagramInterchangeModel.

Returns:

the diagram interchange model

getActivityGraphsFactory

public static ActivityGraphsFactory getActivityGraphsFactory()

Getter for ActivityGraphsFactory.

Returns:

the factory

getActivityGraphsHelper

public static ActivityGraphsHelper getActivityGraphsHelper()

Getter for the ActivityGraphsHelper.

Returns:

the instance of the helper

getCollaborationsFactory

public static CollaborationsFactory getCollaborationsFactory()

Getter for CollaborationsFactory.

Returns:

the factory

getCollaborationsHelper

public static CollaborationsHelper getCollaborationsHelper()

Getter for CollaborationsHelper.

Returns:

the helper

getCommonBehaviorFactory

public static CommonBehaviorFactory getCommonBehaviorFactory()

Getter for CommonBehaviorFactory.

Returns:

the factory

getCommonBehaviorHelper

public static CommonBehaviorHelper getCommonBehaviorHelper()

Getter for CommonBehaviorHelper.

Returns:

the helper

getCoreFactory

public static CoreFactory getCoreFactory()

Getter for CoreFactory.

Returns:

the factory

getCoreHelper

public static CoreHelper getCoreHelper()

Getter for CoreHelper.

Returns:

The helper.

getDataTypesFactory

public static DataTypesFactory getDataTypesFactory()

Getter for DataTypesFactory.

Returns:

the factory

getDataTypesHelper

public static DataTypesHelper getDataTypesHelper()

Getter for DataTypesHelper.

Returns:

the helper.

getExtensionMechanismsFactory

public static ExtensionMechanismsFactory getExtensionMechanismsFactory()

Getter for ExtensionMechanismsFactory.

Returns:

the factory instance.

getExtensionMechanismsHelper

public static ExtensionMechanismsHelper getExtensionMechanismsHelper()

Getter for ExtensionMechanismsHelper.

Returns:

the helper

getModelManagementFactory

public static ModelManagementFactory getModelManagementFactory()

Getter for ModelManagementFactory.

Returns:

the factory

getModelManagementHelper

public static ModelManagementHelper getModelManagementHelper()

Getter for ModelManagementHelper.

Returns:

The model management helper.

getStateMachinesFactory

public static StateMachinesFactory getStateMachinesFactory()

Getter for StateMachinesFactory.

Returns:

the factory

getStateMachinesHelper

public static StateMachinesHelper getStateMachinesHelper()

Getter for StateMachinesHelper.

Returns:

the helper

getUmlFactory

public static UmlFactory getUmlFactory()

Getter for UmlFactory.

Returns:

the factory

getUmlHelper

public static UmlHelper getUmlHelper()

Getter for UmlHelper.

Returns:

the helper

getUseCasesFactory

public static UseCasesFactory getUseCasesFactory()

Getter for UseCasesFactory.

Returns:

the factory

getUseCasesHelper

public static UseCasesHelper getUseCasesHelper()

Getter for UseCasesHelper.

Returns:

the helper

getMetaTypes

public static MetaTypes getMetaTypes()

Getter for the MetaTypes object.

Returns:

the MetaTypes object.

getChangeableKind

@Deprecated
public static ChangeableKind getChangeableKind()

Deprecated. for 0.25.4 by tfmorris. This enumeration has been removed from UML 2. Use the getter for the isReadOnly attribute.

Getter for the ChangeableKind object.

Returns:

The object implementing the interface.

getAggregationKind

public static AggregationKind getAggregationKind()

Getter for the AggregationKind object.

Returns:

The object implementing the interface.

getPseudostateKind

public static PseudostateKind getPseudostateKind()

Getter for the PseudostateKind object.

Returns:

The object implementing the interface.

getScopeKind

@Deprecated
public static ScopeKind getScopeKind()

Deprecated. for 0.25.4 by tfmorris. This has been removed from UML 2. Use Facade.isStatic(Object) instead.

Getter for the ScopeKind object.

Returns:

The object implementing the interface.

getConcurrencyKind

public static ConcurrencyKind getConcurrencyKind()

Getter for the ConcurrencyKind object.

Returns:

The object implementing the interface.

getDirectionKind

public static DirectionKind getDirectionKind()

Getter for the DirectionKind object.

Returns:

The object implementing the interface.

getOrderingKind

public static OrderingKind getOrderingKind()

Getter for the OrderingKind object.

Returns:

The object implementing the interface.

getVisibilityKind

public static VisibilityKind getVisibilityKind()

Getter for the VisibilityKind object.

Returns:

The object implementing the interface.

getXmiReader

public static XmiReader getXmiReader()
                              throws UmlException

Getter for the XmiReader object.

Returns:

the object implementing the XmiReader interface

Throws:

UmlException - on any error while reading

getXmiWriter

public static XmiWriter getXmiWriter(java.lang.Object model,
                                     java.io.OutputStream stream,
                                     java.lang.String version)
                              throws UmlException

Get the XmiWriter object.

Parameters:

model - the project member model

stream - the stream to write to

version - string to be written into file header as XMI writer version

Returns:

the object implementing the XmiWriter interface

Throws:

UmlException - on any error while writing

initialise

public static java.lang.Throwable initialise(java.lang.String modelName)

Initialise the model repository, based on the name of a ModelImplementation class.

The name shall include the path, e.g. "org.argouml.model.mdr.MDRModelImplementation".

Parameters:

modelName - class name of the model implementation

Returns:

null if initialised correctly, the error otherwise

isInitiated

public static boolean isInitiated()

Returns:

true if the Model subsystem is correctly initiated.

setModelCommandCreationObserver

public static void setModelCommandCreationObserver(ModelCommandCreationObserver observer)

Allows an external system to register itself to receive commands created by the model implementation.

Parameters:

observer - the interested party

See Also:

ModelCommand

getModelCommandCreationObserver

public static ModelCommandCreationObserver getModelCommandCreationObserver()

Gets the external class responsible for handling commands.

Returns:

the observer

execute

public static java.lang.Object execute(ModelCommand command)

Notify any observer that a command has been created and execute that it.

Parameters:

command - The newly created command.

Returns:

the resulting object from the command

getCopyHelper

public static CopyHelper getCopyHelper()

Getter for CopyHelper.

Returns:

the helper