Textual Modeling Framework Xtext

Textual Modeling Framework

Sven Efftinge, Sebastian Zarnekow itemis

Donnerstag, 16. Juli 2009

Domain-Specific Language (DSL)



A DSL is a formal, processable language targeting at a specific viewpoint or

aspect of a software system.



A DSL is a formal, processable language targeting at a specific viewpoint or

aspect of a software system.

It’s semantics, flexibility and notation is designed in order to support working

with that viewpoint as good as possible.


Why DSLs?


Why DSLs?• higher abstractions


Why DSLs?• higher abstractions • avoid redundancy


Why DSLs?• higher abstractions • avoid redundancy• separation of concerns


Why DSLs?• higher abstractions • avoid redundancy• separation of concerns• use domain concepts (Ubiquitous Language)


The challenge


ComplicatedDonnerstag, 16. Juli 2009

Complicated & Expensive ?Donnerstag, 16. Juli 2009

licensed by http://www.wordle.net/


http://www.wordle.net


How we address this with


ConvenienceDonnerstag, 16. Juli 2009

9

grammar org.xtext.workshop.DomainModel with org.eclipse.xtext.common.Terminals

generate domainModel "http://www.xtext.org/DomainModel"

Model : (types+=Type)+;Type : Class | DataType; DataType : 'datatype' name=ID; Class : (abstract?='abstract')? 'class' name=ID '{' (features+=Feature)* '}'; Feature : 'attr' name=ID ':' type=[DataType];


http://www.xtext.org/workshop/DomainModel


9




Grammardefinition




9




Grammardefinition

Grammar reuse




9




Derivedmetamodel




9




Parserrules




9




Parserrules

Keywords




9




Multivalue assignment

Simple assigment

Boolean assigment




9




Cardinality (one or more)

Optional Element

Cardinality (zero or more)




9




Alternative

Cardinality (one or more)

Optional Element

Cardinality (zero or more)




9




Assignment with rulecall




9




Unassigned rulecall





9




Unassigned rulecall


Containment




9




Unassigned rulecall


Cross referenceContainment




Metamodel Inference

10


generate domainModel"http://www.xtext.org/workshop/DomainModel"





Metamodel Inference

10







Metamodel Inference

10







Metamodel Inference

10







Metamodel Inference

10







Metamodel Inference

10







Metamodel Inference

10







Metamodel Inference

10












Based on the grammar and Ecore models,Xtext provides you with sensible

default implementations.


FlexibilityDonnerstag, 16. Juli 2009






Dependency management

























MyCustomLabelProvider




Dependency Injection with Google fGuice





‣No dependency to concrete implementation



‣No dependency to concrete implementation‣No explicit construction



‣No dependency to concrete implementation‣No explicit construction‣Easy testing



‣No dependency to concrete implementation‣No explicit construction‣Easy testing‣Easy composition


Configuration of Components in Xtext

/** * used to register components to be used within the IDE. */public class DomainmodelUiModule extends GeneratedDomainmodelUiModule { @Override public Class<? extends ILabelProvider> bindILabelProvider() { return MySpecialLabelProvider.class; }}


Composable Code Generator

‣ Generator is composed of “fragments”




‣ Fragments can contribute to:





‣ Manifest.MF





‣ Manifest.MF

‣ plugin.xml





‣ Manifest.MF

‣ plugin.xml

‣ Guice modules





‣ Manifest.MF

‣ plugin.xml

‣ Guice modules

‣ Add your own fragments


UseCase Migrating existing Apps


• DB-Application

• Oracle DB

• OracleForms

Starting point


• Oracle DB

• Java Rich Client

• JPA

• Spring

• Swing / JGoodies Forms

Target


Quantities


Quantities• 1700++ Tables



• 19500++ Columns



• 19500++ Columns

• 300++ Forms



• 19500++ Columns

• 300++ Forms

Task



• 19500++ Columns

• 300++ Forms

Task• Find abstractions



• 19500++ Columns

• 300++ Forms

Task• Find abstractions

• Simplify code


@SuppressWarnings("serial")@Entity@Table(name = "BUCHUNGSKREISE_F")public class BuchungskreiseF extends AbstractEntity implements Serializable {

@SuppressWarnings("unused") @Id @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "bkrIdSeq") @SequenceGenerator(name = "bkrIdSeq", sequenceName = "BKR_SEQ", allocationSize = 1) @Column(name = "BKR_ID", nullable = false) private Long bkrId;

public Long getBkrId() { return bkrId; }

public void setBkrId(final Long bkrId) { this.bkrId = bkrId; }

@Column(name = "KONTO_NR", nullable = false, length = 45) private String kontoNr;

public String getKontoNr() { return kontoNr; }

public void setKontoNr(final String kontoNr) { String oldValue = this.kontoNr; this.kontoNr = kontoNr; firePropertyChangeEvent("kontoNr", oldValue, this.kontoNr); }

@Column(name = "RG_NR_BKR_IDENTIFIKATOR", nullable = false, length = 1) private Long rgNrBkrIdentifikator;

public Long getRgNrBkrIdentifikator() { return rgNrBkrIdentifikator; }

public void setRgNrBkrIdentifikator(final Long rgNrBkrIdentifikator) { Long oldValue = this.rgNrBkrIdentifikator; this.rgNrBkrIdentifikator = rgNrBkrIdentifikator; firePropertyChangeEvent("rgNrBkrIdentifikator", oldValue, this.rgNrBkrIdentifikator); }

@Column(name = "REFERENZCODE_KONTO_NR", nullable = false, length = 45) private String referenzcodeKontoNr;

public String getReferenzcodeKontoNr() { return referenzcodeKontoNr; }

public void setReferenzcodeKontoNr(final String referenzcodeKontoNr) { String oldValue = this.referenzcodeKontoNr; this.referenzcodeKontoNr = referenzcodeKontoNr; firePropertyChangeEvent("referenzcodeKontoNr", oldValue, this.referenzcodeKontoNr); }

@Column(name = "PC_NR_RG", nullable = false, length = 45) private String pcNrRg;

public String getPcNrRg() { return pcNrRg; }

public void setPcNrRg(final String pcNrRg) { String oldValue = this.pcNrRg; this.pcNrRg = pcNrRg; firePropertyChangeEvent("pcNrRg", oldValue, this.pcNrRg); }

@Column(name = "PC_NR_PVA", nullable = false, length = 45) private String pcNrPva;

public String getPcNrPva() { return pcNrPva; }

public void setPcNrPva(final String pcNrPva) { String oldValue = this.pcNrPva; this.pcNrPva = pcNrPva; firePropertyChangeEvent("pcNrPva", oldValue, this.pcNrPva); }

@Column(name = "MWST_NR", nullable = false, length = 10) private Long mwstNr;

public Long getMwstNr() { return mwstNr; }

public void setMwstNr(final Long mwstNr) { Long oldValue = this.mwstNr; this.mwstNr = mwstNr; firePropertyChangeEvent("mwstNr", oldValue, this.mwstNr); }

@Column(name = "J_VERSION", nullable = false, insertable = false, updatable = false, length = 22)@org.hibernate.annotations.Generated(org.hibernate.annotations.GenerationTime.ALWAYS) @Version private Long jVersion;

public Long getJVersion() { return jVersion; }

public void setJVersion(final Long jVersion) { Long oldValue = this.jVersion; this.jVersion = jVersion; firePropertyChangeEvent("jVersion", oldValue, this.jVersion); }

@Column(name = "IBAN", nullable = false, length = 34) private String iban;

public String getIban() { return iban; }

public void setIban(final String iban) { String oldValue = this.iban; this.iban = iban; firePropertyChangeEvent("iban", oldValue, this.iban); }

@Column(name = "BUCHUNGSKREIS_NR", nullable = false, length = 4) private Long buchungskreisNr;

public Long getBuchungskreisNr() { return buchungskreisNr; }

public void setBuchungskreisNr(final Long buchungskreisNr) { Long oldValue = this.buchungskreisNr; this.buchungskreisNr = buchungskreisNr; firePropertyChangeEvent("buchungskreisNr", oldValue, this.buchungskreisNr); }

}

Entity

BuchungskreiseF

Id

Long bkrId

String kontoNr

nullable = false

nullable = false 45

BUCHUNGSKREISE_F

BKR_ID

KONTO_NR

BKR_SEQ


@SuppressWarnings("serial")@Entity@Table(name = "BUCHUNGSKREISE_F")public class BuchungskreiseF extends AbstractEntity implements Serializable {

@SuppressWarnings("unused") @Id @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "bkrIdSeq") @SequenceGenerator(name = "bkrIdSeq", sequenceName = "BKR_SEQ", allocationSize = 1) @Column(name = "BKR_ID", nullable = false) private Long bkrId;

public Long getBkrId() { return bkrId; }

public void setBkrId(final Long bkrId) { this.bkrId = bkrId; }

@Column(name = "KONTO_NR", nullable = false, length = 45) private String kontoNr;

public String getKontoNr() { return kontoNr; }

public void setKontoNr(final String kontoNr) { String oldValue = this.kontoNr; this.kontoNr = kontoNr; firePropertyChangeEvent("kontoNr", oldValue, this.kontoNr); }

@Column(name = "RG_NR_BKR_IDENTIFIKATOR", nullable = false, length = 1) private Long rgNrBkrIdentifikator;

public Long getRgNrBkrIdentifikator() { return rgNrBkrIdentifikator; }

public void setRgNrBkrIdentifikator(final Long rgNrBkrIdentifikator) { Long oldValue = this.rgNrBkrIdentifikator; this.rgNrBkrIdentifikator = rgNrBkrIdentifikator; firePropertyChangeEvent("rgNrBkrIdentifikator", oldValue, this.rgNrBkrIdentifikator); }

@Column(name = "REFERENZCODE_KONTO_NR", nullable = false, length = 45) private String referenzcodeKontoNr;

public String getReferenzcodeKontoNr() { return referenzcodeKontoNr; }

public void setReferenzcodeKontoNr(final String referenzcodeKontoNr) { String oldValue = this.referenzcodeKontoNr; this.referenzcodeKontoNr = referenzcodeKontoNr; firePropertyChangeEvent("referenzcodeKontoNr", oldValue, this.referenzcodeKontoNr); }

@Column(name = "PC_NR_RG", nullable = false, length = 45) private String pcNrRg;

public String getPcNrRg() { return pcNrRg; }

public void setPcNrRg(final String pcNrRg) { String oldValue = this.pcNrRg; this.pcNrRg = pcNrRg; firePropertyChangeEvent("pcNrRg", oldValue, this.pcNrRg); }

@Column(name = "PC_NR_PVA", nullable = false, length = 45) private String pcNrPva;

public String getPcNrPva() { return pcNrPva; }

public void setPcNrPva(final String pcNrPva) { String oldValue = this.pcNrPva; this.pcNrPva = pcNrPva; firePropertyChangeEvent("pcNrPva", oldValue, this.pcNrPva); }

@Column(name = "MWST_NR", nullable = false, length = 10) private Long mwstNr;

public Long getMwstNr() { return mwstNr; }

public void setMwstNr(final Long mwstNr) { Long oldValue = this.mwstNr; this.mwstNr = mwstNr; firePropertyChangeEvent("mwstNr", oldValue, this.mwstNr); }

@Column(name = "J_VERSION", nullable = false, insertable = false, updatable = false, length = 22)@org.hibernate.annotations.Generated(org.hibernate.annotations.GenerationTime.ALWAYS) @Version private Long jVersion;

public Long getJVersion() { return jVersion; }

public void setJVersion(final Long jVersion) { Long oldValue = this.jVersion; this.jVersion = jVersion; firePropertyChangeEvent("jVersion", oldValue, this.jVersion); }

@Column(name = "IBAN", nullable = false, length = 34) private String iban;

public String getIban() { return iban; }

public void setIban(final String iban) { String oldValue = this.iban; this.iban = iban; firePropertyChangeEvent("iban", oldValue, this.iban); }

@Column(name = "BUCHUNGSKREIS_NR", nullable = false, length = 4) private Long buchungskreisNr;

public Long getBuchungskreisNr() { return buchungskreisNr; }

public void setBuchungskreisNr(final Long buchungskreisNr) { Long oldValue = this.buchungskreisNr; this.buchungskreisNr = buchungskreisNr; firePropertyChangeEvent("buchungskreisNr", oldValue, this.buchungskreisNr); }

}

Entity

BuchungskreiseF

Id

Long bkrId

String kontoNr

nullable = false

nullable = false 45

BUCHUNGSKREISE_F

BKR_ID

KONTO_NR

BKR_SEQ


entity BuchungskreiseF (id=bkrId sequenceName=BKR_SEQ) {

String kontoNr

Long rgNrBkrIdentifikator

String referenzcodeKontoNr

}

(notNull, length=45)

(notNull, length=45)

(notNull, length=1)

External DSL for Entities



String kontoNr



}




String kontoNr



}

BUCHUNGSKREISE_F

RG_NR_BKR_IDENTIFIKATOR



ValidationDonnerstag, 16. Juli 2009


addValidator(new Validator<Institutionen>() { @Override public ValidationResult validate(final Institutionen institution) { final ValidationResult result = new ValidationResult(); if (institution != null && institution.getEsrNr() != null && !CheckUtils.checkPcKontoNrPruefziffer( Long.parseLong(institution.getEsrNr())) { result.add(new SimpleValidationMessage( getResourceMap().getString("validation.esr.msg"), Severity.ERROR, getModel(Institutionen.DESC.esrNr()))); } return result; } });



Framework-Code



Framework-CodeNullpointer abfragen



Framework-CodeNullpointer abfragenStatic imports



Framework-CodeNullpointer abfragenStatic importsBibliotheks Methoden definieren und benutzen

error("validation.esr.msg", desc.esrNr());


@Check void checkEsrMsg() { if (!checkKontoNrPruefziffer(parseLong(_this.getEsrNr()))) error("validation.esr.msg",desc.esrNr()); }

Internal DSL with Java

• JUnit-like• Ignore Nullpointer-Exceptions


Future PlansDonnerstag, 16. Juli 2009

Eclipse Helios


Eclipse Helios•Model Index



•Grammar Mixins



•Grammar Mixins

•Base Language



•Grammar Mixins

•Base Language

•UI Features



•Grammar Mixins

•Base Language

•UI Features

•Documentation



Thank you very much for listening

Visit the project’s web site : www.xtext.org

Copyright 2009 by itemis


http://www.xtext.org

http://www.xtext.org

Thank you very much for listening

Visit the project’s web site : www.xtext.org

Copyright 2009 by itemis

Xtext Webinar Tomorrow 19:00

http://live.eclipse.org/node/705




Technology

Textual Modeling Framework Xtext