001/* 002 * (C) Copyright 2012 Nuxeo SA (http://nuxeo.com/) and contributors. 003 * 004 * All rights reserved. This program and the accompanying materials 005 * are made available under the terms of the GNU Lesser General Public License 006 * (LGPL) version 2.1 which accompanies this distribution, and is available at 007 * http://www.gnu.org/licenses/lgpl.html 008 * 009 * This library is distributed in the hope that it will be useful, 010 * but WITHOUT ANY WARRANTY; without even the implied warranty of 011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 012 * Lesser General Public License for more details. 013 * 014 * Contributors: 015 * mcedica 016 */ 017package org.nuxeo.ecm.core.api.propertiesmapping; 018 019import java.util.Map; 020 021import org.nuxeo.ecm.core.api.CoreSession; 022import org.nuxeo.ecm.core.api.DocumentModel; 023 024/** 025 * Service that allows to copy a set of metadata from a source to a target document 026 * 027 * @since 5.6 028 */ 029public interface PropertiesMappingService { 030 031 /** 032 * Gets a map of xpaths defining properties on the target and source documents 033 * 034 * @param mappingName 035 * @return 036 */ 037 Map<String, String> getMapping(String mappingName); 038 039 /** 040 * Copies the properties defined by the given xpaths in the mapping from the target to the source document. Assumes 041 * that the xpaths are valid. 042 * 043 * @param session 044 * @param sourceDoc 045 * @param targetDoc 046 * @param mappingName 047 */ 048 void mapProperties(CoreSession session, DocumentModel sourceDoc, DocumentModel targetDoc, String mappingName); 049 050}