Package net.ssehub.easy.varModel.persistency

Class ConstraintSplitWriter

java.lang.Object

net.ssehub.easy.varModel.model.AbstractVisitor

net.ssehub.easy.varModel.persistency.AbstractVarModelWriter

net.ssehub.easy.varModel.persistency.IVMLWriter

net.ssehub.easy.varModel.persistency.ConstraintSplitWriter

All Implemented Interfaces:

IConstraintTreeVisitor, ICustomDatatypeVisitor, IModelVisitor, IValueVisitor

public class ConstraintSplitWriter
extends IVMLWriter

Splits the textual output at a given constraint. This writer is useful for embedded constraint editors.

Author:

Holger Eichelberger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConstraintSplitWriter.IConstraintFilter	Identifies the constraint where to split at.
static class	ConstraintSplitWriter.IdentityConstraintFilter	An identity constraint filter.

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

AbstractVarModelWriter.DefaultSpace

Field Summary

Fields

Modifier and Type	Field	Description
private java.io.StringWriter	after
private java.io.StringWriter	before
private java.io.StringWriter	constraint
private ConstraintSplitWriter.IConstraintFilter	filter

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

DUMMY_PARENT

Constructor Summary

Constructors

Constructor	Description
ConstraintSplitWriter(ConstraintSplitWriter.IConstraintFilter filter)	Creates a split writer for the given writer and splits at constraint.

Method Summary

Modifier and Type	Method	Description
private static boolean	doTrim(char ch)	Returns whether ch shall be trimmed.
protected void	emitConstraintExpression(IModelElement context, ConstraintSyntaxTree constraint)	Visits the expression of a constraint (for extension).
protected void	emitDecisionVariableDeclarationDefault(DecisionVariableDeclaration decl, ConstraintSyntaxTree defaultValue)	Emits the default value of a decision variable declaration (for extension).
java.lang.String	getAfterText()	Returns the textual model representation after the constraint.
java.lang.String	getBeforeText()	Returns the textual model representation before the constraint.
java.lang.String	getConstraintText()	Returns the textual model representation of the constraint.
java.lang.String[]	getSplit(boolean trimConstraint, boolean trimParenthesis)	Returns the split as needed for embedding xText editors.
private void	post(boolean split)	To be called after a potential split point (checking the filter).
private boolean	pre(IModelElement context, ConstraintSyntaxTree constraint)	To be called before a potential split point (checking the filter).

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

appendOCLFeatureCall, beforeNestedElement, emitComments, endWritingCompound, endWritingProject, forceComponundTypes, getInstance, printDefaultSpace, processVersion, releaseInstance, setFormatInitializer, startWritingCompound, startWritingProject, visitAnnotationVariable, visitAttribute, visitAttributeAssignment, visitBlockExpression, visitBooleanValue, visitComment, visitComment, visitCompound, visitCompoundAccess, visitCompoundAccessStatement, visitCompoundInitializer, visitCompoundValue, visitConstraint, visitContainerInitializer, visitContainerOperationCall, visitContainerValue, visitDecisionVariableDeclaration, 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, visitVariable, visitVersionValue, writeValue

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

addParent, appendIndentation, appendOutput, appendOutput, considerOclCompliance, decreaseAdditionalIndentation, 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

before

private java.io.StringWriter before

constraint

private java.io.StringWriter constraint

after

private java.io.StringWriter after

filter

private ConstraintSplitWriter.IConstraintFilter filter

Constructor Detail

ConstraintSplitWriter

public ConstraintSplitWriter(ConstraintSplitWriter.IConstraintFilter filter)

Creates a split writer for the given writer and splits at constraint.

Parameters:

filter - the constraint filter identifying the split point

Method Detail

pre

private boolean pre(IModelElement context,
                    ConstraintSyntaxTree constraint)

To be called before a potential split point (checking the filter).

Parameters:

context - the enclosing model element

constraint - the constraint to check

Returns:

true if a split shall happen, false else

post

private void post(boolean split)

To be called after a potential split point (checking the filter).

Parameters:

split - the output of the corresponding pre call

emitConstraintExpression

protected void emitConstraintExpression(IModelElement context,
                                        ConstraintSyntaxTree constraint)

Description copied from class: AbstractVarModelWriter

Visits the expression of a constraint (for extension).

Overrides:

emitConstraintExpression in class AbstractVarModelWriter

Parameters:

context - the visiting context

constraint - the (specified) constraint;

emitDecisionVariableDeclarationDefault

protected void emitDecisionVariableDeclarationDefault(DecisionVariableDeclaration decl,
                                                      ConstraintSyntaxTree defaultValue)

Description copied from class: IVMLWriter

Emits the default value of a decision variable declaration (for extension).

Overrides:

emitDecisionVariableDeclarationDefault in class IVMLWriter

Parameters:

decl - the declaration

defaultValue - the specified default value

getBeforeText

public java.lang.String getBeforeText()

Returns the textual model representation before the constraint.

Returns:

the textual model representation before the constraint

getConstraintText

public java.lang.String getConstraintText()

Returns the textual model representation of the constraint.

Returns:

the textual model representation of the constraint

getAfterText

public java.lang.String getAfterText()

Returns the textual model representation after the constraint.

Returns:

the textual model representation after the constraint

getSplit

public java.lang.String[] getSplit(boolean trimConstraint,
                                   boolean trimParenthesis)

Returns the split as needed for embedding xText editors.

Parameters:

trimConstraint - trim the constraint from leading/trailing whitespaces

trimParenthesis - trims the constraint from a leading/trailing parenthesis moving them to prefix/suffix

Returns:

an array consisting of the values of getBeforeText(), getConstraintText() and getAfterText()

doTrim

private static boolean doTrim(char ch)

Returns whether ch shall be trimmed.

Parameters:

ch - the character to check

Returns:

true if ch shall be trimmed, false else