com.nomagic.magicdraw.uml

Class RepresentationTextCreator

java.lang.Object

com.nomagic.uml2.impl.ModelHierarchyVisitor

com.nomagic.magicdraw.uml.Visitor

com.nomagic.magicdraw.uml.InheritanceVisitor

com.nomagic.magicdraw.uml.RepresentationTextCreator

All Implemented Interfaces:

AbstractVisitor, ModelVisitor

@OpenApiAll
public class RepresentationTextCreator
extends InheritanceVisitor

Class for creating text of BaseElements represented in various UI components (tree nodes, text labels and etc).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RepresentationTextCreator.RepresentationTextProvider Deprecated. use RepresentationTextProvider2
static interface	RepresentationTextCreator.RepresentationTextProvider2 Representation text provider extension point.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COLOR_POSTFIX
static java.lang.String	COLOR_PREFIX
static char	CONJUGATED_SYMBOL
static java.lang.String	DEFAULT_VALUE_SEPARATOR
static java.lang.String	EMPTY_NAME_NOTATION
static java.lang.String	FONT_COLOR_END
static java.lang.String	FONT_COLOR_PREFIX
static java.lang.String	GRAY_COLOR_STRING
static java.lang.String	INHERITED_SIGN
static java.lang.String	LEFT_SIGN
static int	MAX_TEXT_LENGTH
static char	MODULE_VERSION_SEPARATOR
static java.lang.String	NEUTRAL_SIGN
static java.lang.String	NEW_LINE_SEPARATOR
static java.lang.String	RIGHT_SIGN
static java.lang.String	TYPE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
RepresentationTextCreator()

Method Summary

Modifier and Type	Method and Description
static void	addProvider(RepresentationTextCreator.RepresentationTextProvider provider) Registers a new representation text provider.
static void	addProvider(RepresentationTextCreator.RepresentationTextProvider2 provider) Registers a new representation text provider.
static void	addSpaceAfterUnitBeforeNextValue(java.util.List<ValueSpecification> valueSpecifications, java.lang.StringBuilder stringBuilder) Unit symbol is separated from other values if needed by space
static void	appendColor(java.lang.StringBuffer text, java.awt.Color color) Set given color to given text.
static java.lang.String	appendColor(java.lang.String text, java.awt.Color color) Set given color to given text.
static java.lang.String	appendGrayColor(java.lang.String text) Set Gray color to given text.
static void	appendGrayColor(java.lang.StringBuffer text) Set Gray color to given text.
static java.lang.String	appendLockInfo(BaseElement element, java.lang.String text, boolean addColorInformation) Add check out information.
static java.lang.String	appendLockInfo(BaseElement baseElement, java.lang.String text, boolean addColorInformation, boolean addBrackets) Add check out information.
protected void	cleanResult() Clears created representation result.
static java.lang.String	constructActivityEdgeText(ActivityEdge activityEdge, boolean showWeight) Construct activity edge text
static java.lang.String	constructCombinedFragmentOperatorText(CombinedFragment combinedFragment)
static java.lang.String	constructGeneralizationSetText(GeneralizationSet set, boolean showPowerType)
static java.lang.String	constructModuleText(Element element)
static java.lang.String	createActivityParameterNodeText(ActivityParameterNode parameter, boolean showFullType, boolean addColorInformation) Creates text which represents activity parameter node.
static java.lang.String	createAssociationText(Association association) Create Association text.
static java.lang.String	createBehaviorText(Behavior behavior) Creates behavior text.
static java.lang.String	createBehaviorText(Behavior behavior, boolean showStereotype, boolean showProperties, boolean showInheritedSign, boolean showSignature, boolean showFullType, boolean showConstraintName, boolean showConstraintExpression, boolean addColorInformation, boolean showParameterDirectionKind)
static java.lang.String	createBehaviorText(Behavior behavior, boolean showStereotype, boolean showProperties, boolean showInheritedSign, boolean showSignature, boolean showFullType, boolean showConstraintName, boolean showConstraintExpression, boolean addColorInformation, boolean showParameterDirectionKind, boolean showOpaqueBehaviorBody) Deprecated.
static java.lang.String	createBehaviorText(Behavior behavior, boolean showStereotype, boolean showProperties, boolean showTaggedValues, boolean showInheritedSign, boolean showSignature, boolean showFullType, boolean showConstraintName, boolean showConstraintExpression, boolean addColorInformation, boolean showParameterDirectionKind, boolean showOpaqueBehaviorBody) Creates behavior text.
static java.lang.String	createClassifierName(Classifier cl, boolean showFullType, boolean addColorInformation) Creates string: classifier name.
static java.lang.String	createClassifiersRepresentation(java.util.Collection classifiers, boolean showFullType, boolean addColorInformation) Returns representation of given classifiers collection
static java.lang.String	createConstraintsText(java.util.Collection<Constraint> constraints, java.lang.String separator, boolean useName, boolean useExpression, boolean addBrackets) Build a representation string from given collection of constraints.
static java.lang.String	createConstraintsText(Constraint constraint, boolean useName, boolean useExpression, boolean addBrackets) Create constraint text.
static java.lang.String	createConstraintsText(ValueSpecification valueSpecification, boolean addBrackets) Add constraint text.
static java.lang.String	createConveyedInformationText(java.util.List<Classifier> information, boolean showAutoIDNumber)
static java.lang.String	createDefaultRepresentationText(BaseElement element, boolean addColor, boolean fullSignature)
static java.lang.String	createDefaultRepresentationText(BaseElement element, boolean addColor, boolean fullSignature, boolean showAutoId) Gets default (not extended) representation text.
static java.lang.String	createDefaultRepresentationText(BaseElement element, boolean addColor, boolean fullSignature, boolean showAutoId, LocationInTool locationInTool) Gets default (not extended) representation text.
static java.lang.String	createElementNameText(Element o) Creates from element name if available.
static java.lang.String	createEnumerationLiteralText(EnumerationLiteral enumLiteral, boolean showStereotype, boolean showProperties, boolean showConstraintName, boolean showConstraintExpression) Deprecated. use createEnumerationLiteralText(EnumerationLiteral, boolean, boolean, boolean, boolean, boolean, boolean)
static java.lang.String	createEnumerationLiteralText(EnumerationLiteral enumLiteral, boolean showStereotype, boolean showProperties, boolean showConstraintName, boolean showConstraintExpression, boolean showInheritedSign) Deprecated. use createEnumerationLiteralText(EnumerationLiteral, boolean, boolean, boolean, boolean, boolean, boolean, boolean)
static java.lang.String	createEnumerationLiteralText(EnumerationLiteral enumLiteral, boolean showStereotype, boolean showProperties, boolean showTaggedValues, boolean showConstraintName, boolean showConstraintExpression, boolean showInheritedSign)
static java.lang.String	createEnumerationLiteralText(EnumerationLiteral enumLiteral, boolean showStereotype, boolean showProperties, boolean showTaggedValues, boolean showConstraintName, boolean showConstraintExpression, boolean showInheritedSign, boolean addColorInformation) Constructs enumeration literal text.
static java.lang.String	createEventText(Event event) Creates textual representation of event.
static java.lang.String	createEventText(Event event, boolean showOperationsSignature, boolean useAdvancedColoring)
static java.lang.String	createGuardText(Message msg) Creates Message guard text.
static java.lang.String	createId(Element e, boolean addColor) Create the id (number) to be prepended to the text representation of the element
static java.lang.String	createInstanceSpecificationText(InstanceSpecification instance, boolean showClassifier, boolean showFullType, boolean addColorInformation) Create representation text for instance
static java.lang.String	createInstanceSpecificationText(InstanceSpecification instance, boolean showClassifier, boolean showFullType, boolean addColorInformation, boolean showAutoID)
static java.lang.String	createInteractionUseText(CallBehaviorAction interactionUse) Create InteractionUse text from representative CallBehaviorAction.
static java.lang.String	createInteractionUseText(InteractionUse interactionUse, boolean addReferTo, boolean addArguments) Create InteractionUse text.
static java.lang.String	createMultiplicityRangeText(java.lang.Integer range) Creates multiplicity range text.
static java.lang.String	createMultiplicityText(java.lang.Integer lower, java.lang.Integer upper) Creates multiplicity text.
static java.lang.String	createMultiplicityText(MultiplicityElement multiplicity, boolean showOrder, boolean showUnique, boolean addBrackets) Returns text representation of given multiplicity.
static java.lang.String	createMultiplicityText(java.lang.String lower, java.lang.String upper, boolean ordered, boolean unique, boolean addBrackets) Returns text representation of given multiplicity.
static java.lang.String	createMultiplicityText(java.lang.String lower, java.lang.String upper, ValueSpecification lowerValue, boolean unique, boolean ordered, boolean addBrackets)
static java.lang.String	createNamedElementListText(java.util.List<? extends NamedElement> elements) Creates representation text for a list of named elements.
static java.lang.String	createOperandGuardText(InteractionOperand operand)
static java.lang.String	createOperationText(Operation operation, boolean showSignature, boolean showVisibility, boolean showFullType, boolean showStereotype, boolean showProperties, boolean showConstraintName, boolean showConstraintExpression, boolean showParameterDirection, boolean addColorInformation, boolean showTemplateParameters) Constructs representation operation text.
static java.lang.String	createOperationText(Operation operation, boolean showSignature, boolean showVisibility, boolean showFullType, boolean showStereotype, boolean showProperties, boolean showConstraintName, boolean showConstraintExpression, boolean showParameterDirection, boolean addColorInformation, boolean showTemplateParameters, boolean showParameterDefaultValue) Constructs representation operation text.
static java.lang.String	createOperationText(Operation operation, boolean showSignature, boolean showVisibility, boolean showFullType, boolean showStereotype, boolean showProperties, boolean showConstraintName, boolean showConstraintExpression, boolean showParameterDirection, boolean addColorInformation, boolean showTemplateParameters, boolean showParameterDefaultValue, boolean showInheritedSign) Deprecated. use any one of the other createOperationText methods.
static java.lang.String	createOperationText(Operation operation, boolean showSignature, boolean showVisibility, boolean showFullType, boolean showStereotype, boolean showProperties, boolean showTaggedValues, boolean showConstraintName, boolean showConstraintExpression, boolean showParameterDirection, boolean addColorInformation, boolean showTemplateParameters, boolean showParameterDefaultValue, boolean showInheritedSign) Constructs representation operation text.
static java.lang.String	createParameterDirectionText(Project project, java.lang.Class<? extends Parameter> parameterMetaType, ParameterDirectionKind parameterDirection, boolean skipDefaultValue, boolean showReturnDirection, boolean addColorInformation) Creates a text for parameter direction
static java.lang.String	createParametersText(java.util.Collection parameters, boolean showSignature, boolean showFullType, boolean showParameterDirection, boolean addColorInformation) Create parameter text.
static java.lang.String	createParametersText(java.util.Collection parameters, boolean showSignature, boolean showFullType, boolean showParameterDirection, boolean addColorInformation, boolean showParameterDefaultValue) Create parameter text.
static java.lang.String	createParameterText(Parameter parameter, boolean showFullType, boolean showParameterDirection, boolean addColorInformation) Creates text which represents parameter.
static java.lang.String	createParameterText(Parameter parameter, boolean showFullType, boolean showParameterDirection, boolean addColorInformation, boolean showDefaultValue) Creates text which represents parameter.
static java.lang.String	createParameterText(Parameter parameter, boolean showFullType, boolean showParameterDirection, boolean addColorInformation, boolean showDefaultValue, boolean skipDefaultDirection, boolean showReturnDirection) Creates text which represents parameter.
static java.lang.String	createPinText(Pin pin, boolean showName, boolean showType, boolean showMultiplicity, boolean showFullType, boolean addColor, boolean showSynchronizationInfo)
static java.lang.String	createPortText(Port port, boolean showName, boolean showType, boolean showMultiplicity, boolean showFullType, boolean addColor)
static java.lang.String	createPortText(Port port, boolean showName, boolean showType, boolean showMultiplicity, boolean showFullType, boolean showInheritedSign, boolean addColor)
static java.lang.String	createPortText(Port port, boolean showName, boolean showType, boolean showMultiplicity, boolean showFullType, boolean showTaggedValues, boolean showInheritedSign, boolean addColor)
static void	createPropertyPropertyStringText(Property property, java.lang.StringBuffer text)
static void	createPropertyPropertyStringText(Property property, java.lang.StringBuffer text, java.lang.String separator)
static java.lang.String	createPropertyText(Property property, boolean showName, boolean showType, boolean showVisibility, boolean showFullType, boolean showInitValue, boolean showStereotype, boolean showProperties, boolean showConstraints, boolean showMultiplicity, boolean addColorInformation) Deprecated. Use createPropertyText(PropertyTextParameter).
static java.lang.String	createPropertyText(Property property, boolean showName, boolean showType, boolean showVisibility, boolean showFullType, boolean showInitValue, boolean showStereotype, boolean showProperties, boolean showTypeTaggedValues, boolean showConstraintName, boolean showConstraintExpression, boolean showMultiplicity, boolean addColorInformation) Deprecated. Use createPropertyText(PropertyTextParameter).
static java.lang.String	createPropertyText(Property property, boolean showName, boolean showType, boolean showDerived, boolean showVisibility, boolean showFullType, boolean showInitValue, boolean showStereotype, boolean showProperties, boolean showTypeTaggedValues, boolean showConstraintName, boolean showConstraintExpression, boolean showMultiplicity, boolean addColorInformation) Deprecated. Use createPropertyText(PropertyTextParameter).
static java.lang.String	createPropertyText(Property property, boolean showName, boolean showType, boolean showDerived, boolean showVisibility, boolean showFullType, boolean showInitValue, boolean showStereotype, boolean showProperties, boolean showTypeTaggedValues, boolean showConstraintName, boolean showConstraintExpression, boolean showMultiplicity, boolean showInheritedSign, boolean addColorInformation) Deprecated. Use createPropertyText(PropertyTextParameter).
static java.lang.String	createPropertyText(Property property, boolean showName, boolean showType, boolean showDerived, boolean showVisibility, boolean showFullType, boolean showInitValue, boolean showStereotype, boolean showProperties, boolean showTaggedValues, boolean showTypeTaggedValues, boolean showConstraintName, boolean showConstraintExpression, boolean showMultiplicity, boolean showInheritedSign, boolean addColorInformation) Deprecated. Use createPropertyText(PropertyTextParameter).
static java.lang.String	createPropertyText(PropertyTextParameter propertyTextParameter) Constructs attribute view text.
static java.lang.String	createProtocolTransitionText(ProtocolTransition transition)
static java.lang.String	createProtocolTransitionText(ProtocolTransition transition, boolean showPort)
static java.lang.String	createProtocolTransitionText(ProtocolTransition transition, boolean showPort, boolean showOperationsSignature, boolean useAdvancedColoring) Constructs text representation of given protocol.
static java.lang.String	createPureSlotsString(java.util.Collection<Slot> cs, java.lang.String separator, boolean showHTML, boolean showEmptyValue) Returns string representation of given slots collection.
static java.lang.String	createReceptionText(Reception reception, boolean showSignature, boolean showVisibility, boolean showFullType, boolean showStereotype, boolean showProperties, boolean showConstraintName, boolean showConstraintExpression, boolean showParameterDirection, boolean addColorInformation) Constructs representation reception text.
static java.lang.String	createReceptionText(Reception reception, boolean showSignature, boolean showVisibility, boolean showFullType, boolean showStereotype, boolean showProperties, boolean showConstraintName, boolean showConstraintExpression, boolean showParameterDirection, boolean showInheritedSign, boolean addColorInformation) Deprecated.
static java.lang.String	createReceptionText(Reception reception, boolean showSignature, boolean showVisibility, boolean showFullType, boolean showStereotype, boolean showProperties, boolean showTaggedValues, boolean showConstraintName, boolean showConstraintExpression, boolean showParameterDirection, boolean showInheritedSign, boolean addColorInformation) Constructs representation reception text.
static java.util.Comparator<BaseElement>	createRepresentationTextComparator(boolean addColor, boolean showAutoId) Creates a comparator for comparing BaseElements by representation text
static java.lang.String	createRoleText(Property property, char endName) Creates role text.
static java.lang.String	createRoleText(Property property, char endName, int compressTypeNumber) Creates role text.
static java.lang.String	createSlotsText(java.util.Collection<Slot> cs, java.lang.String separator, boolean showHTML, boolean showEmptyValue) Returns string representation of given slots collection.
static java.lang.String	createSlotText(Slot slot, boolean showName, boolean ignoreTrueValues, boolean showHTML, boolean showFeatureType, boolean showFullType, boolean addColorInformation, boolean showEmptyValue, boolean showQualifiedName) Returns string representation of given tag definition.
static java.lang.String	createSlotText(Slot slot, boolean showName, boolean ignoreTrueValues, boolean showHTML, boolean showFeatureType, boolean showFullType, boolean showFeatureTypeTaggedValues, boolean addColorInformation, boolean showEmptyValue, boolean showQualifiedName) Returns string representation of given tag definition.
static java.lang.String	createSlotText(Slot slot, boolean showName, boolean ignoreTrueValues, boolean showHTML, boolean showFeatureType, boolean showFullType, boolean showFeatureTypeTaggedValues, boolean addColorInformation, boolean showEmptyValue, boolean showQualifiedName, boolean showDerived) Returns string representation of given tag definition.
static java.lang.String	createSlotText(Slot slot, boolean showName, boolean ignoreTrueValues, boolean showHTML, boolean showFeatureType, boolean showFullType, boolean showFeatureTypeTaggedValues, boolean addColorInformation, boolean showEmptyValue, boolean showQualifiedName, boolean showDerived, boolean forEditing, boolean colorUnitSymbols, boolean colorTag) Returns string representation of given tag definition.
static java.lang.String	createStateText(State state) Creates state name text.
static java.lang.String	createStereotypesText(java.util.Collection<Stereotype> stereotypes, char separator) Returns string representation of given.
static java.lang.String	createStereotypesText(java.util.Collection<Stereotype> stereotypes, char separator, boolean skipDSL, boolean useAlias) Returns string representation of given.
static java.lang.String	createStereotypesText(Element element, char separator) Create the representation text of element be assigned stereotype.
static java.lang.String	createStereotypesText(Element element, char separator, boolean skipDSL, boolean useAlias) Create the representation text of element be assigned stereotype.
static java.lang.String	createStereotypeText(Stereotype stereotype)
static java.lang.String	createStereotypeText(Stereotype stereotype, boolean useAlias)
static java.lang.String	createStereotypeText(java.lang.String stereotypeName)
static java.lang.String	createTemplateBindingText(TemplateBinding binding) Constructs given binding element text.
static java.lang.String	createTemplateBindingText(TemplateBinding binding, boolean attachTemplateParameterInfo) Constructs given binding element text.
static java.lang.String	createTemplateParametersText(java.util.Collection templateParameters, java.lang.String separator) Create the Template Parameters Text.
static java.lang.String	createTemplateParameterSubstitutionText(TemplateParameterSubstitution parameterSubstitution, boolean attachTemplateParameterInfo) Create TemplateParameterSubstitution Text.
static java.lang.String	createTemplateParameterText(TemplateParameter tParameter) Creates TemplateParameter text.
static java.lang.String	createTransitionText(Transition transition, boolean showEffect)
static java.lang.String	createTransitionText(Transition transition, boolean showEffect, boolean showPort, boolean showOpaqueBehaviorBody)
static java.lang.String	createTransitionText(Transition transition, boolean showEffect, boolean showPort, boolean showOpaqueBehaviorBody, boolean showOperationsSignature, boolean useAdvancedColoring) Constructs text representation of given transition object.
static java.lang.String	createTriggersText(java.util.Collection triggers)
static java.lang.String	createTriggersText(java.util.Collection triggers, boolean showPort) Create Triggers text.
static java.lang.String	createTriggersText(java.util.Collection triggers, boolean showPort, boolean showOperationsSignature, boolean useAdvancedColoring) Create Triggers text.
static java.lang.String	createTriggerText(Trigger trigger)
static java.lang.String	createTriggerText(Trigger trigger, boolean showPort)
static java.lang.String	createTriggerText(Trigger trigger, boolean showPort, boolean showOperationsSignature, boolean useAdvancedColoring)
static java.lang.String	createTypedElementText(TypedElement typedElement, boolean showName, boolean showType, boolean showMultiplicity, boolean showFullType, boolean addColor)
static java.lang.String	createTypeName(Type cl, boolean showFullType, boolean addColorInformation) Creates string: classifier name.
static java.lang.String	createValueSpecificationText(ValueSpecification specification) Create ValueSpecification text.
static char	createVisibilityText(VisibilityKind visibility) Returns visibility representation(+, # or -)
static java.lang.String	endColorHtmlTag(java.lang.String text) Return appended colour html end tag to given text.
static void	endColorHtmlTag(java.lang.StringBuilder text)
static java.lang.String	getAbsoluteUMLPathToRoot(Element element) Method returns string representing path from root package to this object data.
static boolean	getFullName(Element element, java.lang.StringBuffer path, java.lang.String separator, boolean checkTopStereotype) Get NameElement full name.
static boolean	getFullName(Element element, java.lang.StringBuffer path, java.lang.String separator, boolean checkTopStereotype, boolean checkTopModelElement) Get NameElement full name.
static java.lang.String	getFullUMLName(Element element) Method returns full UML name for object.
static java.lang.String	getFullUMLName(Element element, boolean doNotAddTopLevels) Get Full UML Name.
static RepresentationTextCreator	getInstance()
LocationInTool	getLocationInTool()
static java.lang.String	getModelElementNameWithParentPath(NamedElement namedElement, boolean addColor) Get Model element name with parent path.
static java.lang.String	getModelElementParentPath(Element modelElement, boolean addBrackets) Get Model Element with parent path.
static java.lang.String	getPathToRoot(Element element) Get Path of given element to root of element.
static java.lang.String	getPathToRoot(Element element, boolean checkTop) Get path to root.
static java.lang.String	getPathToRoot(Element data, boolean relativeToLibrary, boolean compactMode) Calculates qualified name to display in the shape header.
static java.lang.String	getPathToRoot(Element data, boolean relativeToLibrary, boolean relativeToModel, boolean compactMode) Calculates qualified name to display in the shape header.
static java.lang.String	getPathToRoot(Element element, boolean toModelLibrary, boolean toModel, java.lang.String separator) Get path to root.
static java.lang.String	getPathToRoot(Element element, boolean checkTop, java.lang.String separator) Get path to root.
static RepresentationTextCreator.RepresentationTextProvider2	getProvider2For(BaseElement element) Looks for a provider for a given element.
static RepresentationTextCreator.RepresentationTextProvider	getProviderFor(BaseElement element) Looks for a provider for a given element.
static java.lang.String	getPureTextFromColoredText(java.lang.String coloredText)
java.lang.String	getRelationshipFromToPart(Element relationship, Element clientModelElement, Element supplierModelElement)
java.lang.String	getRelationshipFromToPart(Relationship o)
static java.lang.String	getRelationshipFromToRepresentation(Element relationship, Element clientModelElement, java.lang.String clientName, Element supplierModelElement, java.lang.String supplierName, boolean showFullType, boolean addColor) Returns relation representation part to represent from what element to what element relation is connected.
static java.lang.String	getRepresentedText(BaseElement el) Returns representation text for any Element
static java.lang.String	getRepresentedText(BaseElement el, boolean addColor)
static java.lang.String	getRepresentedText(BaseElement el, boolean addColor, boolean showAutoId) Returns representation text for any Element
static java.lang.String	getRepresentedText(BaseElement el, boolean addColor, boolean showAutoId, boolean fullSignature) Returns representation text for any Element
static java.lang.String	getRepresentedText(BaseElement el, boolean addColor, boolean showAutoId, boolean fullSignature, boolean noCache) Returns representation text for any Element
static java.lang.String	getRepresentedText(BaseElement el, boolean addColor, boolean showAutoId, boolean fullSignature, LocationInTool locationInTool, boolean noCache) Returns representation text for any Element
protected java.lang.String	getResult() Returns created representation result
static java.lang.String	getTemplateParameterTypeAsString(TemplateParameter tParameter) Get String representation of given TemplateParameter Type.
static void	invalidateRepresentationCache(Project project)
boolean	isAddColor() Test is add color.
boolean	isCreateBoundElementName()
boolean	isShowFullType()
static boolean	isUseStandardStereotypeKeywordChar()
static java.lang.String	putInQuotes(java.lang.String text)
static void	removeProvider(RepresentationTextCreator.RepresentationTextProvider provider) Registers a new representation text provider.
static void	removeProvider(RepresentationTextCreator.RepresentationTextProvider2 provider) Registers a new representation text provider.
static java.lang.String	removeQuotationMarksFromSlotText(java.lang.String slotText) Removes quotation marks from given slot representation.
void	resetAutoIdRepresentations(Project project) clear the cache for all elements that are part of the given project and are 'numberable'
void	resetCache(BaseElement element) Reset all cached information about given element
void	resetCache(java.util.Collection<? extends BaseElement> elements) Reset all cached information about given elements
static java.lang.String	resetColor(java.lang.String text) Reset text color.
static void	resetColor(java.lang.StringBuffer text) Reset text color.
void	setAddColor(boolean addColor) Set new add color value.
void	setCreateBoundElementName(boolean createBoundElementName)
void	setLocationInTool(LocationInTool locationInTool)
void	setShowFullType(boolean value) Set show full type.
static void	setUseStandardStereotypeKeywordChar(boolean useStandard) Forces to use standard stereotype keyword char or a double <>
static void	startColorHtmlTag(java.lang.StringBuilder text, java.awt.Color color)
static java.lang.String	startColorHtmlTag(java.lang.String text, java.awt.Color color) Returns appended colour html start tag to given text.
void	visitAcceptEventAction(AcceptEventAction element, VisitorContext context) Visitor method for AcceptEventAction.
void	visitActivityEdge(ActivityEdge o, VisitorContext context) Visitor method for ActivityEdge.
void	visitActivityParameterNode(ActivityParameterNode activityParameterNode, VisitorContext visitorContext) Visitor method for ActivityParameterNode.
void	visitActivityPartition(ActivityPartition activityPartition, VisitorContext visitorContext) Visitor method for ActivityPartition.
void	visitAssociationClass(AssociationClass element, VisitorContext context) Visitor method for AssociationClass.
void	visitBaseElement(BaseElement o) Method visits given object.
void	visitBehavior(Behavior element, VisitorContext cnt) Visitor method for Behavior.
void	visitBehavioredClassifier(BehavioredClassifier element, VisitorContext context) Visitor method for BehavioredClassifier.
void	visitCallBehaviorAction(CallBehaviorAction callBehaviorAction, VisitorContext visitorContext) Visitor method for CallBehaviorAction.
void	visitCallOperationAction(CallOperationAction callOperationAction, VisitorContext visitorContext) Visitor method for CallOperationAction.
void	visitClass(Class aClass, VisitorContext visitorContext) Visitor method for Class.
void	visitCollaborationUse(CollaborationUse element, VisitorContext context) Visitor method for CollaborationUse.
void	visitCombinedFragment(CombinedFragment element, VisitorContext context) Visitor method for CombinedFragment.
void	visitComment(Comment comment, VisitorContext visitorContext) Visitor method for Comment.
void	visitConnector(Connector o, VisitorContext context) Visitor method for Connector.
void	visitConnectorEnd(ConnectorEnd o, VisitorContext context) Visitor method for ConnectorEnd.
void	visitConstraint(Constraint constraint, VisitorContext visitorContext) Visitor method for Constraint.
void	visitDiagram(Diagram element, VisitorContext context) Visitor method for Diagram.
void	visitDiagramPresentationElement(DiagramPresentationElement o) Visit DiagramPresentationElement
void	visitElementImport(ElementImport element, VisitorContext context) Visitor method for ElementImport.
void	visitEnumerationLiteral(EnumerationLiteral element, VisitorContext context) Visitor method for EnumerationLiteral.
void	visitEvent(Event event, VisitorContext visitorContext) Visitor method for Event.
void	visitExceptionHandler(ExceptionHandler element, VisitorContext context) Visitor method for ExceptionHandler.
void	visitGeneralization(Generalization generalization, VisitorContext visitorContext) Visitor method for Generalization.
void	visitInstanceSpecification(InstanceSpecification instanceSpecification, VisitorContext visitorContext) Visitor method for InstanceSpecification.
void	visitInteractionOperand(InteractionOperand element, VisitorContext context) Visitor method for InteractionOperand.
void	visitInterface(Interface anInterface, VisitorContext visitorContext) Visitor method for Interface.
void	visitLifeline(Lifeline lifeline, VisitorContext visitorContext) Visitor method for Lifeline.
void	visitMessage(Message message, VisitorContext visitorContext) Visitor method for Message.
void	visitModel(Model element, VisitorContext context) Visitor method for Model.
void	visitNamedElement(NamedElement o, VisitorContext context) Visitor method for NamedElement.
void	visitOpaqueAction(OpaqueAction element, VisitorContext context) Visitor method for OpaqueAction.
void	visitOpaqueBehavior(OpaqueBehavior element, VisitorContext context) Visitor method for OpaqueBehavior.
void	visitOperation(Operation operation, VisitorContext visitorContext) Visitor method for Operation.
void	visitParameter(Parameter parameter, VisitorContext visitorContext) Visitor method for Parameter.
void	visitPin(Pin element, VisitorContext context) Visitor method for Pin.
void	visitProperty(Property property, VisitorContext visitorContext) Visitor method for Property.
void	visitReception(Reception element, VisitorContext context) Visitor method for Reception.
void	visitRelationship(Relationship o, VisitorContext context) Visitor method for Relationship.
void	visitSendSignalAction(SendSignalAction sendSignalAction, VisitorContext context) Visitor method for SendSignalAction.
void	visitSlot(Slot slot, VisitorContext visitorContext) Visitor method for Slot.
void	visitStereotype(Stereotype o, VisitorContext context) Visitor method for Stereotype.
void	visitTemplateParameter(TemplateParameter templateParameter, VisitorContext visitorContext) Visitor method for TemplateParameter.
void	visitTemplateParameterSubstitution(TemplateParameterSubstitution parameterSubstitution, VisitorContext visitorContext) Visitor method for TemplateParameterSubstitution.
void	visitTextBoxView(TextBoxView o)
void	visitTransition(Transition element, VisitorContext context) Visitor method for Transition.
void	visitTrigger(Trigger element, VisitorContext context) Visitor method for Trigger.
void	visitTypedElement(TypedElement element, VisitorContext context) Visitor method for TypedElement.
void	visitValueSpecification(ValueSpecification valueSpecification, VisitorContext visitorContext) Visitor method for ValueSpecification.
void	visitValueSpecificationAction(ValueSpecificationAction element, VisitorContext context) Visitor method for ValueSpecificationAction.

Methods inherited from class com.nomagic.magicdraw.uml.InheritanceVisitor

visitPathConnector, visitPathElement, visitPresentationElement, visitShapeElement

Methods inherited from class com.nomagic.magicdraw.uml.Visitor

visitProject

Methods inherited from class com.nomagic.uml2.impl.ModelHierarchyVisitor

visitAbstraction, visitAcceptCallAction, visitAction, visitActionExecutionSpecification, visitActionInputPin, visitActivity, visitActivityFinalNode, visitActivityGroup, visitActivityNode, visitActor, visitAddStructuralFeatureValueAction, visitAddVariableValueAction, visitAnyReceiveEvent, visitArtifact, visitAssociation, visitBehavioralFeature, visitBehaviorExecutionSpecification, visitBroadcastSignalAction, visitCallAction, visitCallEvent, visitCentralBufferNode, visitChangeEvent, visitClassifier, visitClassifierTemplateParameter, visitClause, visitClearAssociationAction, visitClearStructuralFeatureAction, visitClearVariableAction, visitCollaboration, visitCommunicationPath, visitComponent, visitComponentRealization, visitConditionalNode, visitConnectableElement, visitConnectableElementTemplateParameter, visitConnectionPointReference, visitConsiderIgnoreFragment, visitContinuation, visitControlFlow, visitControlNode, visitCreateLinkAction, visitCreateLinkObjectAction, visitCreateObjectAction, visitDataStoreNode, visitDataType, visitDecisionNode, visitDependency, visitDeployedArtifact, visitDeployment, visitDeploymentSpecification, visitDeploymentTarget, visitDestroyLinkAction, visitDestroyObjectAction, visitDestructionOccurrenceSpecification, visitDevice, visitDirectedRelationship, visitDuration, visitDurationConstraint, visitDurationInterval, visitDurationObservation, visitElement, visitElementValue, visitEncapsulatedClassifier, visitEnumeration, visitExecutableNode, visitExecutionEnvironment, visitExecutionOccurrenceSpecification, visitExecutionSpecification, visitExpansionNode, visitExpansionRegion, visitExpression, visitExtend, visitExtension, visitExtensionEnd, visitExtensionPoint, visitFeature, visitFinalNode, visitFinalState, visitFlowFinalNode, visitForkNode, visitFunctionBehavior, visitGate, visitGeneralizationSet, visitGeneralOrdering, visitImage, visitInclude, visitInformationFlow, visitInformationItem, visitInitialNode, visitInputPin, visitInstanceValue, visitInteraction, visitInteractionConstraint, visitInteractionFragment, visitInteractionUse, visitInterfaceRealization, visitInterruptibleActivityRegion, visitInterval, visitIntervalConstraint, visitInvocationAction, visitJoinNode, visitLinkAction, visitLinkEndCreationData, visitLinkEndData, visitLinkEndDestructionData, visitLiteralBoolean, visitLiteralInteger, visitLiteralNull, visitLiteralReal, visitLiteralSpecification, visitLiteralString, visitLiteralUnlimitedNatural, visitLoopNode, visitManifestation, visitMergeNode, visitMessageEnd, visitMessageEvent, visitMessageOccurrenceSpecification, visitMultiplicityElement, visitNamespace, visitNode, visitObjectFlow, visitObjectNode, visitObservation, visitOccurrenceSpecification, visitOpaqueExpression, visitOperationTemplateParameter, visitOutputPin, visitPackage, visitPackageableElement, visitPackageImport, visitPackageMerge, visitParameterableElement, visitParameterSet, visitPartDecomposition, visitPort, visitPrimitiveType, visitProfile, visitProfileApplication, visitProtocolConformance, visitProtocolStateMachine, visitProtocolTransition, visitPseudostate, visitQualifierValue, visitRaiseExceptionAction, visitReadExtentAction, visitReadIsClassifiedObjectAction, visitReadLinkAction, visitReadLinkObjectEndAction, visitReadLinkObjectEndQualifierAction, visitReadSelfAction, visitReadStructuralFeatureAction, visitReadVariableAction, visitRealization, visitReclassifyObjectAction, visitRedefinableElement, visitRedefinableTemplateSignature, visitReduceAction, visitRegion, visitRemoveStructuralFeatureValueAction, visitRemoveVariableValueAction, visitReplyAction, visitSendObjectAction, visitSequenceNode, visitSignal, visitSignalEvent, visitStartClassifierBehaviorAction, visitStartObjectBehaviorAction, visitState, visitStateInvariant, visitStateMachine, visitStringExpression, visitStructuralFeature, visitStructuralFeatureAction, visitStructuredActivityNode, visitStructuredClassifier, visitSubstitution, visitTemplateableElement, visitTemplateBinding, visitTemplateSignature, visitTestIdentityAction, visitTimeConstraint, visitTimeEvent, visitTimeExpression, visitTimeInterval, visitTimeObservation, visitType, visitUnmarshallAction, visitUsage, visitUseCase, visitValuePin, visitVariable, visitVariableAction, visitVertex, visitWriteLinkAction, visitWriteStructuralFeatureAction, visitWriteVariableAction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODULE_VERSION_SEPARATOR

public static final char MODULE_VERSION_SEPARATOR

See Also:

Constant Field Values

MAX_TEXT_LENGTH

public static final int MAX_TEXT_LENGTH

See Also:

Constant Field Values

TYPE_SEPARATOR

public static final java.lang.String TYPE_SEPARATOR

See Also:

Constant Field Values

DEFAULT_VALUE_SEPARATOR

public static final java.lang.String DEFAULT_VALUE_SEPARATOR

See Also:

Constant Field Values

EMPTY_NAME_NOTATION

public static final java.lang.String EMPTY_NAME_NOTATION

See Also:

Constant Field Values

INHERITED_SIGN

public static final java.lang.String INHERITED_SIGN

See Also:

Constant Field Values

GRAY_COLOR_STRING

public static final java.lang.String GRAY_COLOR_STRING

See Also:

Constant Field Values

CONJUGATED_SYMBOL

public static final char CONJUGATED_SYMBOL

See Also:

Constant Field Values

RIGHT_SIGN

public static final java.lang.String RIGHT_SIGN

See Also:

Constant Field Values

LEFT_SIGN

public static final java.lang.String LEFT_SIGN

See Also:

Constant Field Values

NEUTRAL_SIGN

public static final java.lang.String NEUTRAL_SIGN

See Also:

Constant Field Values

NEW_LINE_SEPARATOR

public static final java.lang.String NEW_LINE_SEPARATOR

See Also:

Constant Field Values

COLOR_PREFIX

public static java.lang.String COLOR_PREFIX

FONT_COLOR_PREFIX

public static java.lang.String FONT_COLOR_PREFIX

FONT_COLOR_END

public static java.lang.String FONT_COLOR_END

COLOR_POSTFIX

public static java.lang.String COLOR_POSTFIX

Constructor Detail

RepresentationTextCreator

public RepresentationTextCreator()

Method Detail

getRepresentedText

public static java.lang.String getRepresentedText(BaseElement el)

Returns representation text for any Element

Parameters:

el - element which representation text will be created.

Returns:

representation text for any given element.

getRepresentedText

public static java.lang.String getRepresentedText(BaseElement el,
                                                  boolean addColor)

invalidateRepresentationCache

public static void invalidateRepresentationCache(Project project)

getRepresentedText

public static java.lang.String getRepresentedText(BaseElement el,
                                                  boolean addColor,
                                                  boolean showAutoId)

Returns representation text for any Element

Parameters:

el - element which representation text will be created.

addColor - add color into representation text

showAutoId - if true will prepend the autoId to the representation

Returns:

representation text for any given element.

getRepresentedText

public static java.lang.String getRepresentedText(BaseElement el,
                                                  boolean addColor,
                                                  boolean showAutoId,
                                                  boolean fullSignature)

Returns representation text for any Element

Parameters:

el - element which representation text will be created.

addColor - add color into representation text

showAutoId - if true will prepend the autoId to the representation

fullSignature - show full signature for elements

Returns:

representation text for any given element.

getRepresentedText

public static java.lang.String getRepresentedText(BaseElement el,
                                                  boolean addColor,
                                                  boolean showAutoId,
                                                  boolean fullSignature,
                                                  boolean noCache)

Returns representation text for any Element

Parameters:

el - element which representation text will be created.

addColor - add color into representation text

showAutoId - if true will prepend the autoId to the representation

fullSignature - show full signature for elements

noCache - flag to indicate to not use cached representation text

Returns:

representation text for any given element.

getRepresentedText

public static java.lang.String getRepresentedText(BaseElement el,
                                                  boolean addColor,
                                                  boolean showAutoId,
                                                  boolean fullSignature,
                                                  LocationInTool locationInTool,
                                                  boolean noCache)

Returns representation text for any Element

Parameters:

el - element which representation text will be created.

addColor - add color into representation text

showAutoId - if true will prepend the autoId to the representation

fullSignature - show full signature for elements

locationInTool - location in tool where text will be used

noCache - flag to indicate to not use cached representation text

Returns:

representation text for any given element.

createDefaultRepresentationText

public static java.lang.String createDefaultRepresentationText(BaseElement element,
                                                               boolean addColor,
                                                               boolean fullSignature)

createDefaultRepresentationText

public static java.lang.String createDefaultRepresentationText(BaseElement element,
                                                               boolean addColor,
                                                               boolean fullSignature,
                                                               boolean showAutoId)

Gets default (not extended) representation text.

Parameters:

element - element for which to retrieve representation text.

addColor - indicates if color information be added.

fullSignature - indicates if full signature should be provided.

showAutoId - adding the AutoId to the representation

Returns:

default (not extended) representation text.

createDefaultRepresentationText

public static java.lang.String createDefaultRepresentationText(BaseElement element,
                                                               boolean addColor,
                                                               boolean fullSignature,
                                                               boolean showAutoId,
                                                               LocationInTool locationInTool)

Gets default (not extended) representation text.

Parameters:

element - element for which to retrieve representation text.

addColor - indicates if color information be added.

fullSignature - indicates if full signature should be provided.

showAutoId - adding the AutoId to the representation

locationInTool - location in tool where text will be used

Returns:

default (not extended) representation text.

createId

public static java.lang.String createId(Element e,
                                        boolean addColor)

Create the id (number) to be prepended to the text representation of the element

Parameters:

e - the element

addColor - if true wrap in grey color tags

Returns:

the auto id (with space at the end) or empty string if number is not available

getInstance

public static RepresentationTextCreator getInstance()

getModelElementParentPath

public static java.lang.String getModelElementParentPath(Element modelElement,
                                                         boolean addBrackets)

Get Model Element with parent path.

Parameters:

modelElement - The give

addBrackets - True for add brackets to string.

Returns:

parent path

getModelElementNameWithParentPath

public static java.lang.String getModelElementNameWithParentPath(NamedElement namedElement,
                                                                 boolean addColor)

Get Model element name with parent path.

Parameters:

namedElement - The given name element.

addColor - Add color flag.

Returns:

Model Element Name with Parent Path.

createElementNameText

public static java.lang.String createElementNameText(@CheckForNull
                                                     Element o)

Creates from element name if available.

Parameters:

o - element

Returns:

element name if it's NamedElement or empty string otherwise

getRelationshipFromToRepresentation

public static java.lang.String getRelationshipFromToRepresentation(Element relationship,
                                                                   @CheckForNull
                                                                   Element clientModelElement,
                                                                   java.lang.String clientName,
                                                                   @CheckForNull
                                                                   Element supplierModelElement,
                                                                   java.lang.String supplierName,
                                                                   boolean showFullType,
                                                                   boolean addColor)

Returns relation representation part to represent from what element to what element relation is connected. For example if we connect Connector to 2 properties a and b, that are Owned by class Class1. In Containment browser we would see "Connector[Class1::a - Class1::b]" so this method returns the part for the representation "[Class1::a - Class1::b]".

Parameters:

relationship - relationship for which we want the representation part

clientModelElement - first element

clientName - first element name

supplierModelElement - second element

supplierName - second element name

showFullType - flag to indicate if we need to show full types of elements

addColor - flag to indicate if we gray out parent of element

Returns:

representation of first and second element for relation

resetColor

public static java.lang.String resetColor(java.lang.String text)

Reset text color.

Parameters:

text - The text value.

Returns:

Text.

appendGrayColor

public static java.lang.String appendGrayColor(java.lang.String text)

Set Gray color to given text.

Parameters:

text - Given text.

Returns:

Text with gray color.

appendGrayColor

public static void appendGrayColor(java.lang.StringBuffer text)

Set Gray color to given text.

Parameters:

text - Given text.

resetColor

public static void resetColor(java.lang.StringBuffer text)

Reset text color.

Parameters:

text - The text value.

appendColor

public static void appendColor(java.lang.StringBuffer text,
                               java.awt.Color color)

Set given color to given text.

Parameters:

text - Given text.

color - color

startColorHtmlTag

public static void startColorHtmlTag(java.lang.StringBuilder text,
                                     java.awt.Color color)

startColorHtmlTag

public static java.lang.String startColorHtmlTag(java.lang.String text,
                                                 java.awt.Color color)

Returns appended colour html start tag to given text.

Parameters:

text - Text to which append colour html start tag.

color - Colour to use.

Returns:

Appended colour html start tag to given text.

endColorHtmlTag

public static void endColorHtmlTag(java.lang.StringBuilder text)

endColorHtmlTag

public static java.lang.String endColorHtmlTag(java.lang.String text)

Return appended colour html end tag to given text.

Parameters:

text - Text to which append colour html end tag.

Returns:

Appended colour html end tag to given text.

appendColor

public static java.lang.String appendColor(java.lang.String text,
                                           java.awt.Color color)

Set given color to given text.

Parameters:

text - Given text.

color - color

Returns:

Text with given color.

getPureTextFromColoredText

public static java.lang.String getPureTextFromColoredText(java.lang.String coloredText)

appendLockInfo

public static java.lang.String appendLockInfo(BaseElement element,
                                              java.lang.String text,
                                              boolean addColorInformation)

Add check out information.

Parameters:

element - Element.

text - The given text.

addColorInformation - True for set color.

Returns:

String.

appendLockInfo

public static java.lang.String appendLockInfo(BaseElement baseElement,
                                              java.lang.String text,
                                              boolean addColorInformation,
                                              boolean addBrackets)

Add check out information.

Parameters:

baseElement - Element.

text - The given text.

addColorInformation - True for set color.

addBrackets - add brackets.

Returns:

String.

createPropertyText

@Deprecated
public static java.lang.String createPropertyText(Property property,
                                                              boolean showName,
                                                              boolean showType,
                                                              boolean showVisibility,
                                                              boolean showFullType,
                                                              boolean showInitValue,
                                                              boolean showStereotype,
                                                              boolean showProperties,
                                                              boolean showConstraints,
                                                              boolean showMultiplicity,
                                                              boolean addColorInformation)

Deprecated. Use createPropertyText(PropertyTextParameter).

Constructs attribute view text.

Parameters:

property - attribute which text will be created.

showName - show name

showType - show type

showVisibility - flag indicates if method visibility should be shown.

showFullType - True for show full type.

showInitValue - indicates if initial value of attribute will be shown. @return attribute view text string.

showStereotype - show stereotype

showProperties - show properties

showConstraints - show constraints

showMultiplicity - show multiplicity

addColorInformation - add color

Returns:

property text

createPropertyText

@Deprecated
public static java.lang.String createPropertyText(Property property,
                                                              boolean showName,
                                                              boolean showType,
                                                              boolean showVisibility,
                                                              boolean showFullType,
                                                              boolean showInitValue,
                                                              boolean showStereotype,
                                                              boolean showProperties,
                                                              boolean showTypeTaggedValues,
                                                              boolean showConstraintName,
                                                              boolean showConstraintExpression,
                                                              boolean showMultiplicity,
                                                              boolean addColorInformation)

Deprecated. Use createPropertyText(PropertyTextParameter).

Constructs attribute view text.

Parameters:

property - attribute which text will be created.

showName - show name

showType - show type

showVisibility - flag indicates if method visibility should be shown.

showFullType - True for show full type.

showInitValue - indicates if initial value of attribute will be shown. @return attribute view text string.

showStereotype - show stereotypes

showProperties - show properties

showTypeTaggedValues - show tagged values

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

showMultiplicity - show multiplicity

addColorInformation - add color

Returns:

text

createPropertyText

@Deprecated
public static java.lang.String createPropertyText(Property property,
                                                              boolean showName,
                                                              boolean showType,
                                                              boolean showDerived,
                                                              boolean showVisibility,
                                                              boolean showFullType,
                                                              boolean showInitValue,
                                                              boolean showStereotype,
                                                              boolean showProperties,
                                                              boolean showTypeTaggedValues,
                                                              boolean showConstraintName,
                                                              boolean showConstraintExpression,
                                                              boolean showMultiplicity,
                                                              boolean addColorInformation)

Deprecated. Use createPropertyText(PropertyTextParameter).

Constructs attribute view text.

Parameters:

property - attribute which text will be created.

showName - show name

showType - show type

showDerived - show derived sign

showVisibility - flag indicates if method visibility should be shown.

showFullType - True for show full type.

showInitValue - indicates if initial value of attribute will be shown. @return attribute view text string.

showStereotype - show stereotypes

showProperties - show properties

showTypeTaggedValues - show tagged values

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

showMultiplicity - show multiplicity

addColorInformation - add color

Returns:

text

createPropertyText

@Deprecated
public static java.lang.String createPropertyText(Property property,
                                                              boolean showName,
                                                              boolean showType,
                                                              boolean showDerived,
                                                              boolean showVisibility,
                                                              boolean showFullType,
                                                              boolean showInitValue,
                                                              boolean showStereotype,
                                                              boolean showProperties,
                                                              boolean showTypeTaggedValues,
                                                              boolean showConstraintName,
                                                              boolean showConstraintExpression,
                                                              boolean showMultiplicity,
                                                              boolean showInheritedSign,
                                                              boolean addColorInformation)

Deprecated. Use createPropertyText(PropertyTextParameter).

Constructs attribute view text.

Parameters:

property - attribute which text will be created.

showName - show name

showType - show type

showDerived - show derived sign

showVisibility - flag indicates if method visibility should be shown.

showFullType - True for show full type.

showInitValue - indicates if initial value of attribute will be shown. @return attribute view text string.

showStereotype - show stereotypes

showProperties - show properties

showTypeTaggedValues - show tagged values

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

showMultiplicity - show multiplicity

showInheritedSign - show inherited sign

addColorInformation - add color

Returns:

text

createPropertyText

@Deprecated
public static java.lang.String createPropertyText(Property property,
                                                              boolean showName,
                                                              boolean showType,
                                                              boolean showDerived,
                                                              boolean showVisibility,
                                                              boolean showFullType,
                                                              boolean showInitValue,
                                                              boolean showStereotype,
                                                              boolean showProperties,
                                                              boolean showTaggedValues,
                                                              boolean showTypeTaggedValues,
                                                              boolean showConstraintName,
                                                              boolean showConstraintExpression,
                                                              boolean showMultiplicity,
                                                              boolean showInheritedSign,
                                                              boolean addColorInformation)

Deprecated. Use createPropertyText(PropertyTextParameter).

Constructs attribute view text.

Parameters:

property - attribute which text will be created.

showName - show name

showType - show type

showDerived - show derived sign

showVisibility - flag indicates if method visibility should be shown.

showFullType - True for show full type.

showInitValue - indicates if initial value of attribute will be shown. @return attribute view text string.

showStereotype - show stereotypes

showProperties - show properties

showTypeTaggedValues - show tagged values

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

showMultiplicity - show multiplicity

showInheritedSign - show inherited sign

addColorInformation - add color

Returns:

text

createPropertyText

public static java.lang.String createPropertyText(PropertyTextParameter propertyTextParameter)

Constructs attribute view text.

Parameters:

propertyTextParameter - property text parameter object

Returns:

text

createPropertyPropertyStringText

public static void createPropertyPropertyStringText(Property property,
                                                    java.lang.StringBuffer text)

createPropertyPropertyStringText

public static void createPropertyPropertyStringText(Property property,
                                                    java.lang.StringBuffer text,
                                                    java.lang.String separator)

createOperationText

public static java.lang.String createOperationText(Operation operation,
                                                   boolean showSignature,
                                                   boolean showVisibility,
                                                   boolean showFullType,
                                                   boolean showStereotype,
                                                   boolean showProperties,
                                                   boolean showConstraintName,
                                                   boolean showConstraintExpression,
                                                   boolean showParameterDirection,
                                                   boolean addColorInformation,
                                                   boolean showTemplateParameters)

Constructs representation operation text.

Parameters:

operation - operation which text will be created.

showSignature - flag indicates if method parameters should be shown.

showVisibility - flag indicates if method visibility should be shown.

showFullType - True for show full type.

showStereotype - show stereotype

showProperties - show properties

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

showParameterDirection - show parameter direction

addColorInformation - add color

showTemplateParameters - @return method text string.

Returns:

operation text

createOperationText

public static java.lang.String createOperationText(Operation operation,
                                                   boolean showSignature,
                                                   boolean showVisibility,
                                                   boolean showFullType,
                                                   boolean showStereotype,
                                                   boolean showProperties,
                                                   boolean showConstraintName,
                                                   boolean showConstraintExpression,
                                                   boolean showParameterDirection,
                                                   boolean addColorInformation,
                                                   boolean showTemplateParameters,
                                                   boolean showParameterDefaultValue)

Constructs representation operation text.

Parameters:

operation - operation which text will be created.

showSignature - flag indicates if method parameters should be shown.

showVisibility - flag indicates if method visibility should be shown.

showFullType - True for show full type.

showStereotype - show stereotype

showProperties - show properties

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

showParameterDirection - show parameter direction kind

addColorInformation - add color

showTemplateParameters - indicates if template parameters should be shown.

showParameterDefaultValue - indicates if parameter default values should be shown.

Returns:

method text string.

createOperationText

@Deprecated
public static java.lang.String createOperationText(Operation operation,
                                                               boolean showSignature,
                                                               boolean showVisibility,
                                                               boolean showFullType,
                                                               boolean showStereotype,
                                                               boolean showProperties,
                                                               boolean showConstraintName,
                                                               boolean showConstraintExpression,
                                                               boolean showParameterDirection,
                                                               boolean addColorInformation,
                                                               boolean showTemplateParameters,
                                                               boolean showParameterDefaultValue,
                                                               boolean showInheritedSign)

Deprecated. use any one of the other createOperationText methods.

Constructs representation operation text.

Parameters:

operation - operation which text will be created.

showSignature - flag indicates if method parameters should be shown.

showVisibility - flag indicates if method visibility should be shown.

showFullType - True for show full type.

showStereotype - show stereotype

showProperties - show properties

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

showParameterDirection - show parameter direction kind

addColorInformation - add color

showTemplateParameters - indicates if template parameters should be shown.

showParameterDefaultValue - indicates if parameter default values should be shown.

showInheritedSign - show inherited sign

Returns:

method text string.

createOperationText

public static java.lang.String createOperationText(Operation operation,
                                                   boolean showSignature,
                                                   boolean showVisibility,
                                                   boolean showFullType,
                                                   boolean showStereotype,
                                                   boolean showProperties,
                                                   boolean showTaggedValues,
                                                   boolean showConstraintName,
                                                   boolean showConstraintExpression,
                                                   boolean showParameterDirection,
                                                   boolean addColorInformation,
                                                   boolean showTemplateParameters,
                                                   boolean showParameterDefaultValue,
                                                   boolean showInheritedSign)

Constructs representation operation text.

Parameters:

operation - operation which text will be created.

showSignature - flag indicates if method parameters should be shown.

showVisibility - flag indicates if method visibility should be shown.

showFullType - True for show full type.

showStereotype - show stereotype

showProperties - show properties

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

showParameterDirection - show parameter direction kind

addColorInformation - add color

showTemplateParameters - indicates if template parameters should be shown.

showParameterDefaultValue - indicates if parameter default values should be shown.

showInheritedSign - show inherited sign

Returns:

method text string.

createParametersText

public static java.lang.String createParametersText(java.util.Collection parameters,
                                                    boolean showSignature,
                                                    boolean showFullType,
                                                    boolean showParameterDirection,
                                                    boolean addColorInformation)

Create parameter text.

Parameters:

parameters - The given parameter.

showSignature - Is show signature?

showFullType - True for show full type.

showParameterDirection - Is show parameter direction?

addColorInformation - True for set color.

Returns:

Parameter text.

createParametersText

public static java.lang.String createParametersText(java.util.Collection parameters,
                                                    boolean showSignature,
                                                    boolean showFullType,
                                                    boolean showParameterDirection,
                                                    boolean addColorInformation,
                                                    boolean showParameterDefaultValue)

Create parameter text.

Parameters:

parameters - The given parameter.

showSignature - Is show signature?

showFullType - True for show full type.

showParameterDirection - Is show parameter direction?

addColorInformation - True for set color.

showParameterDefaultValue - indicates if default value should be shown for parameters.

Returns:

Parameter text.

createParameterText

public static java.lang.String createParameterText(Parameter parameter,
                                                   boolean showFullType,
                                                   boolean showParameterDirection,
                                                   boolean addColorInformation,
                                                   boolean showDefaultValue)

Creates text which represents parameter. for example "param : java::lang::String"

Parameters:

parameter - parameter which text will be created.

showFullType - True for show full type.

showParameterDirection - indicates if parameter direction should be shown.

addColorInformation - indicates if color information should be added to the parameter text.

showDefaultValue - indicates if default value should be displayed for parameter.

Returns:

Created text

createParameterText

public static java.lang.String createParameterText(Parameter parameter,
                                                   boolean showFullType,
                                                   boolean showParameterDirection,
                                                   boolean addColorInformation,
                                                   boolean showDefaultValue,
                                                   boolean skipDefaultDirection,
                                                   boolean showReturnDirection)

Creates text which represents parameter. for example "param : java::lang::String"

Parameters:

parameter - parameter which text will be created.

showFullType - True for show full type.

showParameterDirection - indicates if parameter direction should be shown.

addColorInformation - indicates if color information should be added to the parameter text.

showDefaultValue - indicates if default value should be displayed for parameter.

skipDefaultDirection - indicates if direction should be skipped if it is the same as default Parameter direction in project options

showReturnDirection - indicates if return direction kind should be shown

Returns:

Created text

createParameterDirectionText

public static java.lang.String createParameterDirectionText(Project project,
                                                            java.lang.Class<? extends Parameter> parameterMetaType,
                                                            @CheckForNull
                                                            ParameterDirectionKind parameterDirection,
                                                            boolean skipDefaultValue,
                                                            boolean showReturnDirection,
                                                            boolean addColorInformation)

Creates a text for parameter direction

Parameters:

project - project

parameterMetaType - parameter metatype

parameterDirection - parameter direction

skipDefaultValue - skip direction text if direction is the same as default for Parameter

showReturnDirection - show return direction text

addColorInformation - use colors in text

Returns:

parameter direction text

createParameterText

public static java.lang.String createParameterText(Parameter parameter,
                                                   boolean showFullType,
                                                   boolean showParameterDirection,
                                                   boolean addColorInformation)

Creates text which represents parameter. for example "param : java::lang::String"

Parameters:

parameter - parameter which text will be created.

showFullType - True for show full type.

showParameterDirection - show parameter direction

addColorInformation - add color

Returns:

Created text

createActivityParameterNodeText

public static java.lang.String createActivityParameterNodeText(ActivityParameterNode parameter,
                                                               boolean showFullType,
                                                               boolean addColorInformation)

Creates text which represents activity parameter node. for example "param : java::lang::String"

Parameters:

parameter - parameter which text will be created.

showFullType - True for show full type.

addColorInformation - indicates if color information should be added to the parameter text.

Returns:

Created text

createClassifiersRepresentation

public static java.lang.String createClassifiersRepresentation(java.util.Collection classifiers,
                                                               boolean showFullType,
                                                               boolean addColorInformation)

Returns representation of given classifiers collection

Parameters:

classifiers - Class

showFullType - True for show full type.

addColorInformation - True for set color.

Returns:

text

createClassifierName

public static java.lang.String createClassifierName(Classifier cl,
                                                    boolean showFullType,
                                                    boolean addColorInformation)

Creates string: classifier name. If is used showFullType namespace is added to name.

Parameters:

cl - Given class

showFullType - True for show full type.

addColorInformation - True for set color.

Returns:

String.

createVisibilityText

public static char createVisibilityText(@CheckForNull
                                        VisibilityKind visibility)

Returns visibility representation(+, # or -)

Parameters:

visibility - the given visibility.

Returns:

the char representation of given visibility.

createSlotText

public static java.lang.String createSlotText(@Nonnull
                                              Slot slot,
                                              boolean showName,
                                              boolean ignoreTrueValues,
                                              boolean showHTML,
                                              boolean showFeatureType,
                                              boolean showFullType,
                                              boolean addColorInformation,
                                              boolean showEmptyValue,
                                              boolean showQualifiedName)

Returns string representation of given tag definition.

Parameters:

slot - The given slot.

showName - Is show name?

ignoreTrueValues - Is ignore true values?

showHTML - True for show htm

showFeatureType - Is show feature type?

showFullType - True for show full type.

addColorInformation - True for set color.

showEmptyValue - show empty value

showQualifiedName - show qualified name

Returns:

The created string.

createSlotText

public static java.lang.String createSlotText(@Nonnull
                                              Slot slot,
                                              boolean showName,
                                              boolean ignoreTrueValues,
                                              boolean showHTML,
                                              boolean showFeatureType,
                                              boolean showFullType,
                                              boolean showFeatureTypeTaggedValues,
                                              boolean addColorInformation,
                                              boolean showEmptyValue,
                                              boolean showQualifiedName)

Returns string representation of given tag definition.

Parameters:

slot - The given slot.

showName - Is show name?

ignoreTrueValues - Is ignore true values?

showHTML - True for show htm

showFeatureType - Is show feature type?

showFullType - True for show full type.

showFeatureTypeTaggedValues - show feature type tagged values

addColorInformation - True for set color.

showEmptyValue - show empty value

showQualifiedName - show qualified name

Returns:

The created string.

createSlotText

public static java.lang.String createSlotText(@Nonnull
                                              Slot slot,
                                              boolean showName,
                                              boolean ignoreTrueValues,
                                              boolean showHTML,
                                              boolean showFeatureType,
                                              boolean showFullType,
                                              boolean showFeatureTypeTaggedValues,
                                              boolean addColorInformation,
                                              boolean showEmptyValue,
                                              boolean showQualifiedName,
                                              boolean showDerived)

Returns string representation of given tag definition.

Parameters:

slot - The given slot.

showName - Is show name?

ignoreTrueValues - Is ignore true values?

showHTML - True for show htm

showFeatureType - Is show feature type?

showFullType - True for show full type.

showFeatureTypeTaggedValues - show feature type tagged values

addColorInformation - True for set color.

showEmptyValue - show empty value

showQualifiedName - show qualified name

showDerived - if true returned string will be calculated as derived if possible

Returns:

The created string.

createSlotText

public static java.lang.String createSlotText(@Nonnull
                                              Slot slot,
                                              boolean showName,
                                              boolean ignoreTrueValues,
                                              boolean showHTML,
                                              boolean showFeatureType,
                                              boolean showFullType,
                                              boolean showFeatureTypeTaggedValues,
                                              boolean addColorInformation,
                                              boolean showEmptyValue,
                                              boolean showQualifiedName,
                                              boolean showDerived,
                                              boolean forEditing,
                                              boolean colorUnitSymbols,
                                              boolean colorTag)

Returns string representation of given tag definition.

Parameters:

slot - The given slot.

showName - Is show name?

ignoreTrueValues - Is ignore true values?

showHTML - True for show htm

showFeatureType - Is show feature type?

showFullType - True for show full type.

showFeatureTypeTaggedValues - show feature type tagged values

addColorInformation - True for set color.

showEmptyValue - show empty value

showQualifiedName - show qualified name

showDerived - if true returned string will be calculated as derived if possible

forEditing - flag to indicate that we need text for editiong, so no additional text providers will be used

colorUnitSymbols - flag to indicate if we need to use color for additional text providers, we can't use addColorInformation, as we use same provider for instances that don't have color information property

colorTag - indicates if we need color tag or font color tag if we use in additional text providers

Returns:

The created string.

addSpaceAfterUnitBeforeNextValue

public static void addSpaceAfterUnitBeforeNextValue(java.util.List<ValueSpecification> valueSpecifications,
                                                    java.lang.StringBuilder stringBuilder)

Unit symbol is separated from other values if needed by space

Parameters:

valueSpecifications - value specifications to check unit symbol for

stringBuilder - text string builder

removeQuotationMarksFromSlotText

public static java.lang.String removeQuotationMarksFromSlotText(java.lang.String slotText)

Removes quotation marks from given slot representation.

Parameters:

slotText - slot text

Returns:

the same text without quotation marks

createPureSlotsString

@CheckForNull
public static java.lang.String createPureSlotsString(java.util.Collection<Slot> cs,
                                                                   java.lang.String separator,
                                                                   boolean showHTML,
                                                                   boolean showEmptyValue)

Returns string representation of given slots collection. The string representation will no have { and }.

Parameters:

cs - Slot collection.

separator - The separator string?

showHTML - TRUE for show html format.

showEmptyValue - show empty value

Returns:

The created string.

createSlotsText

public static java.lang.String createSlotsText(java.util.Collection<Slot> cs,
                                               java.lang.String separator,
                                               boolean showHTML,
                                               boolean showEmptyValue)

Returns string representation of given slots collection. The string representation will have { and }.

createConstraintsText

@CheckForNull
public static java.lang.String createConstraintsText(@CheckForNull
                                                                   java.util.Collection<Constraint> constraints,
                                                                   java.lang.String separator,
                                                                   boolean useName,
                                                                   boolean useExpression,
                                                                   boolean addBrackets)

Build a representation string from given collection of constraints. The representation string will have constraints names, not expressions. The Left and Right brackets will not be added into the string.

Parameters:

constraints - a collection of Constraints.

separator - separator string of every single constraint text(new line, comma)

useName - put constraint name into text

useExpression - put constraint condition expression into text

addBrackets - put all text into brackets

Returns:

representation string of given constraints.

createConstraintsText

public static java.lang.String createConstraintsText(ValueSpecification valueSpecification,
                                                     boolean addBrackets)

Add constraint text.

Parameters:

valueSpecification - Constraint value specification.

addBrackets - True for add brackets to string.

Returns:

Constraints text.

constructActivityEdgeText

public static java.lang.String constructActivityEdgeText(ActivityEdge activityEdge,
                                                         boolean showWeight)

Construct activity edge text

Parameters:

activityEdge - edge

showWeight - show weight information

Returns:

text

createConstraintsText

public static java.lang.String createConstraintsText(Constraint constraint,
                                                     boolean useName,
                                                     boolean useExpression,
                                                     boolean addBrackets)

Create constraint text.

Parameters:

constraint - The given constraint.

useName - put name into representation text

useExpression - put Expression into representation text.

addBrackets - True for add brackets to string.

Returns:

Constraint text.

createGuardText

public static java.lang.String createGuardText(Message msg)

Creates Message guard text.

Parameters:

msg - message

Returns:

text

createOperandGuardText

public static java.lang.String createOperandGuardText(InteractionOperand operand)

createValueSpecificationText

public static java.lang.String createValueSpecificationText(@CheckForNull
                                                            ValueSpecification specification)

Create ValueSpecification text.

Parameters:

specification - The given Value Specification.

Returns:

The created string.

createTypeName

public static java.lang.String createTypeName(Type cl,
                                              boolean showFullType,
                                              boolean addColorInformation)

Creates string: classifier name. If is used showFullType namespace is added to name.

Parameters:

cl - Type.

showFullType - True for show full type.

addColorInformation - True for set color.

Returns:

The created string.

getFullUMLName

@OpenApi
public static java.lang.String getFullUMLName(Element element)

Method returns full UML name for object. Path separator is used form ApplicationConstants.PACKAGE_SEPARATOR

Parameters:

element - element

Returns:

full element name with path to root.

getFullUMLName

public static java.lang.String getFullUMLName(Element element,
                                              boolean doNotAddTopLevels)

Get Full UML Name.

Parameters:

element - The given NameElement.

doNotAddTopLevels - do not add to top level

Returns:

Full UML Name.

getAbsoluteUMLPathToRoot

public static java.lang.String getAbsoluteUMLPathToRoot(Element element)

Method returns string representing path from root package to this object data. Path separator is used form ApplicationConstants.PACKAGE_SEPARATOR

Parameters:

element - element

Returns:

path to root package string.

createTransitionText

public static java.lang.String createTransitionText(Transition transition,
                                                    boolean showEffect)

createTransitionText

public static java.lang.String createTransitionText(Transition transition,
                                                    boolean showEffect,
                                                    boolean showPort,
                                                    boolean showOpaqueBehaviorBody)

createTransitionText

public static java.lang.String createTransitionText(Transition transition,
                                                    boolean showEffect,
                                                    boolean showPort,
                                                    boolean showOpaqueBehaviorBody,
                                                    boolean showOperationsSignature,
                                                    boolean useAdvancedColoring)

Constructs text representation of given transition object. Keep in mind that text is different for protocol transition. Syntax of transition - trigger[guard]/effect Syntax of protocol transition - [precondition]trigger/[postcondition]

Parameters:

transition - the given transition.

showEffect - show effect or not

showPort - controls display of port.

showOpaqueBehaviorBody - indicates if opaque behavior body should be displayed.

showOperationsSignature - show operation signature or not

useAdvancedColoring - use advanced coloring for operations or not

Returns:

created string.

See Also:

createProtocolTransitionText(com.nomagic.uml2.ext.magicdraw.statemachines.mdprotocolstatemachines.ProtocolTransition)

createProtocolTransitionText

public static java.lang.String createProtocolTransitionText(ProtocolTransition transition)

createProtocolTransitionText

public static java.lang.String createProtocolTransitionText(ProtocolTransition transition,
                                                            boolean showPort)

createProtocolTransitionText

public static java.lang.String createProtocolTransitionText(ProtocolTransition transition,
                                                            boolean showPort,
                                                            boolean showOperationsSignature,
                                                            boolean useAdvancedColoring)

Constructs text representation of given protocol. Syntax of protocol transition - [precondition]trigger/[postcondition]

Parameters:

transition - the given transition.

showOperationsSignature - show operation signature or not

useAdvancedColoring - use advanced coloring for operations or not

Returns:

The created string.

createTriggersText

public static java.lang.String createTriggersText(java.util.Collection triggers)

createTriggersText

public static java.lang.String createTriggersText(java.util.Collection triggers,
                                                  boolean showPort)

Create Triggers text.

Parameters:

triggers - The given triggers.

showPort - controls display of port.

Returns:

The created text.

createTriggersText

public static java.lang.String createTriggersText(java.util.Collection triggers,
                                                  boolean showPort,
                                                  boolean showOperationsSignature,
                                                  boolean useAdvancedColoring)

Create Triggers text.

Parameters:

triggers - The given triggers.

showPort - controls display of port.

showOperationsSignature - show operation signature or not

useAdvancedColoring - use advanced coloring for operations or not

Returns:

The created text.

createTriggerText

public static java.lang.String createTriggerText(Trigger trigger)

createTriggerText

public static java.lang.String createTriggerText(Trigger trigger,
                                                 boolean showPort)

createTriggerText

public static java.lang.String createTriggerText(Trigger trigger,
                                                 boolean showPort,
                                                 boolean showOperationsSignature,
                                                 boolean useAdvancedColoring)

createEventText

public static java.lang.String createEventText(Event event)

Creates textual representation of event.

Parameters:

event - The given event.

Returns:

Event text.

createEventText

public static java.lang.String createEventText(Event event,
                                               boolean showOperationsSignature,
                                               boolean useAdvancedColoring)

createAssociationText

public static java.lang.String createAssociationText(Association association)

Create Association text.

Parameters:

association - Text owner.

Returns:

The created string.

createInstanceSpecificationText

public static java.lang.String createInstanceSpecificationText(InstanceSpecification instance,
                                                               boolean showClassifier,
                                                               boolean showFullType,
                                                               boolean addColorInformation)

Create representation text for instance

Parameters:

instance - instance specification

showClassifier - show classifier

showFullType - show full type of classifier

addColorInformation - add color

Returns:

text

createInstanceSpecificationText

public static java.lang.String createInstanceSpecificationText(InstanceSpecification instance,
                                                               boolean showClassifier,
                                                               boolean showFullType,
                                                               boolean addColorInformation,
                                                               boolean showAutoID)

createMultiplicityText

@OpenApi
public static java.lang.String createMultiplicityText(java.lang.String lower,
                                                               java.lang.String upper,
                                                               boolean ordered,
                                                               boolean unique,
                                                               boolean addBrackets)

Returns text representation of given multiplicity.

Parameters:

lower - Lower value

upper - Upper value

ordered - ordered

unique - unique

addBrackets - add brackets

Returns:

text representation or empty string if multiplicity is null.

createMultiplicityText

@OpenApi
public static java.lang.String createMultiplicityText(MultiplicityElement multiplicity,
                                                               boolean showOrder,
                                                               boolean showUnique,
                                                               boolean addBrackets)

Returns text representation of given multiplicity.

Parameters:

multiplicity - the given multiplicity.

showOrder - show order

showUnique - show unique label

addBrackets - add brackets

Returns:

text representation or empty string if multiplicity is null.

createMultiplicityText

public static java.lang.String createMultiplicityText(java.lang.String lower,
                                                      java.lang.String upper,
                                                      @CheckForNull
                                                      ValueSpecification lowerValue,
                                                      boolean unique,
                                                      boolean ordered,
                                                      boolean addBrackets)

getPathToRoot

public static java.lang.String getPathToRoot(Element element)

Get Path of given element to root of element.

Parameters:

element - The given element.

Returns:

The string path element.

getPathToRoot

public static java.lang.String getPathToRoot(Element element,
                                             boolean checkTop)

Get path to root.

Parameters:

element - The given element.

checkTop - True for check the root.

Returns:

string

getPathToRoot

public static java.lang.String getPathToRoot(Element data,
                                             boolean relativeToLibrary,
                                             boolean compactMode)

Calculates qualified name to display in the shape header. It can generate string using standard UML notation (using double colon for separator) or in the old MagicDraw style (surrounded with brackets). For more options see getPathToRoot(Element, boolean, boolean, boolean)

Parameters:

data - model element used to calculate qualified name

relativeToLibrary - if true, then qualified name is calculated from "model library" element, otherwise qualified name is calculated from root.

compactMode - if true, then old MagicDraw notation is used, otherwise uses standard UML notation

Returns:

string containing "name space" qualified name part.

getPathToRoot

public static java.lang.String getPathToRoot(Element data,
                                             boolean relativeToLibrary,
                                             boolean relativeToModel,
                                             boolean compactMode)

Calculates qualified name to display in the shape header. It can generate string using standard UML notation (using double colon for separator) or in the old MagicDraw style (surrounded with brackets).

Parameters:

data - model element used to calculate qualified name

relativeToLibrary - if true, then qualified name is calculated from "model library" element, otherwise qualified name is calculated from root.

relativeToModel - if true, then qualified name is calculated from nearest "model" element, otherwise qualified name is calculated from root.

compactMode - - if true, then old MagicDraw notation is used, otherwise uses standard UML notation

Returns:

string containing "name space" qualified name part.

getPathToRoot

public static java.lang.String getPathToRoot(Element element,
                                             boolean checkTop,
                                             java.lang.String separator)

Get path to root. For More options see getPathToRoot(Element, boolean, boolean, String)

Parameters:

element - The given element.

checkTop - True for check the root.

separator - separator to use to create a path

Returns:

string

getPathToRoot

public static java.lang.String getPathToRoot(Element element,
                                             boolean toModelLibrary,
                                             boolean toModel,
                                             java.lang.String separator)

Get path to root.

Parameters:

element - The given element.

toModelLibrary - if true, stops at model library.

toModel - if true, stops at mode element.

separator - separator to use to create a path

Returns:

string

createEnumerationLiteralText

@Deprecated
public static java.lang.String createEnumerationLiteralText(EnumerationLiteral enumLiteral,
                                                                        boolean showStereotype,
                                                                        boolean showProperties,
                                                                        boolean showConstraintName,
                                                                        boolean showConstraintExpression)

Deprecated. use createEnumerationLiteralText(EnumerationLiteral, boolean, boolean, boolean, boolean, boolean, boolean)

Constructs enumeration literal text.

Parameters:

enumLiteral - The given EnumerationLiteral.

showStereotype - True, for show stereotype.

showProperties - True, for show Properties.

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

Returns:

text

createEnumerationLiteralText

@Deprecated
public static java.lang.String createEnumerationLiteralText(EnumerationLiteral enumLiteral,
                                                                        boolean showStereotype,
                                                                        boolean showProperties,
                                                                        boolean showConstraintName,
                                                                        boolean showConstraintExpression,
                                                                        boolean showInheritedSign)

Deprecated. use createEnumerationLiteralText(EnumerationLiteral, boolean, boolean, boolean, boolean, boolean, boolean, boolean)

Constructs enumeration literal text.

Parameters:

enumLiteral - The given EnumerationLiteral.

showStereotype - True, for show stereotype.

showProperties - True, for show Properties.

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

showInheritedSign - show inherited sign

Returns:

text

createEnumerationLiteralText

public static java.lang.String createEnumerationLiteralText(EnumerationLiteral enumLiteral,
                                                            boolean showStereotype,
                                                            boolean showProperties,
                                                            boolean showTaggedValues,
                                                            boolean showConstraintName,
                                                            boolean showConstraintExpression,
                                                            boolean showInheritedSign)

createEnumerationLiteralText

public static java.lang.String createEnumerationLiteralText(EnumerationLiteral enumLiteral,
                                                            boolean showStereotype,
                                                            boolean showProperties,
                                                            boolean showTaggedValues,
                                                            boolean showConstraintName,
                                                            boolean showConstraintExpression,
                                                            boolean showInheritedSign,
                                                            boolean addColorInformation)

Constructs enumeration literal text.

Parameters:

enumLiteral - The given EnumerationLiteral.

showStereotype - True, for show stereotype.

showProperties - True, for show Properties.

showTaggedValues - True, for show tagged values.

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

showInheritedSign - show inherited sign

Returns:

text

createTemplateBindingText

public static java.lang.String createTemplateBindingText(TemplateBinding binding)

Constructs given binding element text.

Parameters:

binding - The given binding.

Returns:

The created string.

createTemplateBindingText

public static java.lang.String createTemplateBindingText(TemplateBinding binding,
                                                         boolean attachTemplateParameterInfo)

Constructs given binding element text.

Parameters:

binding - The given binding.

attachTemplateParameterInfo - indicates if full template parameter notation should be used.

Returns:

The created string.

createTemplateParameterSubstitutionText

public static java.lang.String createTemplateParameterSubstitutionText(TemplateParameterSubstitution parameterSubstitution,
                                                                       boolean attachTemplateParameterInfo)

Create TemplateParameterSubstitution Text.

Parameters:

parameterSubstitution - The given ParameterSubstitution.

attachTemplateParameterInfo - indicates if full template parameter notation should be used.

Returns:

The created text.

createTemplateParametersText

public static java.lang.String createTemplateParametersText(java.util.Collection templateParameters,
                                                            java.lang.String separator)

Create the Template Parameters Text.

Parameters:

templateParameters - The given TemplateParameters.

separator - The text separator

Returns:

The created string.

createTemplateParameterText

public static java.lang.String createTemplateParameterText(TemplateParameter tParameter)

Creates TemplateParameter text.

Parameters:

tParameter - The given TemplateParameter

Returns:

The create string.

getTemplateParameterTypeAsString

public static java.lang.String getTemplateParameterTypeAsString(TemplateParameter tParameter)

Get String representation of given TemplateParameter Type.

Parameters:

tParameter - The given template parameter.

Returns:

String representation.

createStereotypesText

public static java.lang.String createStereotypesText(Element element,
                                                     char separator)

Create the representation text of element be assigned stereotype.

Parameters:

element - The given element.

separator - The separator string.

Returns:

The string representation.

createStereotypesText

public static java.lang.String createStereotypesText(Element element,
                                                     char separator,
                                                     boolean skipDSL,
                                                     boolean useAlias)

Create the representation text of element be assigned stereotype.

Parameters:

element - The given element.

separator - The separator string.

skipDSL - skip DSL stereotypes or nor

useAlias - use DSL alias instead of name

Returns:

The string representation.

getFullName

public static boolean getFullName(Element element,
                                  java.lang.StringBuffer path,
                                  java.lang.String separator,
                                  boolean checkTopStereotype)

Get NameElement full name. For more options see getFullName(Element, StringBuffer, String, boolean, boolean).

Parameters:

element - The NameElement.

path - Path of NameElement.

separator - The separator.

checkTopStereotype - Is check to stereotype?

Returns:

true if element is NamedElement, otherwise false.

getFullName

public static boolean getFullName(Element element,
                                  java.lang.StringBuffer path,
                                  java.lang.String separator,
                                  boolean checkTopStereotype,
                                  boolean checkTopModelElement)

Get NameElement full name.

Parameters:

element - The NameElement.

path - Path of NameElement.

separator - The separator.

checkTopStereotype - Is check to stereotype?

checkTopModelElement - indicates Model model element check

Returns:

true if element is NamedElement, otherwise false.

createStereotypesText

public static java.lang.String createStereotypesText(java.util.Collection<Stereotype> stereotypes,
                                                     char separator)

Returns string representation of given.

Parameters:

stereotypes - the collection of stereotypes.

separator - the separator of stereotypes

Returns:

The created string.

createStereotypesText

public static java.lang.String createStereotypesText(java.util.Collection<Stereotype> stereotypes,
                                                     char separator,
                                                     boolean skipDSL,
                                                     boolean useAlias)

Returns string representation of given.

Parameters:

stereotypes - the collection of stereotypes.

separator - the separator of stereotypes

skipDSL - skip DSL stereotypes or nor

useAlias - use DSL alias instead of name

Returns:

The created string.

createStereotypeText

public static java.lang.String createStereotypeText(Stereotype stereotype)

createStereotypeText

public static java.lang.String createStereotypeText(Stereotype stereotype,
                                                    boolean useAlias)

createStereotypeText

public static java.lang.String createStereotypeText(@CheckForNull
                                                    java.lang.String stereotypeName)

createInteractionUseText

public static java.lang.String createInteractionUseText(InteractionUse interactionUse,
                                                        boolean addReferTo,
                                                        boolean addArguments)

Create InteractionUse text.

Parameters:

interactionUse - The given InteractionUse.

addReferTo - Is add refer to text?

addArguments - Is add Arguments?

Returns:

InteractionUse text.

createInteractionUseText

public static java.lang.String createInteractionUseText(CallBehaviorAction interactionUse)

Create InteractionUse text from representative CallBehaviorAction.

Parameters:

interactionUse - The given InteractionUse.

Returns:

InteractionUse text.

createPortText

public static java.lang.String createPortText(Port port,
                                              boolean showName,
                                              boolean showType,
                                              boolean showMultiplicity,
                                              boolean showFullType,
                                              boolean addColor)

createPortText

public static java.lang.String createPortText(Port port,
                                              boolean showName,
                                              boolean showType,
                                              boolean showMultiplicity,
                                              boolean showFullType,
                                              boolean showTaggedValues,
                                              boolean showInheritedSign,
                                              boolean addColor)

createPortText

public static java.lang.String createPortText(Port port,
                                              boolean showName,
                                              boolean showType,
                                              boolean showMultiplicity,
                                              boolean showFullType,
                                              boolean showInheritedSign,
                                              boolean addColor)

createBehaviorText

public static java.lang.String createBehaviorText(Behavior behavior)

Creates behavior text.

Parameters:

behavior - behavior to represent.

Returns:

behavior text.

createBehaviorText

public static java.lang.String createBehaviorText(Behavior behavior,
                                                  boolean showStereotype,
                                                  boolean showProperties,
                                                  boolean showInheritedSign,
                                                  boolean showSignature,
                                                  boolean showFullType,
                                                  boolean showConstraintName,
                                                  boolean showConstraintExpression,
                                                  boolean addColorInformation,
                                                  boolean showParameterDirectionKind)

createBehaviorText

@Deprecated
public static java.lang.String createBehaviorText(Behavior behavior,
                                                              boolean showStereotype,
                                                              boolean showProperties,
                                                              boolean showInheritedSign,
                                                              boolean showSignature,
                                                              boolean showFullType,
                                                              boolean showConstraintName,
                                                              boolean showConstraintExpression,
                                                              boolean addColorInformation,
                                                              boolean showParameterDirectionKind,
                                                              boolean showOpaqueBehaviorBody)

Deprecated.

Creates behavior text.

Parameters:

behavior - behavior to represent.

showStereotype - indicates if stereotypes should be displayed.

showProperties - indicates if properties and tagged values should be displayed.

showInheritedSign - indicates if inherited sign should be displayed.

showSignature - indicates if behavior signature should be displayed.

showFullType - indicates if full qualified type name should be displayed.

showConstraintName - indicates if constraint name should be displayed.

showConstraintExpression - indicates if constraint expression should be displayed.

addColorInformation - indicates if color information should be added to the representation text.

showParameterDirectionKind - indicates if parameter direction kind should be displayed.

showOpaqueBehaviorBody - indicates if opaque behavior body should be displayed

Returns:

behavior text.

createBehaviorText

public static java.lang.String createBehaviorText(Behavior behavior,
                                                  boolean showStereotype,
                                                  boolean showProperties,
                                                  boolean showTaggedValues,
                                                  boolean showInheritedSign,
                                                  boolean showSignature,
                                                  boolean showFullType,
                                                  boolean showConstraintName,
                                                  boolean showConstraintExpression,
                                                  boolean addColorInformation,
                                                  boolean showParameterDirectionKind,
                                                  boolean showOpaqueBehaviorBody)

Creates behavior text.

Parameters:

behavior - behavior to represent.

showStereotype - indicates if stereotypes should be displayed.

showProperties - indicates if properties and tagged values should be displayed.

showInheritedSign - indicates if inherited sign should be displayed.

showSignature - indicates if behavior signature should be displayed.

showFullType - indicates if full qualified type name should be displayed.

showConstraintName - indicates if constraint name should be displayed.

showConstraintExpression - indicates if constraint expression should be displayed.

addColorInformation - indicates if color information should be added to the representation text.

showParameterDirectionKind - indicates if parameter direction kind should be displayed.

showOpaqueBehaviorBody - indicates if opaque behavior body should be displayed

Returns:

behavior text.

createTypedElementText

public static java.lang.String createTypedElementText(TypedElement typedElement,
                                                      boolean showName,
                                                      boolean showType,
                                                      boolean showMultiplicity,
                                                      boolean showFullType,
                                                      boolean addColor)

createPinText

public static java.lang.String createPinText(Pin pin,
                                             boolean showName,
                                             boolean showType,
                                             boolean showMultiplicity,
                                             boolean showFullType,
                                             boolean addColor,
                                             boolean showSynchronizationInfo)

constructGeneralizationSetText

public static java.lang.String constructGeneralizationSetText(GeneralizationSet set,
                                                              boolean showPowerType)

constructCombinedFragmentOperatorText

public static java.lang.String constructCombinedFragmentOperatorText(CombinedFragment combinedFragment)

putInQuotes

public static java.lang.String putInQuotes(java.lang.String text)

createConveyedInformationText

public static java.lang.String createConveyedInformationText(java.util.List<Classifier> information,
                                                             boolean showAutoIDNumber)

createNamedElementListText

public static java.lang.String createNamedElementListText(java.util.List<? extends NamedElement> elements)

Creates representation text for a list of named elements.

Parameters:

elements - - list of named elements.

Returns:

representation text.

createReceptionText

public static java.lang.String createReceptionText(Reception reception,
                                                   boolean showSignature,
                                                   boolean showVisibility,
                                                   boolean showFullType,
                                                   boolean showStereotype,
                                                   boolean showProperties,
                                                   boolean showConstraintName,
                                                   boolean showConstraintExpression,
                                                   boolean showParameterDirection,
                                                   boolean addColorInformation)

Constructs representation reception text.

Parameters:

reception - reception which text will be created.

showSignature - flag indicates if method parameters should be shown.

showVisibility - flag indicates if method visibility should be shown.

showFullType - True for show full type.

showStereotype - show stereotypes

showProperties - show properties

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

showParameterDirection - show parameter direction

addColorInformation - add color

Returns:

method text string.

createReceptionText

@Deprecated
public static java.lang.String createReceptionText(Reception reception,
                                                               boolean showSignature,
                                                               boolean showVisibility,
                                                               boolean showFullType,
                                                               boolean showStereotype,
                                                               boolean showProperties,
                                                               boolean showConstraintName,
                                                               boolean showConstraintExpression,
                                                               boolean showParameterDirection,
                                                               boolean showInheritedSign,
                                                               boolean addColorInformation)

Deprecated.

Constructs representation reception text.

Parameters:

reception - reception which text will be created.

showSignature - flag indicates if method parameters should be shown.

showVisibility - flag indicates if method visibility should be shown.

showFullType - True for show full type.

showStereotype - show stereotypes

showProperties - show properties

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

showParameterDirection - show parameter direction

showInheritedSign - show inherited sign

addColorInformation - add color

Returns:

method text string.

createReceptionText

public static java.lang.String createReceptionText(Reception reception,
                                                   boolean showSignature,
                                                   boolean showVisibility,
                                                   boolean showFullType,
                                                   boolean showStereotype,
                                                   boolean showProperties,
                                                   boolean showTaggedValues,
                                                   boolean showConstraintName,
                                                   boolean showConstraintExpression,
                                                   boolean showParameterDirection,
                                                   boolean showInheritedSign,
                                                   boolean addColorInformation)

Constructs representation reception text.

Parameters:

reception - reception which text will be created.

showSignature - flag indicates if method parameters should be shown.

showVisibility - flag indicates if method visibility should be shown.

showFullType - True for show full type.

showStereotype - show stereotypes

showProperties - show properties

showConstraintName - show constraint name

showConstraintExpression - show constraint expression

showParameterDirection - show parameter direction

showInheritedSign - show inherited sign

addColorInformation - add color

Returns:

method text string.

createStateText

public static java.lang.String createStateText(State state)

Creates state name text. It appends SubMachine name if available.

Parameters:

state - the state to create text for.

Returns:

string containing state name ad SubMachine name

addProvider

public static void addProvider(RepresentationTextCreator.RepresentationTextProvider provider)

Registers a new representation text provider.

Parameters:

provider - provider

removeProvider

public static void removeProvider(RepresentationTextCreator.RepresentationTextProvider provider)

Registers a new representation text provider.

Parameters:

provider - provider

addProvider

public static void addProvider(RepresentationTextCreator.RepresentationTextProvider2 provider)

Registers a new representation text provider.

Parameters:

provider - provider

removeProvider

public static void removeProvider(RepresentationTextCreator.RepresentationTextProvider2 provider)

Registers a new representation text provider.

Parameters:

provider - provider

getProviderFor

@CheckForNull
public static RepresentationTextCreator.RepresentationTextProvider getProviderFor(BaseElement element)

Looks for a provider for a given element.

Parameters:

element - given element

Returns:

found provider or null

getProvider2For

@CheckForNull
public static RepresentationTextCreator.RepresentationTextProvider2 getProvider2For(BaseElement element)

Looks for a provider for a given element.

Parameters:

element - given element

Returns:

found provider or null

createRoleText

public static java.lang.String createRoleText(Property property,
                                              char endName)

Creates role text.

Parameters:

property - property for which to create role text.

endName - name suffix for end identifying in unnamed case.

Returns:

role representation text.

createRoleText

public static java.lang.String createRoleText(Property property,
                                              char endName,
                                              int compressTypeNumber)

Creates role text.

Parameters:

property - property for which to create role text.

endName - name suffix for end identifying in unnamed case.

compressTypeNumber - number of chars till which to compress type text, -1 if type shouldn't compressed.

Returns:

role representation text.

isUseStandardStereotypeKeywordChar

public static boolean isUseStandardStereotypeKeywordChar()

Returns:

true, if standard stereotype keyword char is used; false if double <> is used

setUseStandardStereotypeKeywordChar

public static void setUseStandardStereotypeKeywordChar(boolean useStandard)

Forces to use standard stereotype keyword char or a double <>

Parameters:

useStandard - use standard keyword

createMultiplicityText

public static java.lang.String createMultiplicityText(java.lang.Integer lower,
                                                      java.lang.Integer upper)

Creates multiplicity text.

Parameters:

lower - Lower range.

upper - Upper range.

Returns:

Representation text of multiplicity value.

createMultiplicityRangeText

public static java.lang.String createMultiplicityRangeText(@CheckForNull
                                                           java.lang.Integer range)

Creates multiplicity range text.

Parameters:

range - multiplicity range.

Returns:

multiplicity range string representation.

visitBaseElement

public void visitBaseElement(BaseElement o)
                      throws java.lang.Exception

Description copied from class: Visitor

Method visits given object.

Overrides:

visitBaseElement in class Visitor

Parameters:

o - object to visit.

Throws:

java.lang.Exception

visitNamedElement

public void visitNamedElement(NamedElement o,
                              VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for NamedElement.

Specified by:

visitNamedElement in interface ModelVisitor

Overrides:

visitNamedElement in class ModelHierarchyVisitor

Parameters:

o - that should be visited.

context - visitor's context.

visitModel

public void visitModel(Model element,
                       VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for Model.

Specified by:

visitModel in interface ModelVisitor

Overrides:

visitModel in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

constructModuleText

public static java.lang.String constructModuleText(Element element)

visitRelationship

public void visitRelationship(Relationship o,
                              VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for Relationship.

Specified by:

visitRelationship in interface ModelVisitor

Overrides:

visitRelationship in class ModelHierarchyVisitor

Parameters:

o - that should be visited.

context - visitor's context.

visitAssociationClass

public void visitAssociationClass(AssociationClass element,
                                  VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for AssociationClass.

Specified by:

visitAssociationClass in interface ModelVisitor

Overrides:

visitAssociationClass in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitConnector

public void visitConnector(Connector o,
                           VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for Connector.

Specified by:

visitConnector in interface ModelVisitor

Overrides:

visitConnector in class ModelHierarchyVisitor

Parameters:

o - that should be visited.

context - visitor's context.

visitConnectorEnd

public void visitConnectorEnd(ConnectorEnd o,
                              VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for ConnectorEnd.

Specified by:

visitConnectorEnd in interface ModelVisitor

Overrides:

visitConnectorEnd in class ModelHierarchyVisitor

Parameters:

o - that should be visited.

context - visitor's context.

visitActivityEdge

public void visitActivityEdge(ActivityEdge o,
                              VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for ActivityEdge.

Specified by:

visitActivityEdge in interface ModelVisitor

Overrides:

visitActivityEdge in class ModelHierarchyVisitor

Parameters:

o - that should be visited.

context - visitor's context.

visitExceptionHandler

public void visitExceptionHandler(ExceptionHandler element,
                                  VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for ExceptionHandler.

Specified by:

visitExceptionHandler in interface ModelVisitor

Overrides:

visitExceptionHandler in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitGeneralization

public void visitGeneralization(Generalization generalization,
                                VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for Generalization.

Specified by:

visitGeneralization in interface ModelVisitor

Overrides:

visitGeneralization in class ModelHierarchyVisitor

Parameters:

generalization - that should be visited.

visitorContext - visitor's context.

visitTransition

public void visitTransition(Transition element,
                            VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for Transition.

Specified by:

visitTransition in interface ModelVisitor

Overrides:

visitTransition in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitTrigger

public void visitTrigger(Trigger element,
                         VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for Trigger.

Specified by:

visitTrigger in interface ModelVisitor

Overrides:

visitTrigger in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitCollaborationUse

public void visitCollaborationUse(CollaborationUse element,
                                  VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for CollaborationUse.

Specified by:

visitCollaborationUse in interface ModelVisitor

Overrides:

visitCollaborationUse in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitCallBehaviorAction

public void visitCallBehaviorAction(CallBehaviorAction callBehaviorAction,
                                    VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for CallBehaviorAction.

Specified by:

visitCallBehaviorAction in interface ModelVisitor

Overrides:

visitCallBehaviorAction in class ModelHierarchyVisitor

Parameters:

callBehaviorAction - that should be visited.

visitorContext - visitor's context.

visitCallOperationAction

public void visitCallOperationAction(CallOperationAction callOperationAction,
                                     VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for CallOperationAction.

Specified by:

visitCallOperationAction in interface ModelVisitor

Overrides:

visitCallOperationAction in class ModelHierarchyVisitor

Parameters:

callOperationAction - that should be visited.

visitorContext - visitor's context.

visitElementImport

public void visitElementImport(ElementImport element,
                               VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for ElementImport.

Specified by:

visitElementImport in interface ModelVisitor

Overrides:

visitElementImport in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitBehavioredClassifier

public void visitBehavioredClassifier(BehavioredClassifier element,
                                      VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for BehavioredClassifier.

Specified by:

visitBehavioredClassifier in interface ModelVisitor

Overrides:

visitBehavioredClassifier in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitBehavior

public void visitBehavior(Behavior element,
                          VisitorContext cnt)

Description copied from class: ModelHierarchyVisitor

Visitor method for Behavior.

Specified by:

visitBehavior in interface ModelVisitor

Overrides:

visitBehavior in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

cnt - visitor's context.

visitOpaqueBehavior

public void visitOpaqueBehavior(OpaqueBehavior element,
                                VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for OpaqueBehavior.

Specified by:

visitOpaqueBehavior in interface ModelVisitor

Overrides:

visitOpaqueBehavior in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

getRelationshipFromToPart

public java.lang.String getRelationshipFromToPart(Relationship o)

getRelationshipFromToPart

public java.lang.String getRelationshipFromToPart(Element relationship,
                                                  @CheckForNull
                                                  Element clientModelElement,
                                                  @CheckForNull
                                                  Element supplierModelElement)

visitProperty

public void visitProperty(Property property,
                          VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for Property.

Specified by:

visitProperty in interface ModelVisitor

Overrides:

visitProperty in class ModelHierarchyVisitor

Parameters:

property - that should be visited.

visitorContext - visitor's context.

visitOperation

public void visitOperation(Operation operation,
                           VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for Operation.

Specified by:

visitOperation in interface ModelVisitor

Overrides:

visitOperation in class ModelHierarchyVisitor

Parameters:

operation - that should be visited.

visitorContext - visitor's context.

visitReception

public void visitReception(Reception element,
                           VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for Reception.

Specified by:

visitReception in interface ModelVisitor

Overrides:

visitReception in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitParameter

public void visitParameter(Parameter parameter,
                           VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for Parameter.

Specified by:

visitParameter in interface ModelVisitor

Overrides:

visitParameter in class ModelHierarchyVisitor

Parameters:

parameter - that should be visited.

visitorContext - visitor's context.

visitPin

public void visitPin(Pin element,
                     VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for Pin.

Specified by:

visitPin in interface ModelVisitor

Overrides:

visitPin in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitInstanceSpecification

public void visitInstanceSpecification(InstanceSpecification instanceSpecification,
                                       VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for InstanceSpecification.

Specified by:

visitInstanceSpecification in interface ModelVisitor

Overrides:

visitInstanceSpecification in class ModelHierarchyVisitor

Parameters:

instanceSpecification - that should be visited.

visitorContext - visitor's context.

visitEnumerationLiteral

public void visitEnumerationLiteral(EnumerationLiteral element,
                                    VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for EnumerationLiteral.

Specified by:

visitEnumerationLiteral in interface ModelVisitor

Overrides:

visitEnumerationLiteral in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitActivityPartition

public void visitActivityPartition(ActivityPartition activityPartition,
                                   VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for ActivityPartition.

Specified by:

visitActivityPartition in interface ModelVisitor

Overrides:

visitActivityPartition in class ModelHierarchyVisitor

Parameters:

activityPartition - that should be visited.

visitorContext - visitor's context.

visitMessage

public void visitMessage(Message message,
                         VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for Message.

Specified by:

visitMessage in interface ModelVisitor

Overrides:

visitMessage in class ModelHierarchyVisitor

Parameters:

message - that should be visited.

visitorContext - visitor's context.

visitDiagramPresentationElement

public void visitDiagramPresentationElement(DiagramPresentationElement o)
                                     throws java.lang.Exception

Description copied from class: InheritanceVisitor

Visit DiagramPresentationElement

Overrides:

visitDiagramPresentationElement in class InheritanceVisitor

Parameters:

o - object to visit.

Throws:

java.lang.Exception

visitDiagram

public void visitDiagram(Diagram element,
                         VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for Diagram.

Specified by:

visitDiagram in interface ModelVisitor

Overrides:

visitDiagram in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

isAddColor

public boolean isAddColor()

Test is add color.

Returns:

boolean

setAddColor

public void setAddColor(boolean addColor)

Set new add color value.

Parameters:

addColor - Add color flag.

getLocationInTool

public LocationInTool getLocationInTool()

setLocationInTool

public void setLocationInTool(LocationInTool locationInTool)

isCreateBoundElementName

public boolean isCreateBoundElementName()

setCreateBoundElementName

public void setCreateBoundElementName(boolean createBoundElementName)

isShowFullType

public boolean isShowFullType()

Returns:

true if full type should be used in representation text

setShowFullType

public void setShowFullType(boolean value)

Set show full type.

Parameters:

value - The given value.

resetAutoIdRepresentations

public void resetAutoIdRepresentations(Project project)

clear the cache for all elements that are part of the given project and are 'numberable'

Parameters:

project - project

resetCache

public void resetCache(java.util.Collection<? extends BaseElement> elements)

Reset all cached information about given elements

Parameters:

elements - elements

resetCache

public void resetCache(BaseElement element)

Reset all cached information about given element

Parameters:

element - element

visitComment

public void visitComment(Comment comment,
                         VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for Comment.

Specified by:

visitComment in interface ModelVisitor

Overrides:

visitComment in class ModelHierarchyVisitor

Parameters:

comment - that should be visited.

visitorContext - visitor's context.

visitSlot

public void visitSlot(Slot slot,
                      VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for Slot.

Specified by:

visitSlot in interface ModelVisitor

Overrides:

visitSlot in class ModelHierarchyVisitor

Parameters:

slot - that should be visited.

visitorContext - visitor's context.

visitConstraint

public void visitConstraint(Constraint constraint,
                            VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for Constraint.

Specified by:

visitConstraint in interface ModelVisitor

Overrides:

visitConstraint in class ModelHierarchyVisitor

Parameters:

constraint - that should be visited.

visitorContext - visitor's context.

visitStereotype

public void visitStereotype(Stereotype o,
                            VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for Stereotype.

Specified by:

visitStereotype in interface ModelVisitor

Overrides:

visitStereotype in class ModelHierarchyVisitor

Parameters:

o - that should be visited.

context - visitor's context.

visitTextBoxView

public void visitTextBoxView(TextBoxView o)
                      throws java.lang.Exception

Overrides:

visitTextBoxView in class InheritanceVisitor

Throws:

java.lang.Exception

visitTemplateParameter

public void visitTemplateParameter(TemplateParameter templateParameter,
                                   VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for TemplateParameter.

Specified by:

visitTemplateParameter in interface ModelVisitor

Overrides:

visitTemplateParameter in class ModelHierarchyVisitor

Parameters:

templateParameter - that should be visited.

visitorContext - visitor's context.

visitTemplateParameterSubstitution

public void visitTemplateParameterSubstitution(TemplateParameterSubstitution parameterSubstitution,
                                               VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for TemplateParameterSubstitution.

Specified by:

visitTemplateParameterSubstitution in interface ModelVisitor

Overrides:

visitTemplateParameterSubstitution in class ModelHierarchyVisitor

Parameters:

parameterSubstitution - that should be visited.

visitorContext - visitor's context.

visitValueSpecification

public void visitValueSpecification(ValueSpecification valueSpecification,
                                    VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for ValueSpecification.

Specified by:

visitValueSpecification in interface ModelVisitor

Overrides:

visitValueSpecification in class ModelHierarchyVisitor

Parameters:

valueSpecification - that should be visited.

visitorContext - visitor's context.

visitInterface

public void visitInterface(Interface anInterface,
                           VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for Interface.

Specified by:

visitInterface in interface ModelVisitor

Overrides:

visitInterface in class ModelHierarchyVisitor

Parameters:

anInterface - that should be visited.

visitorContext - visitor's context.

visitClass

public void visitClass(Class aClass,
                       VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for Class.

Specified by:

visitClass in interface ModelVisitor

Overrides:

visitClass in class ModelHierarchyVisitor

Parameters:

aClass - that should be visited.

visitorContext - visitor's context.

visitLifeline

public void visitLifeline(Lifeline lifeline,
                          VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for Lifeline.

Specified by:

visitLifeline in interface ModelVisitor

Overrides:

visitLifeline in class ModelHierarchyVisitor

Parameters:

lifeline - that should be visited.

visitorContext - visitor's context.

visitTypedElement

public void visitTypedElement(TypedElement element,
                              VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for TypedElement.

Specified by:

visitTypedElement in interface ModelVisitor

Overrides:

visitTypedElement in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitActivityParameterNode

public void visitActivityParameterNode(ActivityParameterNode activityParameterNode,
                                       VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for ActivityParameterNode.

Specified by:

visitActivityParameterNode in interface ModelVisitor

Overrides:

visitActivityParameterNode in class ModelHierarchyVisitor

Parameters:

activityParameterNode - that should be visited.

visitorContext - visitor's context.

visitEvent

public void visitEvent(Event event,
                       VisitorContext visitorContext)

Description copied from class: ModelHierarchyVisitor

Visitor method for Event.

Specified by:

visitEvent in interface ModelVisitor

Overrides:

visitEvent in class ModelHierarchyVisitor

Parameters:

event - that should be visited.

visitorContext - visitor's context.

visitSendSignalAction

public void visitSendSignalAction(SendSignalAction sendSignalAction,
                                  VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for SendSignalAction.

Specified by:

visitSendSignalAction in interface ModelVisitor

Overrides:

visitSendSignalAction in class ModelHierarchyVisitor

Parameters:

sendSignalAction - that should be visited.

context - visitor's context.

visitValueSpecificationAction

public void visitValueSpecificationAction(ValueSpecificationAction element,
                                          VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for ValueSpecificationAction.

Specified by:

visitValueSpecificationAction in interface ModelVisitor

Overrides:

visitValueSpecificationAction in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitAcceptEventAction

public void visitAcceptEventAction(AcceptEventAction element,
                                   VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for AcceptEventAction.

Specified by:

visitAcceptEventAction in interface ModelVisitor

Overrides:

visitAcceptEventAction in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitOpaqueAction

public void visitOpaqueAction(OpaqueAction element,
                              VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for OpaqueAction.

Specified by:

visitOpaqueAction in interface ModelVisitor

Overrides:

visitOpaqueAction in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitCombinedFragment

public void visitCombinedFragment(CombinedFragment element,
                                  VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for CombinedFragment.

Specified by:

visitCombinedFragment in interface ModelVisitor

Overrides:

visitCombinedFragment in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

visitInteractionOperand

public void visitInteractionOperand(InteractionOperand element,
                                    VisitorContext context)

Description copied from class: ModelHierarchyVisitor

Visitor method for InteractionOperand.

Specified by:

visitInteractionOperand in interface ModelVisitor

Overrides:

visitInteractionOperand in class ModelHierarchyVisitor

Parameters:

element - that should be visited.

context - visitor's context.

getResult

protected java.lang.String getResult()

Returns created representation result

Returns:

result of representation.

cleanResult

protected void cleanResult()

Clears created representation result. Resets to empty string.

createRepresentationTextComparator

public static java.util.Comparator<BaseElement> createRepresentationTextComparator(boolean addColor,
                                                                                   boolean showAutoId)

Creates a comparator for comparing BaseElements by representation text

Parameters:

addColor - add color into representation text

showAutoId - if true will prepend the autoId to the representation

Returns:

comparator