|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.argouml.uml.generator.Generator | +--org.argouml.uml.generator.GeneratorDisplay
Generator subclass to generate text for display in diagrams in in text fields in the Argo/UML user interface. The generated code looks a lot like (invalid) Java. The idea is that other generators could be written for outher languages. This code is just a placeholder for future development, I expect it to be totally replaced.
Nested Class Summary | |
---|---|
(package private) class |
GeneratorDisplay.MsgPtr
|
Field Summary | |
---|---|
static java.lang.String |
ANY_RANGE
|
private static GeneratorDisplay |
SINGLETON
|
Fields inherited from class org.argouml.uml.generator.Generator |
---|
INDENT, TEST_SUFFIX |
Fields inherited from interface org.argouml.application.api.Pluggable |
---|
PLUGIN_PREFIX, PLUGIN_TITLE, PLUGIN_VENDOR |
Fields inherited from interface org.argouml.application.api.ArgoModule |
---|
cat, MODULEFILENAME, MODULEFILENAME_ALTERNATE |
Constructor Summary | |
---|---|
private |
GeneratorDisplay()
|
Method Summary | |
---|---|
boolean |
canParse()
Can the notation be parsed at all? |
boolean |
canParse(java.lang.Object o)
Can the notation be parsed for this object? |
(package private) int |
countSuccessors(java.lang.Object m)
|
static java.lang.String |
Generate(java.lang.Object o)
|
java.lang.String |
generateAction(java.lang.Object m)
|
java.lang.String |
generateAssociation(MAssociation a)
|
java.lang.String |
generateAssociationEnd(MAssociationEnd ae)
|
java.lang.String |
generateAssociationFrom(java.lang.Object a,
MAssociationEnd ae)
|
java.lang.String |
generateAssociationRole(MAssociationRole assocRole)
generate the name of an association role of the form: / name : name of the base association |
java.lang.String |
generateAttribute(MAttribute attr,
boolean documented)
Generates a string representation for the provided attribute. |
java.lang.String |
generateChangability(MStructuralFeature sf)
|
java.lang.String |
generateClassifier(MClassifier cls)
|
java.lang.String |
generateClassList(java.util.Collection classifiers)
|
java.lang.String |
generateConstraint(MConstraint c)
|
java.lang.String |
generateConstraints(MModelElement me)
|
java.lang.String |
generateExtensionPoint(MExtensionPoint ep)
Generate the display for an extension point. |
java.lang.String |
generateGeneralization(java.util.Collection generalizations,
boolean impl)
|
java.lang.String |
generateGuard(MGuard m)
|
java.lang.String |
generateMessage(MMessage m)
Generates a textual description for a MMessage m. |
java.lang.String |
generateMessageNumber(java.lang.Object message)
Generates the textual number of MMessage m. |
private java.lang.String |
generateMessageNumber(java.lang.Object m,
java.lang.Object pre,
int position)
|
java.lang.String |
generateMultiplicity(MMultiplicity m)
|
protected java.lang.String |
generateMultiplicityRange(MMultiplicityRange mr)
Generates a multiplicity range. |
java.lang.String |
generateOperation(MOperation op,
boolean documented)
Generates an operation accordin to the UML 1.3 notation: stereotype visibility name (parameter-list) : return-type-expression {property-string} For the return-type-expression: only the types of the return parameters are shown. |
java.lang.String |
generatePackage(MPackage p)
|
java.lang.String |
generateParameter(MParameter parameter)
|
java.lang.String |
generateRecurrence(java.lang.Object expr)
Generates a textual description of a MIterationExpression. |
java.lang.String |
generateScope(MFeature f)
|
java.lang.String |
generateState(MState m)
|
java.lang.String |
generateStateBody(MState m)
|
java.lang.String |
generateTaggedValue(MTaggedValue tv)
|
java.lang.String |
generateTransition(MTransition m)
|
java.lang.String |
generateVisibility(MVisibilityKind vis)
|
static GeneratorDisplay |
getInstance()
|
java.lang.String |
getModuleAuthor()
The module author. |
java.lang.String |
getModuleDescription()
Textual description of the module. |
java.lang.String |
getModuleKey()
The module identifying key |
java.lang.String |
getModuleName()
Display name of the module. |
java.lang.String |
getModuleVersion()
The module version. |
boolean |
inContext(java.lang.Object[] o)
A function which allows a plug-in to decide if it is available under a specific context. |
boolean |
isModuleEnabled()
The default for any Generator is to be enabled. |
(package private) int |
recCountPredecessors(java.lang.Object message,
GeneratorDisplay.MsgPtr ptr)
|
Methods inherited from class org.argouml.uml.generator.Generator |
---|
generate, generateClassifierRef, generateExpression, generateName, generateStereotype, generateUninterpreted, getCodePath, getGenerator, getModulePopUpActions, getNotation, initializeModule, isTestModus, setModuleEnabled, setTestModus, shutdownModule |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private static GeneratorDisplay SINGLETON
public static final java.lang.String ANY_RANGE
Constructor Detail |
private GeneratorDisplay()
Method Detail |
public static GeneratorDisplay getInstance()
public static java.lang.String Generate(java.lang.Object o)
public java.lang.String generateExtensionPoint(MExtensionPoint ep)
Generate the display for an extension point.
The representation is "name: location". "name :" is omitted if there is no name given.
generateExtensionPoint
in interface NotationProvider
generateExtensionPoint
in class Generator
ep
- The extension point.
public java.lang.String generateOperation(MOperation op, boolean documented)
generateOperation
in interface NotationProvider
generateOperation
in class Generator
NotationProvider.generateOperation(
MOperation, boolean)
public java.lang.String generateAttribute(MAttribute attr, boolean documented)
generateAttribute
in interface NotationProvider
generateAttribute
in class Generator
NotationProvider.generateAttribute(
MAttribute, boolean)
public java.lang.String generateParameter(MParameter parameter)
generateParameter
in interface NotationProvider
generateParameter
in class Generator
public java.lang.String generatePackage(MPackage p)
generatePackage
in interface NotationProvider
generatePackage
in class Generator
public java.lang.String generateClassifier(MClassifier cls)
generateClassifier
in interface NotationProvider
generateClassifier
in class Generator
public java.lang.String generateTaggedValue(MTaggedValue tv)
generateTaggedValue
in interface NotationProvider
generateTaggedValue
in class Generator
public java.lang.String generateMessageNumber(java.lang.Object message)
If you plan to modify this number, make sure that ParserDisplay.parseMessage is adapted to the change.
message
- A MMessage to generate the number for.
private java.lang.String generateMessageNumber(java.lang.Object m, java.lang.Object pre, int position)
int recCountPredecessors(java.lang.Object message, GeneratorDisplay.MsgPtr ptr)
int countSuccessors(java.lang.Object m)
public java.lang.String generateRecurrence(java.lang.Object expr)
public java.lang.String generateMessage(MMessage m)
generateMessage
in interface NotationProvider
generateMessage
in class Generator
m
- A MMessage to generate a description for.
public java.lang.String generateAssociationFrom(java.lang.Object a, MAssociationEnd ae)
public java.lang.String generateAssociation(MAssociation a)
generateAssociation
in interface NotationProvider
generateAssociation
in class Generator
public java.lang.String generateAssociationEnd(MAssociationEnd ae)
generateAssociationEnd
in interface NotationProvider
generateAssociationEnd
in class Generator
public java.lang.String generateConstraints(MModelElement me)
public java.lang.String generateConstraint(MConstraint c)
public java.lang.String generateAssociationRole(MAssociationRole assocRole)
public java.lang.String generateGeneralization(java.util.Collection generalizations, boolean impl)
public java.lang.String generateClassList(java.util.Collection classifiers)
public java.lang.String generateVisibility(MVisibilityKind vis)
generateVisibility
in interface NotationProvider
generateVisibility
in class Generator
public java.lang.String generateScope(MFeature f)
public java.lang.String generateChangability(MStructuralFeature sf)
public java.lang.String generateMultiplicity(MMultiplicity m)
generateMultiplicity
in interface NotationProvider
generateMultiplicity
in class Generator
NotationProvider.generateMultiplicity(
MMultiplicity)
protected java.lang.String generateMultiplicityRange(MMultiplicityRange mr)
mr
-
public java.lang.String generateState(MState m)
generateState
in interface NotationProvider
generateState
in class Generator
public java.lang.String generateStateBody(MState m)
public java.lang.String generateTransition(MTransition m)
generateTransition
in interface NotationProvider
generateTransition
in class Generator
public java.lang.String generateAction(java.lang.Object m)
generateAction
in interface NotationProvider
generateAction
in class Generator
public java.lang.String generateGuard(MGuard m)
generateGuard
in interface NotationProvider
generateGuard
in class Generator
public boolean canParse()
NotationProvider
public boolean canParse(java.lang.Object o)
NotationProvider
public java.lang.String getModuleName()
ArgoModule
public java.lang.String getModuleDescription()
ArgoModule
public java.lang.String getModuleAuthor()
ArgoModule
public java.lang.String getModuleVersion()
ArgoModule
public java.lang.String getModuleKey()
ArgoModule
public boolean inContext(java.lang.Object[] o)
Pluggable
inContext
in interface Pluggable
inContext
in class Generator
o
- An identification of the context.
The interpretation of criteria is specific to
the plug-in type, but must be consistent
across that type. The plug-in must want
to be exposed to all contexts.
Pluggable.inContext(java.lang.Object[])
public boolean isModuleEnabled()
Generator
isModuleEnabled
in interface ArgoModule
isModuleEnabled
in class Generator
ArgoModule.isModuleEnabled()
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ArgoUML © 1996-2004 (20040306) | ArgoUML Homepage | ArgoUML Developers' page | ArgoUML Cookbook |