com.ashridgetech.jamda.transform
Interface ModelTransformer

All Known Implementing Classes:

AbstractModelTransformer

public interface ModelTransformer

Interface for a class which can perform an operation on a UML Model. This may include making changes to the Model. Each instance must be capable of being reused many times.

Author:

Paul Boocock version 1.0

Nested Class Summary

static class

ModelTransformer.TransformException Thrown by transform(com.ashridgetech.jamda.uml.Model) to indicate an error in the trnsformation.

Method Summary

TransformerConfig	getConfig() Get a configuration object for this transformer.
java.lang.String	getDescription() Get a short description of this transformer, including details of its configuration.
java.util.Collection	standardElementDefs() Get the definitions of the standard model elements required by the transformer.
void	transform(Model model) Transform a given Model.

Method Detail

transform

public void transform(Model model)
               throws ModelTransformer.TransformException

Transform a given Model.

Parameters:

model - the Model on which to operate

ModelTransformer.TransformException

getConfig

public TransformerConfig getConfig()

Get a configuration object for this transformer. This instance must retain a reference to the configuration object so it can use it after it has been populated.

Returns:

the specific config object for this transformer

getDescription

public java.lang.String getDescription()

Get a short description of this transformer, including details of its configuration.

Returns:

the description

standardElementDefs

public java.util.Collection standardElementDefs()
                                         throws ModelTransformer.TransformException

Get the definitions of the standard model elements required by the transformer.

Returns:

a Collection which contains any mixture of

• StandardElementDef objects
• Class objects from which StandardElementDef constants will be extracted by Model.extractStandardElements(java.lang.Class)

ModelTransformer.TransformException