org.nuxeo.binary.metadata.api

Interface BinaryMetadataService

All Known Implementing Classes:

BinaryMetadataServiceImpl

public interface BinaryMetadataService

Read/Write binary metadata services.

Since:

7.1

Method Summary

Modifier and Type	Method and Description
void	handleSyncUpdate(DocumentModel doc) Handle document and blob updates according to following rules in an event context: - Define if rule should be executed in async or sync mode.
void	handleUpdate(List<MetadataMappingDescriptor> syncMappingDescriptors, DocumentModel doc) Handle document and blob updates according to following rules in an event context: - Define if rule should be executed in async or sync mode.
Map<String,Object>	readMetadata(Blob blob, boolean ignorePrefix) Read and return metadata from a given binary with Nuxeo default processor.
Map<String,Object>	readMetadata(Blob blob, List<String> metadataNames, boolean ignorePrefix) Read and return metadata from a given binary and a given metadata list with Nuxeo default processor.
Map<String,Object>	readMetadata(String processorName, Blob blob, boolean ignorePrefix) Read and return metadata from a given binary with a given processor.
Map<String,Object>	readMetadata(String processorName, Blob blob, List<String> metadataNames, boolean ignorePrefix) Read and return metadata from a given binary and a given metadata list with a given processor.
Blob	writeMetadata(Blob blob, Map<String,Object> metadata, boolean ignorePrefix) Write given metadata into a given binary with a Nuxeo default processor.
Blob	writeMetadata(Blob blob, String mappingDescriptorId, DocumentModel doc) Write given metadata mapping id into a given binary with a Nuxeo default processor.
void	writeMetadata(DocumentModel doc) Write metadata (from a binary) into a given Nuxeo Document according to the metadata mapping and rules contributions.
void	writeMetadata(DocumentModel doc, String mappingDescriptorId) Apply metadata mapping and override document properties according to the contribution.
Blob	writeMetadata(String processorName, Blob blob, Map<String,Object> metadata, boolean ignorePrefix) Write given metadata into a given binary with a given processor.
Blob	writeMetadata(String processorName, Blob blob, String mappingDescriptorId, DocumentModel doc) Write given metadata mapping id into a given binary with a Nuxeo default processor.

Method Detail

readMetadata

Map<String,Object> readMetadata(String processorName,
                                Blob blob,
                                List<String> metadataNames,
                                boolean ignorePrefix)

Read and return metadata from a given binary and a given metadata list with a given processor.

Parameters:

processorName - Name of the contributed processor to run.

blob - Binary which metadata are read.

metadataNames - Metadata list to extract from the binary.

ignorePrefix - Since 7.3

Returns:

Extracted metadata.

readMetadata

Map<String,Object> readMetadata(Blob blob,
                                List<String> metadataNames,
                                boolean ignorePrefix)

Read and return metadata from a given binary and a given metadata list with Nuxeo default processor.

Parameters:

blob - Binary which metadata are read.

metadataNames - Metadata list to extract from the binary.

ignorePrefix - Since 7.3

Returns:

Extracted metadata.

readMetadata

Map<String,Object> readMetadata(Blob blob,
                                boolean ignorePrefix)

Read and return metadata from a given binary with Nuxeo default processor.

Parameters:

blob - Binary which metadata are read.

ignorePrefix - Since 7.3

Returns:

Extracted metadata.

readMetadata

Map<String,Object> readMetadata(String processorName,
                                Blob blob,
                                boolean ignorePrefix)

Read and return metadata from a given binary with a given processor.

Parameters:

processorName - Name of the contributed processor to run.

blob - Binary which metadata are read.

ignorePrefix - Since 7.3

Returns:

Extracted metadata.

writeMetadata

Blob writeMetadata(String processorName,
                   Blob blob,
                   Map<String,Object> metadata,
                   boolean ignorePrefix)

Write given metadata into a given binary with a given processor.

Parameters:

processorName - Name of the contributed processor to run.

blob - Binary which metadata are written.

metadata - Injected metadata.

ignorePrefix - Since 7.3

Returns:

the updated blob, or null if there was an error (since 7.4)

writeMetadata

Blob writeMetadata(Blob blob,
                   Map<String,Object> metadata,
                   boolean ignorePrefix)

Write given metadata into a given binary with a Nuxeo default processor.

Parameters:

blob - Binary which metadata are written.

metadata - Injected metadata.

ignorePrefix - Since 7.3

Returns:

the updated blob, or null if there was an error (since 7.4)

writeMetadata

Blob writeMetadata(String processorName,
                   Blob blob,
                   String mappingDescriptorId,
                   DocumentModel doc)

Write given metadata mapping id into a given binary with a Nuxeo default processor.

Parameters:

processorName - Name of the contributed processor to run.

blob - Binary which metadata are written.

mappingDescriptorId - The metadata mapping to apply on the document.

doc - Document from properties will be read.

Returns:

the updated blob, or null if there was an error (since 7.4)

writeMetadata

Blob writeMetadata(Blob blob,
                   String mappingDescriptorId,
                   DocumentModel doc)

Write given metadata mapping id into a given binary with a Nuxeo default processor.

Parameters:

blob - Binary which metadata are written.

mappingDescriptorId - The metadata mapping to apply on the document.

doc - Document from properties will be read.

Returns:

the updated blob, or null if there was an error (since 7.4)

writeMetadata

void writeMetadata(DocumentModel doc)

Write metadata (from a binary) into a given Nuxeo Document according to the metadata mapping and rules contributions.

The document is not saved in the session, it's up to the caller to deal with this.

Parameters:

doc - Nuxeo Document which metadata are written.

writeMetadata

void writeMetadata(DocumentModel doc,
                   String mappingDescriptorId)

Apply metadata mapping and override document properties according to the contribution.

The document is not saved in the session, it's up to the caller to deal with this.

Parameters:

doc - The input document.

mappingDescriptorId - The metadata mapping to apply on the document.

handleUpdate

void handleUpdate(List<MetadataMappingDescriptor> syncMappingDescriptors,
                  DocumentModel doc)

Handle document and blob updates according to following rules in an event context: - Define if rule should be executed in async or sync mode. - If Blob dirty and document metadata dirty, write metadata from doc to Blob. - If Blob dirty and document metadata not dirty, write metadata from Blob to doc. - If Blob not dirty and document metadata dirty, write metadata from doc to Blob.

The document is not saved in the session, it's up to the caller to deal with this.

handleSyncUpdate

void handleSyncUpdate(DocumentModel doc)

Handle document and blob updates according to following rules in an event context: - Define if rule should be executed in async or sync mode. - If Blob dirty and document metadata dirty, write metadata from doc to Blob. - If Blob dirty and document metadata not dirty, write metadata from Blob to doc. - If Blob not dirty and document metadata dirty, write metadata from doc to Blob.

The document is not saved in the session, it's up to the caller to deal with this.