ClassifierRoleNotationUml (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.argouml.notation.providers.uml
Class ClassifierRoleNotationUml

java.lang.Object
  org.argouml.notation.NotationProvider
      org.argouml.notation.providers.ClassifierRoleNotation
          org.argouml.notation.providers.uml.ClassifierRoleNotationUml

public class ClassifierRoleNotationUml
extends ClassifierRoleNotation
extends ClassifierRoleNotation

The UML notation for a ClassifierRole.

The following is supported:

 baselist := [base] [, base]*
 classifierRole := [name] [/ role] [: baselist]

The role and baselist can be given in any order.

The name is the Instance name, not used for a ClassifierRole.

This syntax is compatible with the UML 1.3 and 1.4 specification.

Constructor Summary
`ClassifierRoleNotationUml(java.lang.Object classifierRole)` The Constructor.

Method Summary
`java.lang.String`	`getParsingHelp()`
`void`	`parse(java.lang.Object modelElement, java.lang.String text)` Parses the given text, and adapts the modelElement and maybe related elements accordingly.
`protected java.lang.Object`	`parseClassifierRole(java.lang.Object cls, java.lang.String s)` Parses a ClassifierRole represented by the following line of the format:
`java.lang.String`	`toString(java.lang.Object modelElement, NotationSettings settings)` Generate a string representation for the given model element.

Methods inherited from class org.argouml.notation.providers.ClassifierRoleNotation
`initialiseListener`

Methods inherited from class org.argouml.notation.NotationProvider
`addElementListener, addElementListener, addElementListener, cleanListener, formatNameList, formatNameList, removeAllElementListeners, removeElementListener, updateListener`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ClassifierRoleNotationUml

public ClassifierRoleNotationUml(java.lang.Object classifierRole)

The Constructor.

Parameters:: classifierRole - the UML ClassifierRole

Method Detail

getParsingHelp

public java.lang.String getParsingHelp()

Specified by:: getParsingHelp in class NotationProvider

Returns:: a i18 key that represents a help string giving an explanation to the user of the syntax

parse

public void parse(java.lang.Object modelElement,
                  java.lang.String text)

Description copied from class: NotationProvider

Parses the given text, and adapts the modelElement and maybe related elements accordingly.

Specified by:: parse in class NotationProvider

Parameters:: modelElement - the modelelement to adapt; text - the string given by the user to be parsed to adapt the model

parseClassifierRole

protected java.lang.Object parseClassifierRole(java.lang.Object cls,
                                               java.lang.String s)
                                        throws java.text.ParseException

Parses a ClassifierRole represented by the following line of the format:

 baselist := [base] [, base]*
 classifierRole := [name] [/ role] [: baselist]

role and baselist can be given in any order.

This syntax is compatible with the UML 1.3 specification. (formerly: "name: base" )

Parameters:: cls - the classifier role to apply any changes to; s - the String to parse
Returns:: the classifier role with the applied changes
Throws:: java.text.ParseException - when it detects an error in the attribute string. See also ParseError.getErrorOffset().

toString

public java.lang.String toString(java.lang.Object modelElement,
                                 NotationSettings settings)

Description copied from class: NotationProvider

Generate a string representation for the given model element.

Specified by:: toString in class NotationProvider

Parameters:: modelElement - the base UML element; settings - settings that control rendering of the text
Returns:: the string written in the correct notation