Package org.nuxeo.ecm.core.io.impl.plugins

Class SingleDocumentReader

java.lang.Object

org.nuxeo.ecm.core.io.impl.AbstractDocumentReader

org.nuxeo.ecm.core.io.impl.plugins.DocumentModelReader

org.nuxeo.ecm.core.io.impl.plugins.SingleDocumentReader

All Implemented Interfaces:

DocumentReader

Direct Known Subclasses:

TypedSingleDocumentReader

public class SingleDocumentReader
extends DocumentModelReader

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field	Description
protected DocumentModel	doc
protected boolean	enableRepeatedReads
protected boolean	readDone

Fields inherited from class org.nuxeo.ecm.core.io.impl.plugins.DocumentModelReader

inlineBlobs, session

Constructor Summary

Constructors

Constructor	Description
SingleDocumentReader(CoreSession session, DocumentModel root)
SingleDocumentReader(CoreSession session, DocumentRef root)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the reader.
ExportedDocument	read()	Reads a single document.
void	setEnableRepeatedReads(boolean enableRepeatedReads)

Methods inherited from class org.nuxeo.ecm.core.io.impl.plugins.DocumentModelReader

getInlineBlobs, setInlineBlobs

Methods inherited from class org.nuxeo.ecm.core.io.impl.AbstractDocumentReader

read

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

doc

protected DocumentModel doc

enableRepeatedReads

protected boolean enableRepeatedReads

readDone

protected boolean readDone

Constructor Detail

SingleDocumentReader

public SingleDocumentReader(CoreSession session,
                            DocumentModel root)

SingleDocumentReader

public SingleDocumentReader(CoreSession session,
                            DocumentRef root)

Method Detail

close

public void close()

Description copied from interface: DocumentReader

Closes the reader.

Specified by:

close in interface DocumentReader

Overrides:

close in class DocumentModelReader

read

public ExportedDocument read()
                      throws IOException

Description copied from interface: DocumentReader

Reads a single document.

Specified by:

read in interface DocumentReader

Specified by:

read in class DocumentModelReader

Returns:

the document read or null if there are no more documents to read

Throws:

IOException

setEnableRepeatedReads

public void setEnableRepeatedReads(boolean enableRepeatedReads)