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

Class DocumentTreeReader

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.DocumentTreeReader

All Implemented Interfaces:

DocumentReader

public class DocumentTreeReader
extends DocumentModelReader

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field	Description
protected DocumentTreeIterator	iterator
protected int	pathSegmentsToRemove

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

inlineBlobs, session

Constructor Summary

Constructors

Constructor	Description
DocumentTreeReader(CoreSession session, DocumentModel root)
DocumentTreeReader(CoreSession session, DocumentModel root, boolean excludeRoot)
DocumentTreeReader(CoreSession session, DocumentRef root)

Method Summary

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

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

iterator

protected DocumentTreeIterator iterator

pathSegmentsToRemove

protected int pathSegmentsToRemove

Constructor Detail

DocumentTreeReader

public DocumentTreeReader(CoreSession session,
                          DocumentModel root,
                          boolean excludeRoot)

DocumentTreeReader

public DocumentTreeReader(CoreSession session,
                          DocumentRef root)

DocumentTreeReader

public DocumentTreeReader(CoreSession session,
                          DocumentModel 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