org.argouml.application.api
Interface NotationProvider2

All Known Implementing Classes:
Generator2, NotationHelper

public interface NotationProvider2

Interface provided by classes that provide a notation.

This interface is used by all elements in the Diagrams whenever some UML-object needs to be converted into a text string.

For UML this interface is implemented by GeneratorDisplay. For Java it is implemented by GeneratorJava. TODO: ParserDisplay and this interface should probably be joined into an editable field instead.

See Also:
org.argouml.language

Method Summary
 String generateAction(Object m)
          Generate the String representation for an Action.
 String generateActionState(Object actionState)
          Generate the String representation for an Action State.
 String generateAssociation(Object a)
          Generate the String representation for an Association.
 String generateAssociationEnd(Object ae)
          Generate the String representation for an AssociationEnd.
 String generateAssociationRole(Object m)
          Generate the String representation for an AssociationRole.
 String generateAttribute(Object attr, boolean documented)
          Generate the String representation for an Attribute.
 String generateClassifier(Object cls)
          Generate the String representation for a Classifier.
 String generateClassifierRef(Object m)
          Generate the String representation for a ClassifierRef.
 String generateEvent(Object m)
          Generate the String representation for an Event.
 String generateExpression(Object expr)
          Generate the String representation for an Expression.
 String generateExtensionPoint(Object op)
          Generate the String representation for an ExtensionPoint.
 String generateGuard(Object m)
          Generate the String representation for a Guard.
 String generateMessage(Object m)
          Generate the String representation for a Message.
 String generateMultiplicity(Object m)
          Generate the String representation for an Multiplicity.
 String generateName(String name)
          Convert a String to a name.
 String generateObjectFlowState(Object m)
          Generate the String representation for a ObjectFlowState.
 String generateOperation(Object op, boolean documented)
          Generate the String representation for an Operation.
 String generatePackage(Object pkg)
          Generate the String representation for a Package.
 String generateParameter(Object parameter)
          Generate the String representation for a Parameter.
 String generateState(Object m)
          Generate the String representation for a State.
 String generateStateBody(Object stt)
          Generate the String representation for a StateBody.
 String generateStereotype(Object s)
          Generate the String representation for a Stereotype.
 String generateSubmachine(Object m)
          Generate the String representation for a Submachine.
 String generateTaggedValue(Object s)
          Generate the String representation for a TaggedValue.
 String generateTransition(Object m)
          Generate the String representation for a Transition.
 String generateVisibility(Object m)
          Generate the String representation for a Visibility.
 NotationName getNotation()
           
 

Method Detail

getNotation

public NotationName getNotation()
Returns:
The name of this notation.

generateExtensionPoint

public String generateExtensionPoint(Object op)
Generate the String representation for an ExtensionPoint.

Parameters:
op - Object to generate representation for.
Returns:
The String representation of the object.

generateOperation

public String generateOperation(Object op,
                                boolean documented)
Generate the String representation for an Operation.

Parameters:
op - Object to generate representation for.
documented - true if documentation shall be generated.
Returns:
The String representation of the object.

generateAttribute

public String generateAttribute(Object attr,
                                boolean documented)
Generate the String representation for an Attribute.

Parameters:
attr - Object to generate representation for.
documented - true if documentation shall be generated.
Returns:
The String representation of the object.

generateParameter

public String generateParameter(Object parameter)
Generate the String representation for a Parameter.

Parameters:
parameter - Object to generate representation for.
Returns:
The String representation of the object.

generateName

public String generateName(String name)
Convert a String to a name.

TODO: What is the purpose of this function? Is it really needed?

Parameters:
name - The String to be converted.
Returns:
The name.

generatePackage

public String generatePackage(Object pkg)
Generate the String representation for a Package.

Parameters:
pkg - Object to generate representation for.
Returns:
The String representation of the object.

generateExpression

public String generateExpression(Object expr)
Generate the String representation for an Expression.

Parameters:
expr - Object to generate representation for.
Returns:
The String representation of the object.

generateClassifier

public String generateClassifier(Object cls)
Generate the String representation for a Classifier.

Parameters:
cls - Object to generate representation for.
Returns:
The String representation of the object.

generateStereotype

public String generateStereotype(Object s)
Generate the String representation for a Stereotype.

Parameters:
s - Object to generate representation for. This can also be a Collection with all stereotypes.
Returns:
The String representation of the object.

generateTaggedValue

public String generateTaggedValue(Object s)
Generate the String representation for a TaggedValue.

Parameters:
s - Object to generate representation for.
Returns:
The String representation of the object.

generateAssociation

public String generateAssociation(Object a)
Generate the String representation for an Association.

Parameters:
a - Object to generate representation for.
Returns:
The String representation of the object.

generateAssociationEnd

public String generateAssociationEnd(Object ae)
Generate the String representation for an AssociationEnd.

Parameters:
ae - Object to generate representation for.
Returns:
The String representation of the object.

generateMultiplicity

public String generateMultiplicity(Object m)
Generate the String representation for an Multiplicity.

Parameters:
m - Object to generate representation for.
Returns:
The String representation of the object.

generateObjectFlowState

public String generateObjectFlowState(Object m)
Generate the String representation for a ObjectFlowState.

Parameters:
m - Object to generate representation for.
Returns:
The String representation of the object.

generateState

public String generateState(Object m)
Generate the String representation for a State.

Parameters:
m - Object to generate representation for.
Returns:
The String representation of the object.

generateStateBody

public String generateStateBody(Object stt)
Generate the String representation for a StateBody.

Parameters:
stt - Object to generate representation for.
Returns:
The String representation of the object.

generateSubmachine

public String generateSubmachine(Object m)
Generate the String representation for a Submachine.

Parameters:
m - Object to generate representation for.
Returns:
The String representation of the object.

generateTransition

public String generateTransition(Object m)
Generate the String representation for a Transition.

Parameters:
m - Object to generate representation for.
Returns:
The String representation of the object.

generateVisibility

public String generateVisibility(Object m)
Generate the String representation for a Visibility.

Parameters:
m - Object to generate representation for.
Returns:
The String representation of the object.

generateAction

public String generateAction(Object m)
Generate the String representation for an Action.

Parameters:
m - Object to generate representation for.
Returns:
The String representation of the object.

generateActionState

public String generateActionState(Object actionState)
Generate the String representation for an Action State.

Parameters:
actionState - Object to generate representation for.
Returns:
The String representation of the object.

generateGuard

public String generateGuard(Object m)
Generate the String representation for a Guard.

Parameters:
m - Object to generate representation for.
Returns:
The String representation of the object.

generateMessage

public String generateMessage(Object m)
Generate the String representation for a Message.

Parameters:
m - Object to generate representation for.
Returns:
The String representation of the object.

generateEvent

public String generateEvent(Object m)
Generate the String representation for an Event.

Parameters:
m - Object to generate representation for.
Returns:
The String representation of the object.

generateClassifierRef

public String generateClassifierRef(Object m)
Generate the String representation for a ClassifierRef.

Parameters:
m - Object to generate representation for.
Returns:
The String representation of the object.

generateAssociationRole

public String generateAssociationRole(Object m)
Generate the String representation for an AssociationRole.

Parameters:
m - Object to generate representation for.
Returns:
The String representation of the object.


ArgoUML © 1996-2004 (20050222)ArgoUML HomepageArgoUML Developers' pageArgoUML Cookbook