org.nuxeo.ecm.core.io
Interface DocumentWriter

All Known Implementing Classes:

AbstractDocumentModelWriter, AbstractDocumentWriter, DocumentModelInjector, DocumentModelUpdater, DocumentModelWriter, NuxeoArchiveWriter, SingleShadowDocumentWriter, XMLDirectoryWriter, XMLDocumentTreeWriter, XMLDocumentWriter

public interface DocumentWriter

A document writer.

This writer is designed to be accessible remotely (over a network).

Author:

Bogdan Stefanescu

Method Summary

void	close() Closes the writer.
DocumentTranslationMap	write(Collection<ExportedDocument> docs) Writes documents from the given collection.
DocumentTranslationMap	write(ExportedDocument doc) Writes a single document.
DocumentTranslationMap	write(ExportedDocument[] docs) Writes an array of documents.

Method Detail

write

DocumentTranslationMap write(ExportedDocument doc)
                             throws IOException

Writes a single document.

Parameters:

doc - the document to write

Returns:

the translation map.

Throws:

IOException

write

DocumentTranslationMap write(ExportedDocument[] docs)
                             throws IOException

Writes an array of documents.

Parameters:

docs - the array to write

Returns:

the translation map.

Throws:

IOException

write

DocumentTranslationMap write(Collection<ExportedDocument> docs)
                             throws IOException

Writes documents from the given collection.

Parameters:

docs - the documents to write

Returns:

the translation map.

Throws:

IOException

close

void close()

Closes the writer.