JexlInspectionResultProcessor (Metawidget API Documentation)

java.lang.Object
- org.metawidget.inspectionresultprocessor.impl.BaseInspectionResultProcessor<M>
- - org.metawidget.inspectionresultprocessor.commons.jexl.JexlInspectionResultProcessor<M>

All Implemented Interfaces:

Immutable, DomInspectionResultProcessor<Element,M>, InspectionResultProcessor<M>
```
public class JexlInspectionResultProcessor<M>
extends BaseInspectionResultProcessor<M>
```
Processes the inspection result and evaluates any expressions of the form ${...} using JEXL.

Author:

Richard Kennard

Constructor Summary

Constructors
Constructor and Description
`JexlInspectionResultProcessor()` Constructs a FacesInspectionResultProcessor.
`JexlInspectionResultProcessor(JexlInspectionResultProcessorConfig config)` Constructs a FacesInspectionResultProcessor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected org.apache.commons.jexl2.JexlContext`	`createContext(M metawidget)` Prepare the JexlContext.
`protected org.apache.commons.jexl2.JexlEngine`	`createEngine()` Prepare the JexlEngine.
`protected void`	`processAttributes(Map<String,String> attributes, M metawidget)` Process the given attributes (which may belong to either entity, property or action).
`protected void`	`processEntity(Map<String,String> attributes, M metawidget, Object toInspect, String type, String... names)` Defers to `processAttributes` by default.
`Element`	`processInspectionResultAsDom(Element inspectionResult, M metawidget, Object toInspect, String type, String... names)` Optimized verison of `processInspectionResult` that avoids DOM serialization/deserialization.
`protected void`	`processTraits(Element entity, M metawidget, Object toInspect, String type, String... names)` Process the traits of the given entity.

Methods inherited from class org.metawidget.inspectionresultprocessor.impl.BaseInspectionResultProcessor
processInspectionResult, processTrait

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JexlInspectionResultProcessor
```
public JexlInspectionResultProcessor()
```
    Constructs a FacesInspectionResultProcessor.
  - JexlInspectionResultProcessor
```
public JexlInspectionResultProcessor(JexlInspectionResultProcessorConfig config)
```
    Constructs a FacesInspectionResultProcessor.
- Method Detail
  - processInspectionResultAsDom
```
public Element processInspectionResultAsDom(Element inspectionResult,
                                   M metawidget,
                                   Object toInspect,
                                   String type,
                                   String... names)
```
    Description copied from interface: DomInspectionResultProcessor
    
    Optimized verison of processInspectionResult that avoids DOM serialization/deserialization.
    
    Specified by:
    
    processInspectionResultAsDom in interface DomInspectionResultProcessor<Element,M>
    
    Overrides:
    
    processInspectionResultAsDom in class BaseInspectionResultProcessor<M>
    
    Parameters:
    inspectionResult - the inspection result to process. Never null
  - processEntity
```
protected void processEntity(Map<String,String> attributes,
                 M metawidget,
                 Object toInspect,
                 String type,
                 String... names)
```
    Description copied from class: BaseInspectionResultProcessor
    
    Defers to processAttributes by default.
    
    Overrides:
    
    processEntity in class BaseInspectionResultProcessor<M>
    
    Parameters:
    attributes - attributes of the entity being processed. Subclasses can modify this Map to modify the attributes
    metawidget - the parent Metawidget. Never null. May be useful to help processing
    toInspect - the Object being inspected. May be useful to help processing
    type - the type being inspected. May be useful to help processing
    names - the names being inspected. May be useful to help processing
  - processTraits
```
protected void processTraits(Element entity,
                 M metawidget,
                 Object toInspect,
                 String type,
                 String... names)
```
    Description copied from class: BaseInspectionResultProcessor
    
    Process the traits of the given entity. Subclasses may find it useful to override this method to perform before/after setup around trait processing (for example, establishing an EL context).
    
    Overrides:
    
    processTraits in class BaseInspectionResultProcessor<M>
    
    Parameters:
    entity - the DOM Element representing the entity that contains the traits
    metawidget - the parent Metawidget. Never null. May be useful to help processing
    toInspect - the Object being inspected. May be useful to help processing
    type - the type being inspected. May be useful to help processing
    names - the names being inspected. May be useful to help processing
  - processAttributes
```
protected void processAttributes(Map<String,String> attributes,
                     M metawidget)
```
    Description copied from class: BaseInspectionResultProcessor
    
    Process the given attributes (which may belong to either entity, property or action).
    Does nothing by default.
    
    Overrides:
    
    processAttributes in class BaseInspectionResultProcessor<M>
    
    Parameters:
    attributes - attributes of the trait being processed. Subclasses can modify this Map to modify the attributes
    metawidget - the parent Metawidget. Never null. May be useful to help processing
  - createEngine
```
protected org.apache.commons.jexl2.JexlEngine createEngine()
```
    Prepare the JexlEngine.
  - createContext
```
protected org.apache.commons.jexl2.JexlContext createContext(M metawidget)
```
    Prepare the JexlContext. This includes injecting any Objects passed by JexlInspectionResultProcessor.setInject.
    Subclasses can override this method to control what is available in the context.
    
    Parameters:
    metawidget - the parent Metawidget. Never null. May be useful for finding the object to add to the context

Class JexlInspectionResultProcessor<M>

Constructor Summary

Method Summary

Methods inherited from class org.metawidget.inspectionresultprocessor.impl.BaseInspectionResultProcessor

Methods inherited from class java.lang.Object

Constructor Detail

JexlInspectionResultProcessor

JexlInspectionResultProcessor

Method Detail

processInspectionResultAsDom

processEntity

processTraits

processAttributes

createEngine

createContext