org.mule.runtime.extension.api.annotation.param

Annotation Type Query

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
public @interface Query

This annotation is meant to be applied to support easy query building by using DataSense Query Language, DSQL.

When an ComponentModel parameter is annotated with this annotation, you can assume your query parameter has been translated to native query language using the specified QueryTranslator.

Since:

1.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends org.mule.runtime.api.metadata.resolving.QueryEntityResolver>	entityResolver A QueryEntityResolver implementation used to resolve metadata about the entities that can be queried using DSQL.
Class<? extends QueryTranslator>	translator A QueryTranslator implementation used to translate a query from DSQL to the Native Query Language

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends org.mule.runtime.api.metadata.resolving.OutputTypeResolver<String>>	nativeOutputResolver A OutputTypeResolver that receives a String with the query when it's written in the Native Query Language.

Element Detail

translator

public abstract Class<? extends QueryTranslator> translator

A QueryTranslator implementation used to translate a query from DSQL to the Native Query Language

entityResolver

public abstract Class<? extends org.mule.runtime.api.metadata.resolving.QueryEntityResolver> entityResolver

A QueryEntityResolver implementation used to resolve metadata about the entities that can be queried using DSQL.

nativeOutputResolver

public abstract Class<? extends org.mule.runtime.api.metadata.resolving.OutputTypeResolver<String>> nativeOutputResolver

A OutputTypeResolver that receives a String with the query when it's written in the Native Query Language. This way the developer can resolved metadata for complex cases when DSQL is not used.

For default the NullQueryMetadataResolver implementation is used, returning an empty set of entities and a void metadata type as the entity structure.

Default:

org.mule.runtime.extension.api.metadata.NullQueryMetadataResolver.class