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

Class BreadcrumbJsonEnricher

java.lang.Object

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

org.nuxeo.ecm.core.io.marshallers.json.enrichers.AbstractJsonEnricher<DocumentModel>

org.nuxeo.ecm.core.io.marshallers.json.enrichers.BreadcrumbJsonEnricher

All Implemented Interfaces:

Marshaller<Enriched<DocumentModel>>, Writer<Enriched<DocumentModel>>

@Setup(mode=SINGLETON,
       priority=2000)
public class BreadcrumbJsonEnricher
extends AbstractJsonEnricher<DocumentModel>

Enrich DocumentModel Json.

Add document breadcrumb (list of all parents document) as json attachment.

Enable if parameter enrichers-document=breadcrumb is present.

Format is:

 
 {
   "entity-type":"document",
   ...
   "contextParameters": {
     "breadcrumb": { see {@link DocumentModelListJsonWriter} for format }
   }
 }
 

Since:

7.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

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

ENTITY_ENRICHER_NAME

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

ctx, registry

Constructor Summary

Constructors

Constructor and Description
BreadcrumbJsonEnricher()

Method Summary

Modifier and Type	Method and Description
void	write(org.codehaus.jackson.JsonGenerator jg, DocumentModel document) When implementing this method, the provided JsonGenerator expect you write a field name and a field value (or many).

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

accept, write

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

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

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

BreadcrumbJsonEnricher

public BreadcrumbJsonEnricher()

Method Detail

write

public void write(org.codehaus.jackson.JsonGenerator jg,
                  DocumentModel document)
           throws IOException

Description copied from class: AbstractJsonEnricher

When implementing this method, the provided JsonGenerator expect you write a field name and a field value (or many).

Specified by:

write in class AbstractJsonEnricher<DocumentModel>

Parameters:

jg - The JsonGenerator to use.

document - The enriched entity.

Throws:

IOException