net.ssehub.easy.reasoning.core.reasoner

Class CommentResourceVisitor

java.lang.Object

net.ssehub.easy.varModel.model.AbstractVisitor

net.ssehub.easy.varModel.persistency.AbstractVarModelWriter

net.ssehub.easy.varModel.persistency.IVMLWriter

net.ssehub.easy.reasoning.core.reasoner.CommentResourceVisitor

All Implemented Interfaces:

net.ssehub.easy.varModel.cst.IConstraintTreeVisitor, net.ssehub.easy.varModel.model.datatypes.ICustomDatatypeVisitor, net.ssehub.easy.varModel.model.IModelVisitor, net.ssehub.easy.varModel.model.values.IValueVisitor

public class CommentResourceVisitor
extends net.ssehub.easy.varModel.persistency.IVMLWriter

A visitor turning (partial) IVML elements into more or less explainable strings based on a given CommentResource. IVML operations can be turned into strings through a pseudo signature of "." as operator and arguments, e.g., using "isDefined(.)" as key. Variables are read from CommentResource as such.

Author:

Holger Eichelberger

Nested Class Summary

Nested classes/interfaces inherited from class net.ssehub.easy.varModel.persistency.AbstractVarModelWriter

net.ssehub.easy.varModel.persistency.AbstractVarModelWriter.DefaultSpace

Field Summary

Fields

Modifier and Type	Field and Description
private net.ssehub.easy.varModel.management.CommentResource	comments

Fields inherited from class net.ssehub.easy.varModel.persistency.AbstractVarModelWriter

DUMMY_PARENT

Constructor Summary

Constructors

Modifier	Constructor and Description
private	CommentResourceVisitor(java.io.Writer out, net.ssehub.easy.varModel.management.CommentResource comments) Creates a visitor instance.

Method Summary

Modifier and Type	Method and Description
private boolean	appendComment(java.lang.String key, java.lang.String[] args) Appends a comment taken from the comments resource.
protected void	appendOCLFeatureCall(net.ssehub.easy.varModel.cst.OCLFeatureCall call, net.ssehub.easy.varModel.model.datatypes.Operation.FormattingHint hint)
private java.lang.String	getComment(java.lang.String key) Returns the comment for key.
static java.lang.String	visit(net.ssehub.easy.varModel.model.IModelElement elt, net.ssehub.easy.varModel.management.CommentResource comments) Visits a model element and returns the translated elements as String.
void	visitCompoundAccess(net.ssehub.easy.varModel.cst.CompoundAccess access)
void	visitConstraint(net.ssehub.easy.varModel.model.Constraint constraint)
void	visitVariable(net.ssehub.easy.varModel.cst.Variable variable)

Methods inherited from class net.ssehub.easy.varModel.persistency.IVMLWriter

beforeNestedElement, emitComments, emitDecisionVariableDeclarationDefault, endWritingCompound, endWritingProject, forceComponundTypes, getInstance, printDefaultSpace, processVersion, releaseInstance, setFormatInitializer, startWritingCompound, startWritingProject, visitAnnotationVariable, visitAttribute, visitAttributeAssignment, visitBlockExpression, visitBooleanValue, visitComment, visitComment, visitCompound, visitCompoundAccessStatement, visitCompoundInitializer, visitCompoundValue, visitContainerInitializer, visitContainerOperationCall, visitContainerValue, visitDecisionVariableDeclaration, visitDeferInitExpression, visitDerivedDatatype, visitEnum, visitEnumLiteral, visitEnumValue, visitFreezeBlock, visitIfThen, visitIntValue, visitLet, visitMetaTypeValue, visitMultiAndExpression, visitNullValue, visitOclFeatureCall, visitOperationDefinition, visitParenthesis, visitPartialEvaluationBlock, visitProject, visitProjectImport, visitProjectInterface, visitRealValue, visitReference, visitReferenceValue, visitSelf, visitSequence, visitSet, visitStringValue, visitVersionValue, writeValue

Methods inherited from class net.ssehub.easy.varModel.persistency.AbstractVarModelWriter

addParent, appendIndentation, appendOutput, appendOutput, considerOclCompliance, decreaseAdditionalIndentation, emitConstraintExpression, flush, getExpressionContext, getIndentation, getIvmlIndentStep, getLogger, getParent, getParent, getParent, getParentCount, getUseIvmlWhitespace, getWriter, increaseAdditionalIndentation, removeLastParent, setExpressionContext, setIndentationStep, setIndentStep, setOclCompliance, setUseIvmlWhitespace, setUseWhitespaces, setWriter, visitConstantValue, visitConstraintValue, visitOrderedEnum, visitUnresolvedExpression

Methods inherited from class java.lang.Object

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

Field Detail

comments

private net.ssehub.easy.varModel.management.CommentResource comments

Constructor Detail

CommentResourceVisitor

private CommentResourceVisitor(java.io.Writer out,
                               net.ssehub.easy.varModel.management.CommentResource comments)

Creates a visitor instance.

Parameters:

out - the output writer

comments - the comment resource, may be null for none

Method Detail

visit

public static java.lang.String visit(net.ssehub.easy.varModel.model.IModelElement elt,
                                     net.ssehub.easy.varModel.management.CommentResource comments)

Visits a model element and returns the translated elements as String. Without a properly defined comments resource, this shall lead to similar results as delivered by StringProvider.

Parameters:

elt - the element to visit

comments - the comment resource, may be null for none

Returns:

the translated string

appendOCLFeatureCall

protected void appendOCLFeatureCall(net.ssehub.easy.varModel.cst.OCLFeatureCall call,
                                    net.ssehub.easy.varModel.model.datatypes.Operation.FormattingHint hint)

Overrides:

appendOCLFeatureCall in class net.ssehub.easy.varModel.persistency.IVMLWriter

visitConstraint

public void visitConstraint(net.ssehub.easy.varModel.model.Constraint constraint)

Specified by:

visitConstraint in interface net.ssehub.easy.varModel.model.IModelVisitor

Overrides:

visitConstraint in class net.ssehub.easy.varModel.persistency.IVMLWriter

visitVariable

public void visitVariable(net.ssehub.easy.varModel.cst.Variable variable)

Specified by:

visitVariable in interface net.ssehub.easy.varModel.cst.IConstraintTreeVisitor

Overrides:

visitVariable in class net.ssehub.easy.varModel.persistency.IVMLWriter

getComment

private java.lang.String getComment(java.lang.String key)

Returns the comment for key.

Parameters:

key - the key (may be null)

Returns:

the comment or null for none

appendComment

private boolean appendComment(java.lang.String key,
                              java.lang.String[] args)

Appends a comment taken from the comments resource.

Parameters:

key - the key (may be null)

args - the arguments for an operation, replacing "{i}" with i a non-negative integer denoting operand (0) and parameter (1..)

Returns:

true if the operation was performed and something was appended to this writer, false else

visitCompoundAccess

public void visitCompoundAccess(net.ssehub.easy.varModel.cst.CompoundAccess access)

Specified by:

visitCompoundAccess in interface net.ssehub.easy.varModel.cst.IConstraintTreeVisitor

Overrides:

visitCompoundAccess in class net.ssehub.easy.varModel.persistency.IVMLWriter