Package eu.bandm.tools.umod

Class Factory

java.lang.Object

eu.bandm.tools.umod.Factory

public class Factory
extends Object

Collection of methods for easy programmatic creation of a umod model description. Usage:

1. Create an instance of this class.
2. Create the meta-model by its methods.
3. call new Checker.check(myFactory.model, msg)
4. call GeneratedPackage gp = new UMod2Java().translate(myFactory.model)
5. call new Unparser.write(gp)

((FIXME: these further stages of processing could be integrated in this Factory by further convenience wrapper methods, if desired.))
The original umod model is a umod model itself, and is accessible throughout by the field model. The umod model classes defined in UMod are returned as results and accessible via model and can be manipulated directly, if required. But the factory methods are preferred, because of implied consistency.
The basic umod rules are tested anyhow:

• There is one single namespace for the model itself, model clases, enumerations, imports, exported interfaces, and visitor base classes. Identifiers are unique among all these.
• No shadowing/re-usage of field names on a path to the classs tree root(s).

The additional rules imposed by the umod parser front-end are ensured additionally, if parameter parserLike is set to true:

• Field names start lower case; class names start upper case.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Factory.VisitorFlavours	A convenience wrapper for the different combinations of boolean attributes of visitor definitions.

Field Summary

Fields

Modifier and Type	Field	Description
final UMod.Forest	model
protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>>	msg
final boolean	parserLike

Constructor Summary

Constructors

Constructor	Description
Factory(String name, boolean parserLike, @Opt Location<XMLDocumentIdentifier> loc, @Opt String doc)

Method Summary

Modifier and Type	Method	Description
UMod.ClassDef	addClassDef(UMod.ClassDef superclass, String name, @Opt Location<XMLDocumentIdentifier> loc, @Opt String doc, boolean isAlgebraic, boolean isAbstract)	Add a class definition to the model.
void	addDocumentation(UMod.Item item, String text)	Append a String to the documentation sequence of the model itself, a Class/Enumeration/Visitor/Interface definition, or a Field definition.
UMod.EnumDef	addEnumDef(String name, @Opt Location<XMLDocumentIdentifier> loc, @Opt String doc)	Add an enumeration definition to the model.
UMod.EnumDef	addEnumDef(String name, @Opt Location<XMLDocumentIdentifier> loc, @Opt String doc, String... items)	Add an enumeration definition plus some/all of its enumeration values to the model.
void	addEnumItem(UMod.EnumDef edef, String name, @Opt String doc)	Add a further enumeration value to an already defined enumeration type.
UMod.ExtDeclaration	addExternalDeclaration(String name, @Opt Location<XMLDocumentIdentifier> loc)	Add an external declaration to the model.
UMod.FieldDef	addFieldDef(UMod.ClassDef cls, String name, UMod.ClassDef fieldType, @Opt Location<XMLDocumentIdentifier> loc, @Opt String doc)
UMod.FieldDef	addFieldDef(UMod.ClassDef cls, String name, UMod.Type fieldType, @Opt Location<XMLDocumentIdentifier> loc, @Opt String doc)	Add a field definition to a class definition.
void	addJavaText(UMod.ClassDef cd, String text, @Opt Location<XMLDocumentIdentifier> loc)	Add a verbatim java block, either to a class definition's code, or to the top-level model classs, if cd==null.
void	addTostringText(UMod.ClassDef cd, String text, @Opt Location<XMLDocumentIdentifier> loc)	Add a standard toString() method to the class definition's code.
UMod.VisitorHint	addVisitorDef(String name, @Opt Location<XMLDocumentIdentifier> loc, @Opt String doc, @Opt Factory.VisitorFlavours flavour, int number)	Add a base visitor definition to the model.
void	addVisitorRegister(UMod.FieldDef field, int num, int pos, @Opt String lr)	Add a visitor register number to a field.
protected void	opt_addDocumentation(UMod.Item item, @Opt String text)
protected void	putDef(UMod.Item it, String name)	Add definition into the one, unified toplevel namespace.
void	setDocumentation(UMod.EnumDef def, String item, String text)	Put the string value as (the only!) doc text of the enumeration item.
protected void	synterror(Location<XMLDocumentIdentifier> loc, String txt)

Methods inherited from class java.lang.Object

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

Field Details

model

public final UMod.Forest model

parserLike

public final boolean parserLike

msg

protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg

Constructor Details

Factory

public Factory(String name,
 boolean parserLike,
 @Opt
 @Opt Location<XMLDocumentIdentifier> loc,
 @Opt
 @Opt String doc)

Method Details

putDef

protected void putDef(UMod.Item it,
 String name)

Add definition into the one, unified toplevel namespace.

synterror

protected void synterror(Location<XMLDocumentIdentifier> loc,
 String txt)

addDocumentation

public void addDocumentation(UMod.Item item,
 String text)

Append a String to the documentation sequence of the model itself, a Class/Enumeration/Visitor/Interface definition, or a Field definition. (Enumeration items are no subclass of UMod.Item and thus not covered by this method.)

setDocumentation

public void setDocumentation(UMod.EnumDef def,
 String item,
 String text)

Put the string value as (the only!) doc text of the enumeration item.

opt_addDocumentation

protected void opt_addDocumentation(UMod.Item item,
 @Opt
 @Opt String text)

addExternalDeclaration

public UMod.ExtDeclaration addExternalDeclaration(String name,
 @Opt
 @Opt Location<XMLDocumentIdentifier> loc)

Add an external declaration to the model.

addVisitorDef

public UMod.VisitorHint addVisitorDef(String name,
 @Opt
 @Opt Location<XMLDocumentIdentifier> loc,
 @Opt
 @Opt String doc,
 @Opt
 @Opt Factory.VisitorFlavours flavour,
 int number)

Add a base visitor definition to the model.

addVisitorRegister

public void addVisitorRegister(UMod.FieldDef field,
 int num,
 int pos,
 @Opt
 @Opt String lr)

Add a visitor register number to a field. Double use of pos is NOT prevented, but means undetermined sequential order.

addEnumDef

public UMod.EnumDef addEnumDef(String name,
 @Opt
 @Opt Location<XMLDocumentIdentifier> loc,
 @Opt
 @Opt String doc)

Add an enumeration definition to the model. The uniqueness of the name is tested immediately.

addEnumDef

public UMod.EnumDef addEnumDef(String name,
 @Opt
 @Opt Location<XMLDocumentIdentifier> loc,
 @Opt
 @Opt String doc,
 String... items)

Add an enumeration definition plus some/all of its enumeration values to the model. The uniqueness of the ernumeration's name is tested immediately. FIXME UNIUQE enumitemname TEST !?

addEnumItem

public void addEnumItem(UMod.EnumDef edef,
 String name,
 @Opt
 @Opt String doc)

Add a further enumeration value to an already defined enumeration type. FIXME UNIUQE enumitemname TEST !?

addClassDef

public UMod.ClassDef addClassDef(@Opt
 UMod.ClassDef superclass,
 String name,
 @Opt
 @Opt Location<XMLDocumentIdentifier> loc,
 @Opt
 @Opt String doc,
 boolean isAlgebraic,
 boolean isAbstract)

Add a class definition to the model. The uniqueness of the name is tested immediately.

addJavaText

public void addJavaText(@Opt
 UMod.ClassDef cd,
 String text,
 @Opt
 @Opt Location<XMLDocumentIdentifier> loc)

Add a verbatim java block, either to a class definition's code, or to the top-level model classs, if cd==null.

addTostringText

public void addTostringText(UMod.ClassDef cd,
 String text,
 @Opt
 @Opt Location<XMLDocumentIdentifier> loc)

Add a standard toString() method to the class definition's code.

addFieldDef

public UMod.FieldDef addFieldDef(UMod.ClassDef cls,
 String name,
 UMod.Type fieldType,
 @Opt
 @Opt Location<XMLDocumentIdentifier> loc,
 @Opt
 @Opt String doc)

Add a field definition to a class definition. The uniqueness of field names is tested later, by the Checker. The type of the field can be constructed by the constructors of the sub-classes of UMod.TypeConstructed, applied recursively, and to the constants UMod.BOOL, UMod.CHAR, UMod.FLOAT, UMod.INT and UMod.STRING.
(All these can be looked up by their umod-frontend name from Reducer.predefinedTypes.

addFieldDef

public UMod.FieldDef addFieldDef(UMod.ClassDef cls,
 String name,
 UMod.ClassDef fieldType,
 @Opt
 @Opt Location<XMLDocumentIdentifier> loc,
 @Opt
 @Opt String doc)