org.treetank.testutil.NodeElementTestHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of node Show documentation
The newest version!
/**
 * Copyright (c) 2011, University of Konstanz, Distributed Systems Group
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * * Neither the name of the University of Konstanz nor the
 * names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL  BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.treetank.testutil;

import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.treetank.data.IConstants.NULL_NODE;
import static org.treetank.data.IConstants.ROOT_NODE;

import javax.xml.namespace.QName;

import org.treetank.access.NodeWriteTrx;
import org.treetank.access.NodeWriteTrx.HashKind;
import org.treetank.access.Session;
import org.treetank.access.conf.ResourceConfiguration;
import org.treetank.access.conf.SessionConfiguration;
import org.treetank.access.conf.StandardSettings;
import org.treetank.api.IBucketWriteTrx;
import org.treetank.api.INodeWriteTrx;
import org.treetank.api.ISession;
import org.treetank.api.IStorage;
import org.treetank.data.DocumentRootNode;
import org.treetank.data.delegates.NodeDelegate;
import org.treetank.data.delegates.StructNodeDelegate;
import org.treetank.exception.TTException;
import org.treetank.testutil.CoreTestHelper;
import org.treetank.testutil.CoreTestHelper.PATHS;

/**
 * 
 * Helper class for offering convenient usage of {@link Session}s for test
 * cases.
 * 
 * This includes instantiation of databases plus resources.
 * 
 * @author Sebastian Graf, University of Konstanz
 * 
 */

public final class NodeElementTestHelper {

    /**
     * Creating a test document at {@link PATHS#PATH1}.
     * 
     * @throws TTException
     */
    public static void createTestDocument(ResourceConfiguration mResourceConfig) throws TTException {
        final IStorage storage = CoreTestHelper.getStorage(CoreTestHelper.PATHS.PATH1.getFile());
        assertTrue(storage.createResource(mResourceConfig));
        final ISession session =
            storage.getSession(new SessionConfiguration(CoreTestHelper.RESOURCENAME, StandardSettings.KEY));
        final IBucketWriteTrx pWtx = session.beginBucketWtx();
        final INodeWriteTrx nWtx = new NodeWriteTrx(session, pWtx, HashKind.Rolling);
        DocumentCreater.create(nWtx);
        nWtx.commit();
        nWtx.close();
        session.close();
    }

    /**
     * Generating a Document Root node.
     * 
     * @param pWtx
     *            where the docroot should be generated.
     * @throws TTException
     */
    public static final void createDocumentRootNode(final INodeWriteTrx pWtx) throws TTException {
        final NodeDelegate nodeDel = new NodeDelegate(pWtx.getPageWtx().incrementDataKey(), NULL_NODE, 0);
        pWtx.getPageWtx()
            .setData(
                new DocumentRootNode(nodeDel, new StructNodeDelegate(nodeDel, NULL_NODE, NULL_NODE,
                    NULL_NODE, 0)));
        pWtx.moveTo(org.treetank.data.IConstants.ROOT_NODE);
    }

    /** String representation of test document. */
    public static final String XML = ""
        + "oops1foooops2baroops3";

    /**
     * TestDocument
     * 
     * 
     * This class creates an XML document that contains all features seen in the Extensible Markup Language
     * (XML) 1.1 (Second Edition) as well as the Namespaces in XML 1.1 (Second Edition).
     * 
     * 
     * 
     * The following figure describes the created test document (see xml/test.xml). The nodes are
     * described as follows:
     * 
     * 

     * ENode.ROOT_KIND     : doc()
     * ENode.ELEMENT_KIND  : <prefix:localPart>
     * ENode.NAMESPACE_KIND: §prefix:namespaceURI
     * ENode.ATTRIBUTE_KIND: @prefix:localPart='value'
     * ENode.TEXT_KIND     : #value
     * 
     * 
     *      * 0 doc()
     * |-  1 <p:a §p:ns @i='j'>
     *     |-  4 #oops1
     *     |-  5 <b>
     *     |   |-  6 #foo
     *     |   |-  7 <c>
     *     |-  8 #oops2
     *     |-  9 <b @p:x='y'>
     *     |   |- 11 <c>
     *     |   |- 12 #bar
     *     |- 13 #oops3
     * 
     * 
     * 
     */
    public static class DocumentCreater {
        /**
         * Create simple test document containing all supported node kinds.
         * 
         * @param paramWtx
         *            {@link INodeWriteTrx} to write to
         * @throws TTException
         *             if anything weird happens
         */
        public static void create(final INodeWriteTrx paramWtx) throws TTException {
            assertNotNull(paramWtx);

            NodeElementTestHelper.createDocumentRootNode(paramWtx);

            assertTrue(paramWtx.moveTo(ROOT_NODE));

            paramWtx.insertElementAsFirstChild(new QName("ns", "a", "p"));
            paramWtx.insertAttribute(new QName("i"), "j");
            assertTrue(paramWtx.moveTo(paramWtx.getNode().getParentKey()));
            paramWtx.insertNamespace(new QName("ns", "xmlns", "p"));
            assertTrue(paramWtx.moveTo(paramWtx.getNode().getParentKey()));

            paramWtx.insertTextAsFirstChild("oops1");

            paramWtx.insertElementAsRightSibling(new QName("b"));

            paramWtx.insertTextAsFirstChild("foo");
            paramWtx.insertElementAsRightSibling(new QName("c"));
            assertTrue(paramWtx.moveTo(paramWtx.getNode().getParentKey()));

            paramWtx.insertTextAsRightSibling("oops2");

            paramWtx.insertElementAsRightSibling(new QName("b"));
            paramWtx.insertAttribute(new QName("ns", "x", "p"), "y");
            assertTrue(paramWtx.moveTo(paramWtx.getNode().getParentKey()));

            paramWtx.insertElementAsFirstChild(new QName("c"));
            paramWtx.insertTextAsRightSibling("bar");
            assertTrue(paramWtx.moveTo(paramWtx.getNode().getParentKey()));

            paramWtx.insertTextAsRightSibling("oops3");

            assertTrue(paramWtx.moveTo(ROOT_NODE));
        }
    }
}