org.nuxeo.ecm.core.api.propertiesmapping.impl

Class PropertiesMappingComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.core.api.propertiesmapping.impl.PropertiesMappingComponent

All Implemented Interfaces:

PropertiesMappingService, Adaptable, Component, Extensible, TimestampedService

public class PropertiesMappingComponent
extends DefaultComponent
implements PropertiesMappingService

Service that allows to copy a set of metadata from a source to a target document

Since:

5.6

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	log
static String	MAPPING_EP

Constructor Summary

Constructors

Constructor and Description
PropertiesMappingComponent()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getMapping(String mappingName) Gets a map of xpaths defining properties on the target and source documents
void	mapProperties(CoreSession session, DocumentModel sourceDoc, DocumentModel targetDoc, String mapping) Copies the properties defined by the given xpaths in the mapping from the target to the source document.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.commons.logging.Log log

MAPPING_EP

public static final String MAPPING_EP

See Also:

Constant Field Values

Constructor Detail

PropertiesMappingComponent

public PropertiesMappingComponent()

Method Detail

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

getMapping

public Map<String,String> getMapping(String mappingName)

Description copied from interface: PropertiesMappingService

Gets a map of xpaths defining properties on the target and source documents

Specified by:

getMapping in interface PropertiesMappingService

Returns:

mapProperties

public void mapProperties(CoreSession session,
                 DocumentModel sourceDoc,
                 DocumentModel targetDoc,
                 String mapping)
                   throws ClientException

Description copied from interface: PropertiesMappingService

Copies the properties defined by the given xpaths in the mapping from the target to the source document. Assumes that the xpaths are valid.

Specified by:

mapProperties in interface PropertiesMappingService

Throws:

ClientException - if trying to map incompatible types