org.argouml.model
Class Model

java.lang.Object
  extended byorg.argouml.model.Model

public final class Model
extends Object

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

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

Since:
0.15.5

Method Summary
static ActivityGraphsFactory getActivityGraphsFactory()
          Getter for ActivityGraphsFactory.
static ActivityGraphsHelper getActivityGraphsHelper()
          Getter for the ActivityGraphsHelper.
static AggregationKind getAggregationKind()
          Getter for the AggregationKind object.
static ChangeableKind getChangeableKind()
          Getter for the ChangeableKind object.
static CollaborationsFactory getCollaborationsFactory()
          Getter for CollaborationsFactory.
static CollaborationsHelper getCollaborationsHelper()
          Getter for CollaborationsHelper.
static CommonBehaviorFactory getCommonBehaviorFactory()
          Getter for CommonBehaviorFactory.
static CommonBehaviorHelper getCommonBehaviorHelper()
          Getter for CommonBehaviorHelper.
static ConcurrencyKind getConcurrencyKind()
          Getter for the ConcurrencyKind object.
static CopyHelper getCopyHelper()
          Getter for CopyHelper.
static CoreFactory getCoreFactory()
          Getter for CoreFactory.
static CoreHelper getCoreHelper()
          Getter for CoreHelper.
static DataTypesFactory getDataTypesFactory()
          Getter for DataTypesFactory.
static DataTypesHelper getDataTypesHelper()
          Getter for DataTypesHelper.
static DiagramInterchangeModel getDiagramInterchangeModel()
          Getter for DiagramInterchangeModel.
static DirectionKind getDirectionKind()
          Getter for the DirectionKind object.
static EventAdapter getEventAdapter()
          Deprecated. for 0.21.2 by tfmorris. Use getPump() and ModelEventPump methods
static ExtensionMechanismsFactory getExtensionMechanismsFactory()
          Getter for ExtensionMechanismsFactory.
static ExtensionMechanismsHelper getExtensionMechanismsHelper()
          Getter for ExtensionMechanismsHelper.
static Facade getFacade()
          Get the facade.
static MementoCreationObserver getMementoCreationObserver()
          Gets the external class responsible for handling mementos.
static MetaTypes getMetaTypes()
          Getter for the MetaTypes object.
static ModelManagementFactory getModelManagementFactory()
          Getter for ModelManagementFactory.
static ModelManagementHelper getModelManagementHelper()
          Getter for ModelManagementHelper.
static OrderingKind getOrderingKind()
          Getter for the OrderingKind object.
static PseudostateKind getPseudostateKind()
          Getter for the PseudostateKind object.
static ModelEventPump getPump()
          Get the event pump.
static ScopeKind getScopeKind()
          Getter for the ScopeKind object.
static StateMachinesFactory getStateMachinesFactory()
          Getter for StateMachinesFactory.
static StateMachinesHelper getStateMachinesHelper()
          Getter for StateMachinesHelper.
static UmlFactory getUmlFactory()
          Getter for UmlFactory.
static UmlHelper getUmlHelper()
          Getter for UmlHelper.
static UseCasesFactory getUseCasesFactory()
          Getter for UseCasesFactory.
static UseCasesHelper getUseCasesHelper()
          Getter for UseCasesHelper.
static VisibilityKind getVisibilityKind()
          Getter for the VisibilityKind object.
static XmiReader getXmiReader()
          Getter for the XmiReader object.
static XmiWriter getXmiWriter(Object model, Writer writer)
          Getter for the XmiWriter object.
static boolean isInitiated()
           
static void notifyMementoCreationObserver(ModelMemento memento)
          Notify any observer that a memento has been created.
static void setMementoCreationObserver(MementoCreationObserver observer)
          Allows an external system to register itself to recieve mementos created by the model subsystem.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

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

getEventAdapter

public static EventAdapter getEventAdapter()
Deprecated. for 0.21.2 by tfmorris. Use getPump() and ModelEventPump methods

Getter for EventAdapter.

Returns:
the event adapter

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

public static ChangeableKind getChangeableKind()
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

public static ScopeKind getScopeKind()
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(Object model,
                                     Writer writer)
                              throws UmlException
Getter for the XmiWriter object.

Parameters:
model - the project member model
writer - the writer
Returns:
the object implementing the XmiWriter interface
Throws:
UmlException - on any error while writing

isInitiated

public static boolean isInitiated()
Returns:
true if the Model subsystem is correctly initiated.

setMementoCreationObserver

public static void setMementoCreationObserver(MementoCreationObserver observer)
Allows an external system to register itself to recieve mementos created by the model subsystem.

Parameters:
observer - the interested party

getMementoCreationObserver

public static MementoCreationObserver getMementoCreationObserver()
Gets the external class responsible for handling mementos.

Returns:
the MementoCreationObserver

notifyMementoCreationObserver

public static void notifyMementoCreationObserver(ModelMemento memento)
Notify any observer that a memento has been created.

Parameters:
memento - The newly created memento.

getCopyHelper

public static CopyHelper getCopyHelper()
Getter for CopyHelper.

Returns:
the helper


ArgoUML © 1996-2006ArgoUML HomepageArgoUML Cookbook