org.eclipse.emf.facet.efacet
Interface Query

All Known Subinterfaces:

JavaQuery, Literal, TypedElementRef

public interface Query

A representation of the model object 'Query'. A query is the abstract representation of the concept query. This class has to be sub-classed for each existing query language (Java, OCL,...)

The following features are supported:

• Scope
• Has Side Effect
• Can Be Cached
• Parameters

See Also:

EFacetPackage.getQuery()

Generated:

Model:

abstract="true"

Method Summary

	getParameters() Returns the value of the 'Parameters' containment reference list.
EClass	getScope() Returns the value of the 'Scope' reference.
boolean	isCanBeCached() Returns the value of the 'Can Be Cached' attribute.
boolean	isHasSideEffect() Returns the value of the 'Has Side Effect' attribute.
void	setCanBeCached(boolean value) Sets the value of the 'Can Be Cached' attribute.
void	setHasSideEffect(boolean value) Sets the value of the 'Has Side Effect' attribute.
void	setScope(EClass value) Sets the value of the 'Scope' reference.

Method Detail

getScope

EClass getScope()

Returns the value of the 'Scope' reference. The query's scope defines the type of model elements a query can be applied on.

Returns:

the value of the 'Scope' reference.

See Also:

setScope(EClass), EFacetPackage.getQuery_Scope()

Generated:

Model:

setScope

void setScope(EClass value)

Sets the value of the 'Scope' reference.

Parameters:

value - the new value of the 'Scope' reference.

See Also:

getScope()

Generated:

isHasSideEffect

boolean isHasSideEffect()

Returns the value of the 'Has Side Effect' attribute. The default value is "false". This attribute has to be true if the query modify the model.

Returns:

the value of the 'Has Side Effect' attribute.

See Also:

setHasSideEffect(boolean), EFacetPackage.getQuery_HasSideEffect()

Generated:

Model:

default="false"

setHasSideEffect

void setHasSideEffect(boolean value)

Sets the value of the 'Has Side Effect' attribute.

Parameters:

value - the new value of the 'Has Side Effect' attribute.

See Also:

isHasSideEffect()

Generated:

isCanBeCached

boolean isCanBeCached()

Returns the value of the 'Can Be Cached' attribute. The default value is "false". The attribute "canBeCached" has to be true if calling a query on the same model element will always return the same result.

Returns:

the value of the 'Can Be Cached' attribute.

See Also:

setCanBeCached(boolean), EFacetPackage.getQuery_CanBeCached()

Generated:

Model:

default="false"

setCanBeCached

void setCanBeCached(boolean value)

Sets the value of the 'Can Be Cached' attribute.

Parameters:

value - the new value of the 'Can Be Cached' attribute.

See Also:

isCanBeCached()

Generated:

getParameters

 getParameters()

Returns the value of the 'Parameters' containment reference list. The list contents are of type Parameter.

If the meaning of the 'Parameters' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Parameters' containment reference list.

See Also:

EFacetPackage.getQuery_Parameters()

Generated:

Model:

containment="true"