001/*
002 * (C) Copyright 2006-2012 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Antoine Taillefer
018 */
019package org.nuxeo.ecm.diff.content.adapter.base;
020
021import java.util.List;
022import java.util.Locale;
023
024import org.nuxeo.ecm.core.api.Blob;
025import org.nuxeo.ecm.core.api.DocumentModel;
026import org.nuxeo.ecm.core.convert.api.ConversionException;
027import org.nuxeo.ecm.diff.content.ContentDiffAdapter;
028import org.nuxeo.ecm.diff.content.ContentDiffException;
029import org.nuxeo.ecm.diff.content.ContentDiffHelper;
030import org.nuxeo.ecm.diff.content.adapter.ContentDiffAdapterManager;
031import org.nuxeo.runtime.api.Framework;
032
033/**
034 * Abstract base class for content diff adapters.
035 *
036 * @author Antoine Taillefer
037 * @since 5.6
038 */
039public abstract class AbstractContentDiffAdapter implements ContentDiffAdapter {
040
041    protected DocumentModel adaptedDoc;
042
043    public String getFileContentDiffURL(DocumentModel otherDoc, ContentDiffConversionType conversionType, String locale) {
044        return ContentDiffHelper.getContentDiffURL(adaptedDoc, otherDoc, conversionType.name(), locale);
045    }
046
047    public String getFileContentDiffURL(DocumentModel otherDoc, String xpath, ContentDiffConversionType conversionType,
048            String locale) {
049        return ContentDiffHelper.getContentDiffURL(adaptedDoc, otherDoc, xpath, conversionType.name(), locale);
050    }
051
052    public List<Blob> getFileContentDiffBlobs(DocumentModel otherDoc, ContentDiffConversionType conversionType,
053            Locale locale) throws ContentDiffException, ConversionException {
054        return getContentDiffBlobs(otherDoc, conversionType, locale);
055    }
056
057    public List<Blob> getFileContentDiffBlobs(DocumentModel otherDoc, String xpath,
058            ContentDiffConversionType conversionType, Locale locale) throws ContentDiffException, ConversionException {
059        return getContentDiffBlobs(otherDoc, xpath, conversionType, locale);
060    }
061
062    protected abstract List<Blob> getContentDiffBlobs(DocumentModel otherDoc, ContentDiffConversionType conversionType,
063            Locale locale) throws ContentDiffException, ConversionException;
064
065    protected abstract List<Blob> getContentDiffBlobs(DocumentModel otherDoc, String xpath,
066            ContentDiffConversionType conversionType, Locale locale) throws ContentDiffException, ConversionException;
067
068    public void setAdaptedDocument(DocumentModel doc) {
069        this.adaptedDoc = doc;
070    }
071
072    /**
073     * Gets the content diff adapter manager.
074     *
075     * @return the content diff adapter manager
076     */
077    protected final ContentDiffAdapterManager getContentDiffAdapterManager() {
078        return Framework.getService(ContentDiffAdapterManager.class);
079    }
080
081}