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: DocumentTreeReader.java 29029 2008-01-14 18:38:14Z ldoguin $
020 */
021
022package org.nuxeo.ecm.core.io.impl.plugins;
023
024import java.io.IOException;
025
026import org.nuxeo.ecm.core.api.CoreSession;
027import org.nuxeo.ecm.core.api.DocumentModel;
028import org.nuxeo.ecm.core.api.DocumentRef;
029import org.nuxeo.ecm.core.api.DocumentTreeIterator;
030import org.nuxeo.ecm.core.io.ExportedDocument;
031import org.nuxeo.ecm.core.io.impl.ExportedDocumentImpl;
032
033/**
034 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
035 */
036public class DocumentTreeReader extends DocumentModelReader {
037
038    protected DocumentTreeIterator iterator;
039
040    protected int pathSegmentsToRemove = 0;
041
042    public DocumentTreeReader(CoreSession session, DocumentModel root, boolean excludeRoot) {
043        super(session);
044        iterator = new DocumentTreeIterator(session, root, excludeRoot);
045        pathSegmentsToRemove = root.getPath().segmentCount() - (excludeRoot ? 0 : 1);
046    }
047
048    public DocumentTreeReader(CoreSession session, DocumentRef root) {
049        this(session, session.getDocument(root));
050    }
051
052    public DocumentTreeReader(CoreSession session, DocumentModel root) {
053        this(session, root, false);
054    }
055
056    @Override
057    public void close() {
058        super.close();
059        iterator.reset();
060        iterator = null;
061    }
062
063    @Override
064    public ExportedDocument read() throws IOException {
065        if (iterator.hasNext()) {
066            DocumentModel docModel = iterator.next();
067            if (pathSegmentsToRemove > 0) {
068                // remove unwanted leading segments
069                return new ExportedDocumentImpl(docModel, docModel.getPath().removeFirstSegments(pathSegmentsToRemove),
070                        inlineBlobs);
071            } else {
072                return new ExportedDocumentImpl(docModel, inlineBlobs);
073            }
074        }
075        return null;
076    }
077
078}