org.clafer.ast

Class AstModel

java.lang.Object

org.clafer.ast.AstClafer

org.clafer.ast.AstConcreteClafer

org.clafer.ast.AstModel

All Implemented Interfaces:

AstVar

public class AstModel
extends AstConcreteClafer

The Clafer model. Also acts as the implicit "root" Clafer which nests above the top most Clafers.

For example:

 abstract Feature
     Cost -> integer
 Database : Feature
 

Although the model is written syntactically like above, its representation internally is more like:

 #root#
     abstract Feature
         Cost -> integer
     Database : Feature
 

#root# is represented by this class.

Author:

jimmy

Field Summary

Fields inherited from class org.clafer.ast.AstClafer

claferClafer

Method Summary

Methods

Modifier and Type	Method and Description
AstAbstractClafer	addAbstract(String name) Add a new abstract Clafer to the model.
AstModel	extending(AstAbstractClafer superClafer) Set the supertype of this Clafer.
List<AstAbstractClafer>	getAbstracts() Returns all the abstract Clafers
AstAbstractClafer	getTypeHierarchyRoot() Returns the type every non-primitive type extends from.
AstModel	refTo(AstClafer targetType) Set this Clafer's reference to target type.
AstModel	refToUnique(AstClafer targetType) Set this Clafer's reference to target type along with a uniqueness constraint.
AstConcreteClafer	withCard(Card card) Set this Clafer's cardinality.
AstModel	withGroupCard(Card groupCard) Set this Clafer's group cardinality.

Methods inherited from class org.clafer.ast.AstConcreteClafer

getCard, getParent, hasParent, withCard, withCard, withGroupCard, withGroupCard

Methods inherited from class org.clafer.ast.AstClafer

addChild, addConstraint, equals, getChildren, getConstraints, getGroupCard, getName, getRef, getSuperClafer, hasChildren, hasConstraints, hashCode, hasRef, hasSuperClafer, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getTypeHierarchyRoot

public AstAbstractClafer getTypeHierarchyRoot()

Returns the type every non-primitive type extends from.

Returns:

the Clafer named "clafer"

getAbstracts

public List<AstAbstractClafer> getAbstracts()

Returns all the abstract Clafers

Returns:

all the abstract Clafers

addAbstract

public AstAbstractClafer addAbstract(String name)

Add a new abstract Clafer to the model. .

Parameters:

name - the name of the abtract Clafer

Returns:

the new abstract Clafer

extending

public AstModel extending(AstAbstractClafer superClafer)

Description copied from class: AstConcreteClafer

Set the supertype of this Clafer.

Overrides:

extending in class AstConcreteClafer

Parameters:

superClafer - the supertype

Returns:

this Clafer

refTo

public AstModel refTo(AstClafer targetType)

Description copied from class: AstConcreteClafer

Set this Clafer's reference to target type.

Overrides:

refTo in class AstConcreteClafer

Parameters:

targetType - the type to refer to

Returns:

this Clafer

refToUnique

public AstModel refToUnique(AstClafer targetType)

Description copied from class: AstConcreteClafer

Set this Clafer's reference to target type along with a uniqueness constraint.

Overrides:

refToUnique in class AstConcreteClafer

Parameters:

targetType - the type to refer to

Returns:

this Clafer

withCard

public AstConcreteClafer withCard(Card card)

Description copied from class: AstConcreteClafer

Set this Clafer's cardinality.

Overrides:

withCard in class AstConcreteClafer

Parameters:

card - the cardinality

Returns:

this Clafer

withGroupCard

public AstModel withGroupCard(Card groupCard)

Description copied from class: AstConcreteClafer

Set this Clafer's group cardinality.

Overrides:

withGroupCard in class AstConcreteClafer

Parameters:

groupCard - the group cardinality

Returns:

this Clafer