API Documentation

Last updated: Feb 1st, 2018

TEntityMetaLevelDependency

TEntityMetaLevelDependency is a Trait adding to an entity the possibility to use meta-descriptions to execute containment tree exploration and scope queries.

Containment tree exploration

Method Result
#allChildren Return the receiver's children in the containment tree of the model, including the children's children recursively.
#allChildrenTypes Return all the possible children types of the receiver, including the possible type of the children's children recursively.
#allParents Return the receiver's parents in the containment tree of the model, including the parents' parents recursively.
#allParentTypes Return all the possible parents types of the receiver, including the possible type of the parents' parents recursively.
#children Return the receiver's children in the containment tree of the model. This method is not recursive.
#childrenSelectors Return the selectors applicable to the receiver that can return some of the receiver's children.
#childrenTypes Return the possible children types of the receiver. This method is not recursive.
#parents Return the receiver's parents in the containment tree of the model. This method is not recursive.
#parentSelectors Return the selectors applicable to the receiver that can return some of the receiver's parents.
#parentTypes Return the possible parents types of the receiver. This method is not recursive.

Scopes

Method Parameter Result
#atScope: Famix class defining the scope of the query Return the entities of the parameter's kind up in the containment tree of the model compared to the receiver.
#toScope: Famix class defining the scope of the query Return the entities of the parameter's kind down in the containment tree of the model compared to the receiver.
#withScope: Famix class defining the scope of the query Return the entities of the parameter's kind up and down in the containment tree of the model compared to the receiver.

TDependencyQuery

TDependencyQuery is a Trait adding to an entity the possibility to use meta-descriptions to execute navigation queries.

Method Parameters Result
#query:with:

A symbol #in or #out defining the query's direction

A Famix association class defining the associations to gather

Return all the incoming or outgoing associations, depending on the symbol given as parameter, of the Famix association class for the receiver and its children.
#queryAll: A symbol #in or #out defining the query's direction Return all the incoming or outgoing associations, depending on the symbol given as parameter, of the receiver or its children.
#queryAllIncoming Return all the incoming associations of the receiver and its children.
#queryAllLocal: A symbol #in or #out defining the query's direction Return all the incoming or outgoing associations, depending on the symbol given as parameter, of the receiver. This method differ from #queryAll: in the fact that it will not check the associations of the receiver's children.
#queryAllLocalIncoming Return all the incoming associations of the receiver. This method differ from #queryAllIncoming in the fact that it will not check the associations of the receiver's children.
#queryAllLocalOutgoing Return all the outgoing associations of the receiver. This method differ from #queryAllOutgoing in the fact that it will not check the associations of the receiver's children.
#queryAllOutgoing Return all the outgoing associations of the receiver and its children.
#queryIncoming: A Famix association class defining the associations to gather Return all the incoming associations of the Famix association class for the receiver and its children.
#queryLocal:with:

A symbol #in or #out defining the query's direction

A Famix association class defining the associations to gather

Return all the incoming or outgoing associations, depending on the symbol given as parameter, of the Famix association class for the receiver. This method differ from #query:with: in the fact that it will not check the associations of the receiver's children.
#queryLocalIncoming: A Famix association class defining the associations to gather Return all the incoming associations of the Famix association class for the receiver. This method differ from #queryIncoming: in the fact that it will not check the associations of the receiver's children.
#queryLocalOutgoing: A Famix association class defining the associations to gather Return all the outgoing associations of the Famix association class for the receiver. This method differ from #queryOutgoing: in the fact that it will not check the associations of the receiver's children.
#queryOutgoing: A Famix association class defining the associations to gather Return all the outgoing associations of the Famix association class for the receiver and its children.

TAssociationMetaLevelDependency

TAssociationMetaLevelDependency is a Trait adding to an association the possibility to use meta-descriptions to get some informations.

Method Result
#dependencyFM3PropertyDescription Return all the meta-properties defining a relation between entities (source/target).
#sourceTypes Return the types possible as source of the association.
#targetTypes Return the types possible as target of the association.

TDependencyQueryResult

TDependencyQueryResult is a Trait adding to MooseQueryResult some behaviour on navigation query results.

Method Parameters Result
#atScope: Famix class defining the scope of the query Return the entities of the parameter's kind up in the containment tree of the model compared to the association opposites relative to the navigation query receiver.
#opposites Return the opposite entities of the query result's associations compared to the receiver of the original query.
#rejectDependencies: A conditional block Reject the dependencies matching the block as parameter.
#selectDependencies: A conditional block Reject the dependencies not matching the block as parameter.
#toScope: Famix class defining the scope of the query Return the entities of the parameter's kind down in the containment tree of the model compared to the association opposites relative to the navigation query receiver.
#withScope: Famix class defining the scope of the query Return the entities of the parameter's kind up and down in the containment tree of the model compared to the association opposites relative to the navigation query receiver.
#withoutSelfLoops Reject all associations whose opposite is contained in the original query's receiver.