com.asakusafw.dmdl.semantics

Class ModelDeclaration

java.lang.Object

com.asakusafw.dmdl.semantics.ModelDeclaration

All Implemented Interfaces:

Declaration, Element

public class ModelDeclaration
extends Object
implements Declaration

Declaration of data models.

Since:

0.2.0

Version:

0.9.2

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelDeclaration(DmdlSemantics owner, AstModelDefinition<?> originalAst, AstSimpleName name, AstDescription description, List<? extends AstAttribute> attributes) Creates and returns a new instance.

Method Summary

Modifier and Type	Method and Description
PropertySymbol	createPropertySymbol(AstSimpleName propertyName) Creates and returns a new property symbol in this model.
PropertyDeclaration	declareProperty(AstNode propertyOriginalAst, AstSimpleName propertyName, Type propertyType, AstDescription propertyDescription, List<? extends AstAttribute> propertyAttributes) Declares a new property into this model.
PropertyReferenceDeclaration	declarePropertyReference(AstNode memberOriginalAst, AstSimpleName memberName, Type referentType, PropertyReferenceDeclaration.ReferenceContainer<?> references, AstDescription memberDescription, List<? extends AstAttribute> memberAttributes) Declares a new property reference into this model.
MemberDeclaration	findMemberDeclaration(String memberName) Returns a declared member in this model.
PropertyDeclaration	findPropertyDeclaration(String propertyName) Returns a declared property in this model.
PropertyReferenceDeclaration	findPropertyReferenceDeclaration(String propertyName) Returns a declared property reference in this model.
List<AstAttribute>	getAttributes() Returns the attached attributes of this element.
List<MemberDeclaration>	getDeclaredMembers() Returns all declared members in this model.
List<PropertyDeclaration>	getDeclaredProperties() Returns all declared properties in this model.
List<PropertyReferenceDeclaration>	getDeclaredPropertyReferences() Returns all declared property references in this model.
AstDescription	getDescription() Returns the description of this element.
AstSimpleName	getName() Returns the name of this declared element.
AstModelDefinition<?>	getOriginalAst() Returns the corresponded syntactic element of this.
ModelSymbol	getSymbol() Returns the symbol refer to this declaration.
<T extends Trait<T>> T	getTrait(Class<T> kind) Returns the specified trait of this declaration.
<T extends Trait<T>> void	putTrait(Class<T> kind, T trait) Puts a trait into this declaration.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.asakusafw.dmdl.semantics.Declaration

findTrait

Constructor Detail

ModelDeclaration

protected ModelDeclaration(DmdlSemantics owner,
                           AstModelDefinition<?> originalAst,
                           AstSimpleName name,
                           AstDescription description,
                           List<? extends AstAttribute> attributes)

Creates and returns a new instance.

Parameters:

owner - the world contains this symbol

originalAst - the original AST, or null if this is an ad-hoc element

name - the name of this model

description - the description of this model, or null if unknown

attributes - the attributes of this model

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

getSymbol

public ModelSymbol getSymbol()

Returns the symbol refer to this declaration.

Returns:

the symbol refer to this declaration

getOriginalAst

public AstModelDefinition<?> getOriginalAst()

Description copied from interface: Element

Returns the corresponded syntactic element of this.

Specified by:

getOriginalAst in interface Element

Returns:

the corresponded syntactic element, or null if unknown

getName

public AstSimpleName getName()

Description copied from interface: Declaration

Returns the name of this declared element.

Specified by:

getName in interface Declaration

Returns:

the name

getDescription

public AstDescription getDescription()

Description copied from interface: Declaration

Returns the description of this element.

Specified by:

getDescription in interface Declaration

Returns:

the description of this element, or null not defind

getAttributes

public List<AstAttribute> getAttributes()

Description copied from interface: Declaration

Returns the attached attributes of this element.

If not attributes are attached, this returns an empty list.

Specified by:

getAttributes in interface Declaration

Returns:

the attached attributes

declareProperty

public PropertyDeclaration declareProperty(AstNode propertyOriginalAst,
                                           AstSimpleName propertyName,
                                           Type propertyType,
                                           AstDescription propertyDescription,
                                           List<? extends AstAttribute> propertyAttributes)

Declares a new property into this model.

Parameters:

propertyOriginalAst - the original AST, or null if this is an ad-hoc element

propertyName - the name of this property

propertyType - the type of this property

propertyDescription - the description of this property, or null if unknown

propertyAttributes - the attributes of this property

Returns:

the declared property

Throws:

IllegalArgumentException - if some parameters were null

declarePropertyReference

public PropertyReferenceDeclaration declarePropertyReference(AstNode memberOriginalAst,
                                                             AstSimpleName memberName,
                                                             Type referentType,
                                                             PropertyReferenceDeclaration.ReferenceContainer<?> references,
                                                             AstDescription memberDescription,
                                                             List<? extends AstAttribute> memberAttributes)

Declares a new property reference into this model.

Parameters:

memberOriginalAst - the original AST, or null if this is an ad-hoc element

memberName - the name of this member

referentType - the referent type

references - the references

memberDescription - the description of this member, or null if unknown

memberAttributes - the attributes of this member

Returns:

the declared member

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.9.2

findMemberDeclaration

public MemberDeclaration findMemberDeclaration(String memberName)

Returns a declared member in this model.

Parameters:

memberName - the name of the member

Returns:

a declared member with the name, or null if not declared

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.9.2

findPropertyDeclaration

public PropertyDeclaration findPropertyDeclaration(String propertyName)

Returns a declared property in this model.

Parameters:

propertyName - the name of the property

Returns:

a declared property with the name, or null if not declared

Throws:

IllegalArgumentException - if some parameters were null

findPropertyReferenceDeclaration

public PropertyReferenceDeclaration findPropertyReferenceDeclaration(String propertyName)

Returns a declared property reference in this model.

Parameters:

propertyName - the name of the property reference

Returns:

a declared property with the name, or null if not declared

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.9.2

getDeclaredMembers

public List<MemberDeclaration> getDeclaredMembers()

Returns all declared members in this model.

Returns:

all declared members, or an empty list if there are no declared members

Since:

0.9.2

getDeclaredProperties

public List<PropertyDeclaration> getDeclaredProperties()

Returns all declared properties in this model.

Returns:

all declared properties, or an empty list if there are no declared properties

getDeclaredPropertyReferences

public List<PropertyReferenceDeclaration> getDeclaredPropertyReferences()

Returns all declared property references in this model.

Returns:

all declared property references, or an empty list if there are no elements

Since:

0.9.2

createPropertySymbol

public PropertySymbol createPropertySymbol(AstSimpleName propertyName)

Creates and returns a new property symbol in this model.

Parameters:

propertyName - the name of target property

Returns:

the created symbol

Throws:

IllegalArgumentException - if some parameters were null

getTrait

public <T extends Trait<T>> T getTrait(Class<T> kind)

Description copied from interface: Declaration

Returns the specified trait of this declaration.

Specified by:

getTrait in interface Declaration

Type Parameters:

T - type of trait

Parameters:

kind - the kind of trait

Returns:

the trait, or null if not put

putTrait

public <T extends Trait<T>> void putTrait(Class<T> kind,
                                          T trait)

Description copied from interface: Declaration

Puts a trait into this declaration.

Specified by:

putTrait in interface Declaration

Type Parameters:

T - type of trait

Parameters:

kind - the kind of trait

trait - the traits to put, or null to remove

toString

public String toString()

Overrides:

toString in class Object