001/* 002 * (C) Copyright 2006-2011 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 * Nuxeo - initial API and implementation 018 * 019 * $Id: DocumentWriter.java 29029 2008-01-14 18:38:14Z ldoguin $ 020 */ 021 022package org.nuxeo.ecm.core.io; 023 024import java.io.IOException; 025import java.util.Collection; 026 027/** 028 * A document writer. 029 * <p> 030 * This writer is designed to be accessible remotely (over a network). 031 * 032 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a> 033 */ 034public interface DocumentWriter { 035 036 /** 037 * Writes a single document. 038 * 039 * @param doc the document to write 040 * @return the translation map. 041 */ 042 DocumentTranslationMap write(ExportedDocument doc) throws IOException; 043 044 /** 045 * Writes an array of documents. 046 * 047 * @param docs the array to write 048 * @return the translation map. 049 */ 050 DocumentTranslationMap write(ExportedDocument[] docs) throws IOException; 051 052 /** 053 * Writes documents from the given collection. 054 * 055 * @param docs the documents to write 056 * @return the translation map. 057 */ 058 DocumentTranslationMap write(Collection<ExportedDocument> docs) throws IOException; 059 060 /** 061 * Closes the writer. 062 */ 063 void close(); 064 065}