JsonSchemaMappingProcessor (Metawidget API Documentation)

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

All Implemented Interfaces:

Immutable, DomInspectionResultProcessor<Element,M>, InspectionResultProcessor<M>
```
public class JsonSchemaMappingProcessor<M>
extends BaseInspectionResultProcessor<M>
```
InspectionResultProcessor to map attribute names from inspection-result.xsd to JSON Schema, ready for XmlUtils.inspectionResultToJsonSchema.
Consider using in conjunction with JsonTypeMappingProcessor.

Author:

Richard Kennard

Constructor Summary

Constructors
Constructor and Description

JsonSchemaMappingProcessor()

JsonSchemaMappingProcessor(JsonSchemaMappingProcessorConfig config)

Constructors
Constructor and Description
`JsonSchemaMappingProcessor()`
`JsonSchemaMappingProcessor(JsonSchemaMappingProcessorConfig config)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`mapAttributes(Element element)` Map common attribute names from `inspection-result.xsd` to JSON Schema.
`protected void`	`processTraits(Element entity, M metawidget, Object toInspect, String type, String... names)` Process the traits of the given entity.
`protected void`	`removeAttributes(Element element)` Remove specified attributes from the JSON Schema output.
`protected boolean`	`shouldRemove(Element element)` Returns true if the given element should be removed from the returned JSON schema.

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

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

- Constructor Detail
  - JsonSchemaMappingProcessor
```
public JsonSchemaMappingProcessor()
```
  - JsonSchemaMappingProcessor
```
public JsonSchemaMappingProcessor(JsonSchemaMappingProcessorConfig config)
```
- Method Detail
  - 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
  - shouldRemove
```
protected boolean shouldRemove(Element element)
```
    Returns true if the given element should be removed from the returned JSON schema. By default, returns true if hidden equals true.
  - mapAttributes
```
protected void mapAttributes(Element element)
```
    Map common attribute names from inspection-result.xsd to JSON Schema.
  - removeAttributes
```
protected void removeAttributes(Element element)
```
    Remove specified attributes from the JSON Schema output.

Class JsonSchemaMappingProcessor<M>

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

JsonSchemaMappingProcessor

JsonSchemaMappingProcessor

Method Detail

processTraits

shouldRemove

mapAttributes

removeAttributes