org.nuxeo.ecm.core.io.marshallers.json.types

Class SchemaJsonWriter

java.lang.Object

org.nuxeo.ecm.core.io.marshallers.json.AbstractJsonWriter<EntityType>

org.nuxeo.ecm.core.io.marshallers.json.ExtensibleEntityJsonWriter<Schema>

org.nuxeo.ecm.core.io.marshallers.json.types.SchemaJsonWriter

All Implemented Interfaces:

Marshaller<Schema>, Writer<Schema>

@Setup(mode=SINGLETON,
       priority=2000)
public class SchemaJsonWriter
extends ExtensibleEntityJsonWriter<Schema>

Convert Schema to Json.

This marshaller is enrichable: register class implementing AbstractJsonEnricher and managing Schema.

This marshaller is also extensible: extend it and simply override ExtensibleEntityJsonWriter#extend(Schema, JsonWriter).

Format is:

 
 {
   "entity-type":"schema",
   "name": "SCHEMA_NAME",
   "prefix: "SCHEMA_PREFIX",  <- only if there's a prefix
   "fields", {
     "PRIMITIVE_FIELD_LOCAL_NAME": "FIELD_TYPE", <- where field type is {@link Type#getName()} (string, boolean, integer, ...)
     "PRIMITIVE_LIST_LOCAL_NAME": "FIELD_TYPE[]" <- where field type is {@link Type#getName()} (string, boolean, integer, ...)
     "COMPLEX_FIELD_LOCAL_NAME" : {
       "type": "complex",
       "fields": {
         loop the same format
       }
     },
     "COMPLEX_LIST_FIELD_LOCAL_NAME" : {
       "type": "complex[]",
       "fields": {
         loop the same format
       }
     },
     "CONTENT_FIELD": "blob",
     "CONTENT_LIST_FIELD": "blob[]",
     ...
   }
             <-- contextParameters if there are enrichers activated
             <-- additional property provided by extend() method
 }
 

Since:

7.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTITY_TYPE
static String	FETCH_FIELDS

Fields inherited from class org.nuxeo.ecm.core.io.marshallers.json.AbstractJsonWriter

ctx, registry

Constructor Summary

Constructors

Constructor and Description
SchemaJsonWriter()

Method Summary

Modifier and Type	Method and Description
protected void	doWriteField(org.codehaus.jackson.JsonGenerator jg, Field field, String typeValue, boolean extended)
protected void	writeEntityBody(Schema schema, org.codehaus.jackson.JsonGenerator jg) Implement this method to write the entity body.
protected void	writeField(org.codehaus.jackson.JsonGenerator jg, Field field)

Methods inherited from class org.nuxeo.ecm.core.io.marshallers.json.ExtensibleEntityJsonWriter

extend, write

Methods inherited from class org.nuxeo.ecm.core.io.marshallers.json.AbstractJsonWriter

accept, getGenerator, write, writeEntity, writeEntity, writeEntityField

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENTITY_TYPE

public static final String ENTITY_TYPE

See Also:

Constant Field Values

FETCH_FIELDS

public static final String FETCH_FIELDS

Since:

8.10

See Also:

Constant Field Values

Constructor Detail

SchemaJsonWriter

public SchemaJsonWriter()

Method Detail

writeEntityBody

protected void writeEntityBody(Schema schema,
                               org.codehaus.jackson.JsonGenerator jg)
                        throws IOException

Description copied from class: ExtensibleEntityJsonWriter

Implement this method to write the entity body.

Specified by:

writeEntityBody in class ExtensibleEntityJsonWriter<Schema>

Parameters:

schema - The Java entity.

jg - A JsonGenerator ready to write your entity as Json.

Throws:

IOException

writeField

protected void writeField(org.codehaus.jackson.JsonGenerator jg,
                          Field field)
                   throws IOException

Throws:

IOException

doWriteField

protected void doWriteField(org.codehaus.jackson.JsonGenerator jg,
                            Field field,
                            String typeValue,
                            boolean extended)
                     throws IOException

Throws:

IOException

Since:

8.10