001/* 002 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others. 003 * 004 * All rights reserved. This program and the accompanying materials 005 * are made available under the terms of the Eclipse Public License v1.0 006 * which accompanies this distribution, and is available at 007 * http://www.eclipse.org/legal/epl-v10.html 008 * 009 * Contributors: 010 * Nuxeo - initial API and implementation 011 * 012 * $Id: DocumentWriter.java 29029 2008-01-14 18:38:14Z ldoguin $ 013 */ 014 015package org.nuxeo.ecm.core.io; 016 017import java.io.IOException; 018import java.util.Collection; 019 020/** 021 * A document writer. 022 * <p> 023 * This writer is designed to be accessible remotely (over a network). 024 * 025 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a> 026 */ 027public interface DocumentWriter { 028 029 /** 030 * Writes a single document. 031 * 032 * @param doc the document to write 033 * @return the translation map. 034 * @throws IOException 035 */ 036 DocumentTranslationMap write(ExportedDocument doc) throws IOException; 037 038 /** 039 * Writes an array of documents. 040 * 041 * @param docs the array to write 042 * @return the translation map. 043 * @throws IOException 044 */ 045 DocumentTranslationMap write(ExportedDocument[] docs) throws IOException; 046 047 /** 048 * Writes documents from the given collection. 049 * 050 * @param docs the documents to write 051 * @return the translation map. 052 * @throws IOException 053 */ 054 DocumentTranslationMap write(Collection<ExportedDocument> docs) throws IOException; 055 056 /** 057 * Closes the writer. 058 */ 059 void close(); 060 061}