org.mule.runtime.api.metadata

Interface ExpressionLanguageMetadataService

All Superinterfaces:

NamedObject, Service, SplashMessageProvider

public interface ExpressionLanguageMetadataService
extends Service

This service provides metadata interaction with the underlying expression language.

Since:

1.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ExpressionLanguageMetadataService.MessageCallback Callback from the resolver
static class	ExpressionLanguageMetadataService.MessageLocation Represents a message location
static class	ExpressionLanguageMetadataService.MessagePosition A position with the line , column and offset in a document
static interface	ExpressionLanguageMetadataService.MetadataTypeSerializer Serialize MetadataTypes in the type system of the given expression language

Method Summary

Modifier and Type	Method and Description
org.mule.metadata.api.TypeLoader	createTypeLoader(String content, org.mule.metadata.api.model.MetadataFormat metadataFormat) Returns a new type loader.
void	getInputType(String expression, org.mule.metadata.api.model.MetadataType output, org.mule.metadata.message.api.MuleEventMetadataTypeBuilder builder, ExpressionLanguageMetadataService.MessageCallback callback) Infers the expected input mule event type MuleEventMetadataType for specified output type with the given script.
org.mule.metadata.api.model.MetadataType	getMetadataFromSample(InputStream sample, Map<String,Object> readerProperties, String mimeType) Infers the metadata out of a sample data
org.mule.metadata.api.model.MetadataType	getOutputType(org.mule.metadata.message.api.el.TypeBindings typeBindings, String expression, ExpressionLanguageMetadataService.MessageCallback callback) Returns the result type expression when invoked with the given TypeBindings.
org.mule.metadata.api.model.MetadataType	getOutputType(org.mule.metadata.message.api.el.TypeBindings typeBindings, String expression, String outputMimeType, ExpressionLanguageMetadataService.MessageCallback callback) Returns the result type expression when invoked with the given TypeBindings.
ExpressionLanguageMetadataService.MetadataTypeSerializer	getTypeSerializer() Returns the type serializer
org.mule.metadata.api.model.MetadataType	intersect(List<org.mule.metadata.api.model.MetadataType> metadataTypes) Intersects all the specified types into one type.
boolean	isAssignable(org.mule.metadata.api.model.MetadataType assignment, org.mule.metadata.api.model.MetadataType expected, ExpressionLanguageMetadataService.MessageCallback callback) Returns if the assignment type can be assigned to the expected type
Map<String,org.mule.metadata.api.model.MetadataType>	resolveAssignment(org.mule.metadata.api.model.MetadataType assignment, org.mule.metadata.api.model.MetadataType expected, ExpressionLanguageMetadataService.MessageCallback callback) Returns the substitution that needs to be done in order for this two types can be assigned
org.mule.metadata.api.model.MetadataType	substitute(org.mule.metadata.api.model.MetadataType assignment, Map<String,org.mule.metadata.api.model.MetadataType> substitution) Returns a new type with the substitution being applied
org.mule.metadata.api.model.MetadataType	unify(List<org.mule.metadata.api.model.MetadataType> metadataTypes) Unify all the specified types into one type.

Methods inherited from interface org.mule.runtime.api.service.Service

getContractName, getSplashMessage

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Method Detail

getInputType

void getInputType(String expression,
                  org.mule.metadata.api.model.MetadataType output,
                  org.mule.metadata.message.api.MuleEventMetadataTypeBuilder builder,
                  ExpressionLanguageMetadataService.MessageCallback callback)

Infers the expected input mule event type MuleEventMetadataType for specified output type with the given script.

Parameters:

expression - The scripting text.

output - The expected output type

builder - The builder to be used to build the event type

callback - The callback

getOutputType

org.mule.metadata.api.model.MetadataType getOutputType(org.mule.metadata.message.api.el.TypeBindings typeBindings,
                                                       String expression,
                                                       ExpressionLanguageMetadataService.MessageCallback callback)

Returns the result type expression when invoked with the given TypeBindings.

Parameters:

typeBindings - The script bindings

expression - The scripting text.

callback - The callback

Returns:

The return type of the expression.

getOutputType

org.mule.metadata.api.model.MetadataType getOutputType(org.mule.metadata.message.api.el.TypeBindings typeBindings,
                                                       String expression,
                                                       String outputMimeType,
                                                       ExpressionLanguageMetadataService.MessageCallback callback)

Returns the result type expression when invoked with the given TypeBindings.

Parameters:

typeBindings - The script bindings

expression - The scripting text.

outputMimeType - The output mimeType of the expression

callback - The callback

Returns:

The return type of the expression.

getMetadataFromSample

org.mule.metadata.api.model.MetadataType getMetadataFromSample(InputStream sample,
                                                               Map<String,Object> readerProperties,
                                                               String mimeType)

Infers the metadata out of a sample data

Parameters:

sample - The sample data to be use

readerProperties - The configuration properties to read the sample data

mimeType - The mimeType of the sample data

Returns:

The infered MetadataType

isAssignable

boolean isAssignable(org.mule.metadata.api.model.MetadataType assignment,
                     org.mule.metadata.api.model.MetadataType expected,
                     ExpressionLanguageMetadataService.MessageCallback callback)

Returns if the assignment type can be assigned to the expected type

Parameters:

assignment - The type to be assigned

expected - The expected type

callback - Callback for error messages. All the reasons of why it was not able to assign

Returns:

True if it can be assign

resolveAssignment

Map<String,org.mule.metadata.api.model.MetadataType> resolveAssignment(org.mule.metadata.api.model.MetadataType assignment,
                                                                       org.mule.metadata.api.model.MetadataType expected,
                                                                       ExpressionLanguageMetadataService.MessageCallback callback)

Returns the substitution that needs to be done in order for this two types can be assigned

Parameters:

assignment - The assignment type

expected - The expected type

callback - The callback for errors and warnings

Returns:

The substitution

substitute

org.mule.metadata.api.model.MetadataType substitute(org.mule.metadata.api.model.MetadataType assignment,
                                                    Map<String,org.mule.metadata.api.model.MetadataType> substitution)

Returns a new type with the substitution being applied

Parameters:

assignment - The type to be substituted

substitution - The substitution

Returns:

The new type

unify

org.mule.metadata.api.model.MetadataType unify(List<org.mule.metadata.api.model.MetadataType> metadataTypes)

Unify all the specified types into one type. It will remove duplications and return a UnionType only if required

Parameters:

metadataTypes - The types to be unified

Returns:

The new type

intersect

org.mule.metadata.api.model.MetadataType intersect(List<org.mule.metadata.api.model.MetadataType> metadataTypes)

Intersects all the specified types into one type.

Parameters:

metadataTypes - The types to be intersected

Returns:

The new type

getTypeSerializer

ExpressionLanguageMetadataService.MetadataTypeSerializer getTypeSerializer()

Returns the type serializer

Returns:

the type serializer

createTypeLoader

org.mule.metadata.api.TypeLoader createTypeLoader(String content,
                                                  org.mule.metadata.api.model.MetadataFormat metadataFormat)

Returns a new type loader. Loads a script that contains a collections of types serialized with the language syntax.

Parameters:

content - The script

metadataFormat - The format that will be used for the loaded types

Returns:

The type loader