org.mule.runtime.api.metadata.resolving

Interface QueryEntityResolver

All Superinterfaces:

NamedTypeResolver

public interface QueryEntityResolver
extends NamedTypeResolver

Handles the dynamic resolution of all the available entities MetadataKeys when building a DSQL query and the dynamic MetadataType resolution each of those entities.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Set<MetadataKey>	getEntityKeys(MetadataContext context) Resolves the Set of entities that can be queried in the DSQL operation that uses this resolver, representing them as a Set of MetadataKey.
org.mule.metadata.api.model.MetadataType	getEntityMetadata(MetadataContext context, String key) Given a String representing the id of one of the entities, resolves the corresponding entity MetadataType,
default String	getResolverName() This is the name of the TypeResolver.

Methods inherited from interface org.mule.runtime.api.metadata.resolving.NamedTypeResolver

getCategoryName

Method Detail

getResolverName

default String getResolverName()

This is the name of the TypeResolver. It should not be repeated among InputTypeResolver and OutputTypeResolver which are used together.

Specified by:

getResolverName in interface NamedTypeResolver

Returns:

name of the resolver

getEntityKeys

Set<MetadataKey> getEntityKeys(MetadataContext context)
                        throws MetadataResolvingException,
                               ConnectionException

Resolves the Set of entities that can be queried in the DSQL operation that uses this resolver, representing them as a Set of MetadataKey.

Parameters:

context - MetadataContext of the Metadata resolution

Returns:

A set with all the MetadataKey representing all the available entities that can be queried.

Throws:

MetadataResolvingException - if an error occurs during the MetadataKey building. See FailureCode for possible MetadataResolvingException reasons

ConnectionException - if an error occurs when using the connection provided by the MetadataContext

getEntityMetadata

org.mule.metadata.api.model.MetadataType getEntityMetadata(MetadataContext context,
                                                           String key)
                                                    throws MetadataResolvingException,
                                                           ConnectionException

Given a String representing the id of one of the entities, resolves the corresponding entity MetadataType,

Parameters:

context - MetadataContext of the Metadata resolution

key - a String representing the type which's structure has to be resolved

Returns:

MetadataType from the given

Throws:

MetadataResolvingException - if an error occurs during the MetadataType building. See FailureCode for possible MetadataResolvingException reasons

ConnectionException - if an error occurs when using the connection provided by the MetadataContext