BaseInspectionResultProcessor (Metawidget API Documentation)

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

All Implemented Interfaces:

Immutable, DomInspectionResultProcessor<Element,M>, InspectionResultProcessor<M>

Direct Known Subclasses:

ComesAfterInspectionResultProcessor, FacesInspectionResultProcessor, JexlInspectionResultProcessor, JsonSchemaMappingProcessor, JspInspectionResultProcessor, TypeMappingInspectionResultProcessor
```
public abstract class BaseInspectionResultProcessor<M>
extends Object
implements DomInspectionResultProcessor<Element,M>
```
Convenience implementation for InspectionResultProcessors.

Author:

Richard Kennard

Constructor Summary

Constructors
Constructor and Description

BaseInspectionResultProcessor()

Constructors
Constructor and Description
`BaseInspectionResultProcessor()`

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`String`	`processInspectionResult(String inspectionResult, M metawidget, Object toInspect, String type, String... names)` Process the given inspection result in context of the given Metawidget.
`Element`	`processInspectionResultAsDom(Element inspectionResult, M metawidget, Object toInspect, String type, String... names)` Optimized verison of `processInspectionResult` that avoids DOM serialization/deserialization.
`protected void`	`processTrait(Map<String,String> attributes, M metawidget)` Defers to `processAttributes` by default.
`protected void`	`processTraits(Element entity, M metawidget, Object toInspect, String type, String... names)` Process the traits of the given entity.

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

- Constructor Detail
  - BaseInspectionResultProcessor
```
public BaseInspectionResultProcessor()
```
- Method Detail
  - processInspectionResult
```
public final String processInspectionResult(String inspectionResult,
                             M metawidget,
                             Object toInspect,
                             String type,
                             String... names)
```
    Process the given inspection result in context of the given Metawidget.
    This method is marked final because most Metawidget implementations will call processInspectionResultAsDom directly instead. So subclasses need to override processInspectionResultAsDom, not processInspectionResult.
    
    Specified by:
    
    processInspectionResult in interface InspectionResultProcessor<M>
    
    Parameters:
    inspectionResult - the inspection result to process, as XML conforming to inspection-result-1.0.xsd. Never null
    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
    
    Returns:
    the processed inspection result, as XML conforming to inspection-result-1.0.xsd. Can be null if the InspectionResultProcessor wishes to cancel the inspection
  - 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>
    
    Parameters:
    inspectionResult - the inspection result to process. Never null
  - processTraits
```
protected void processTraits(Element entity,
                 M metawidget,
                 Object toInspect,
                 String type,
                 String... names)
```
    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).
    
    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
  - processEntity
```
protected void processEntity(Map<String,String> attributes,
                 M metawidget,
                 Object toInspect,
                 String type,
                 String... names)
```
    Defers to processAttributes by default.
    
    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
  - processTrait
```
protected void processTrait(Map<String,String> attributes,
                M metawidget)
```
    Defers to processAttributes by default.
    
    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
    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)
```
    Process the given attributes (which may belong to either entity, property or action).
    Does nothing by default.
    
    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

Class BaseInspectionResultProcessor<M>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseInspectionResultProcessor

Method Detail

processInspectionResult

processInspectionResultAsDom

processTraits

processEntity

processTrait

processAttributes