Combining Graphical and Textual

Combining
Graphics and Text
in
Modeling Tools

Jan Köhnlein (itemis)
Jos Warmer (Ordina)

public void assertSameStructure(EObject left, EObject right) {
if(!isSameStructure(left, right)) {
log.error(getErrorMessage());
Assert.fail(getErrorMessage());
}

Text Graphics
//logger.debug("" + counter + " elements compared");
}

protected String getErrorMessage() {
return errorMessage.toString();
}

public boolean isSameStructure(EObject left, EObject right) {
counter = 0;
return internalIsSameStructure(left, right);
}

public boolean internalIsSameStructure(EObject left, EObject right) {
++counter;
if (!isSameClass(left.eClass(), right.eClass())) {
errorMessage.append("Classes are not equal: " + left + " != " + right).append('n');
return false;
}
List<EObject> leftChildren = getRelevantChildren(left);
List<EObject> rightChildren = getRelevantChildren(right);
if(leftChildren.size() != rightChildren.size()) {
errorMessage.append("Number of children differs " + left + " " + right + " " + leftChildren.size() + " <> " + rightChildren.size()).append('n')
return false;
}
for (int i = 0; i < leftChildren.size(); ++i) {
if(!internalIsSameStructure(leftChildren.get(i), rightChildren.get(i))) {
errorMessage.append("Children differ " + left + " " + right + " with children " + leftChildren.get(i) + " " + rightChildren.get(i)).append
return false;
}
}

return true;
}

protected boolean isSameClass(EClass left, EClass right) {
return left.getName().equals(right.getName())
&& left.getEPackage().getNsURI().equals(right.getEPackage().getNsURI());
}

protected List<EObject> getRelevantChildren(EObject _this) {
List<EObject> relevantChildren = new ArrayList<EObject>(_this.eContents());
for (Iterator<EObject> i = relevantChildren.iterator(); i.hasNext();) {
EObject next = i.next();
if (!isRelevantChild(_this, next)) {
i.remove();

}

Text Graphics
}


•
}

Detailed views
counter = 0;
}

++counter;
return false;
}
return false;
}
return false;
}
}

return true;
}

}

i.remove();

}

Text Graphics
}


• •
}

Detailed views
High-level views
counter = 0;
}

++counter;
return false;
}
return false;
}
return false;
}
}

return true;
}

}

i.remove();

}

Text Graphics
}


• •
}

Detailed views
High-level views
• Very formal syntax
counter = 0;
}

++counter;
return false;
}
return false;
}
return false;
}
}

return true;
}

}

i.remove();

}

Text Graphics
}


• •
}

Detailed views
High-level views

}
counter = 0;
• Suggests non-formalism
++counter;
return false;
}
return false;
}
return false;
}
}

return true;
}

}

i.remove();

}

Text Graphics
}


• •
}

Detailed views
High-level views

}
counter = 0;
• Standard text editor
++counter;
return false;
}
return false;
}
return false;
}
}

return true;
}

}

i.remove();

}

Text Graphics
}


• •
}

Detailed views
High-level views

}
counter = 0;

•
++counter;
Standard text editor
public boolean internalIsSameStructure(EObject left, EObject right) { • Custom editor
return false;
}
return false;
}
return false;
}
}

return true;
}

}

i.remove();

}

Text Graphics
}


• •
}

Detailed views
High-level views

}
counter = 0;
•
++counter;

Standard versioning /
return false;

}
multi-user support
return false;
}
return false;
}
}

return true;
}

}

i.remove();

}

Text Graphics
}


• •
}

Detailed views
High-level views

}
counter = 0;
• •
++counter;

Custom versioning /
return false;

}
multi-user support
multi-user support
return false;
}
return false;
}
}

return true;
}

}

i.remove();

}

Text Graphics
}


• •
}

Detailed views
High-level views

}
counter = 0;
• •
++counter;

Custom versioning /
return false;

}
multi-user support
multi-user support

• Editing with keyboard
return false;
}
return false;
}
}

return true;
}

}

i.remove();

}

Text Graphics
}


• •
}

Detailed views
High-level views

}
counter = 0;
• •
++counter;

Custom versioning /
return false;

}
multi-user support
multi-user support


• Editing with mouse
return false;
}
return false;
}
}

return true;
}

}

i.remove();

}

Text Graphics
}


• •
}

Detailed views
High-level views

}
counter = 0;
• •
++counter;

Custom versioning /
return false;

}
multi-user support
multi-user support


• Editing with mouse
return false;
}
return false;
}
}

Why not have both?
return true;
}

}

i.remove();

Xtext

ar
m
m
ra
G
Runtime
Superclass

Subclass Class

Ecore model LL(*) Parser Text editor

Xtext

ar
m
m
ra
G
Semantic
Metamodel Runtime
Superclass

Subclass Class

Ecore model LL(*) Parser Text editor

Superclass

GMF Subclass

Ecore model
Class

Superclass

GMF Subclass

Ecore model
Class

Graph
Model

Superclass

GMF Subclass

Ecore model
Class

Graph Tool
Model Model

Superclass

GMF Subclass

Ecore model
Class

Graph Map Tool
Model Model Model

Superclass

GMF Subclass

Ecore model
Class

Graph Map Tool
Model Model Model

GMF
Generator
Model

Runtime Models
and
Synchronization

Xtext
EObject element

eAdapters
NodeAdapter

node
children AbstractNode
offset: int
length: int

CompositeNode LeafNode
text: String
parent

Xtext GMF
EObject element EObject

element
eAdapters
NodeAdapter View

node
children AbstractNode Node Edge
offset: int
length: int

layoutConstraints bendpoints
CompositeNode LeafNode Bounds Bendpoints
text: String x: int
parent y: int
width: int
height: int

GMF
ResourceSet

GMFResource DiagramResource

Canonical
EditPolicy

GMF
ResourceSet

GMFResource DiagramResource

Canonical
Canonical
EditPolicy
EditPolicy

Xtext

Textual Model

Serializer
Parser
Node Model

Ecore Model
Instance

Xtext
XtextResource

Textual Model

Serializer
Parser
Node Model

Ecore Model
Instance

Xtext
XtextResource

Textual Model

Serializer
Parser
Node Model

Ecore Model
Instance

getContents()

Xtext load(), save()

XtextResource

Textual Model

Serializer
Parser
Node Model

Ecore Model
Instance

getContents()

Xtext load(), save()

XtextResource

Textual Model

Serializer
Parser
Node Model

Ecore Model
Instance FragmentProvider

getContents() getURIFragment()
getEObject()

ResourceSet

XtextResource DiagramResource

diagram
change

ResourceSet


reparse()
w/ errors

ResourceSet


ResourceSet


Canonical
EditPolicy

Fi e l
od a
M xtu
le l
Te
ResourceSet ResourceSet

XtextResource XtextResource DiagramResource

Fi e l
od a
M xtu
le l
Te

XtextResource save() XtextResource DiagramResource

Fi e l
od a
M xtu
le l
Te

XtextResource reload() XtextResource DiagramResource

grammar org.xtext.cg2009.Entities
with org.eclipse.xtext.common.Terminals

generate entities "http://www.xtext.org/cg2009/Entities"

Model :
{Model} (entities += Entity)*;

Entity returns Entity:
'entity' (name=ID)? ('extends' superType=[Entity])? '{'
(properties+=Property)*
'}';

Property:
SimpleProperty | ReferenceProperty;

SimpleProperty:
'property' (name=ID)? ':' type=('String'|'Number'|'Bool');

ReferenceProperty :
(name=ID)? 'refs' ('one' | many?='many')? type=[Entity];


Avoid empty
models
Model :

'}';

Property:

SimpleProperty:

ReferenceProperty :


Avoid empty
models
Model :

'}';

Property:
Cover mandatory
properties in
SimpleProperty:
validation

ReferenceProperty :


Avoid empty
Carefully select
models
Model : containment or cross
{Model} (entities += Entity)*; references

'}';

Property:
Cover mandatory
properties in
SimpleProperty:
validation

ReferenceProperty :

Xtext
Implement a
Formatter

Xtext
Implement a
Formatter

Implement a
FragmentProvider

Xtext
Implement a
Formatter

Implement a
FragmentProvider

Implement a
JavaValidator

GMF

Initialize
mandatory
properties

GMF

Initialize
mandatory
properties

Avoid Phantom
Nodes

Add a
transaction on
GMF
load

Initialize
mandatory
properties

Avoid Phantom
Nodes

Glue Code
• Prevent conﬂicting modiﬁcations

Glue Code
• Navigate
• diagram ➜ text

Glue Code
• Navigate
• text ➜ diagram
(needs index)

Glue Code
• Navigate
(needs index)
• Parser wrapper

Glue Code
• Navigate
(needs index)
• Parser wrapper
• Popup editor

Combining Graphical and Textual

Combining Graphical and Textual

More Related Content

What's hot

More from Dr. Jan Köhnlein

Recently uploaded

Combining Graphical and Textual