io.sirix.service.xml.serialize.AbstractSerializer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sirix-core Show documentation
Show all versions of sirix-core Show documentation
SirixDB is a hybrid on-disk and in-memory document oriented, versioned database system. It has a lightweight buffer manager, stores everything in a huge persistent and durable tree and allows efficient reconstruction of every revision. Furthermore, SirixDB implements change tracking, diffing and supports time travel queries.
/**
* 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 io.sirix.service.xml.serialize;
import io.sirix.api.Axis;
import io.sirix.api.ResourceSession;
import io.sirix.api.xml.XmlNodeReadOnlyTrx;
import io.sirix.api.xml.XmlResourceSession;
import io.sirix.axis.DescendantAxis;
import io.sirix.axis.IncludeSelf;
import io.sirix.exception.SirixException;
import io.sirix.node.NodeKind;
import io.sirix.settings.Constants;
import org.checkerframework.checker.index.qual.NonNegative;
import java.util.ArrayDeque;
import java.util.Deque;
import java.util.concurrent.Callable;
import static java.util.Objects.requireNonNull;
/**
* Class implements main serialization algorithm. Other classes can extend it.
*
* @author Johannes Lichtenberger, University of Konstanz
*
*/
public abstract class AbstractSerializer implements Callable {
/** Sirix {@link ResourceSession}. */
protected final XmlResourceSession mResMgr;
/** Stack for reading end element. */
protected final Deque mStack;
/** Array with versions to print. */
protected final int[] mRevisions;
/** Root node key of subtree to shredder. */
protected final long mNodeKey;
/**
* Constructor.
*
* @param resMgr Sirix {@link ResourceSession}
* @param revision first revision to serialize
* @param revisions revisions to serialize
*/
public AbstractSerializer(final XmlResourceSession resMgr, final @NonNegative int revision, final int... revisions) {
mStack = new ArrayDeque<>();
mRevisions = revisions == null
? new int[1]
: new int[revisions.length + 1];
initialize(revision, revisions);
mResMgr = requireNonNull(resMgr);
mNodeKey = 0;
}
/**
* Constructor.
*
* @param resMgr Sirix {@link ResourceSession}
* @param key key of root node from which to shredder the subtree
* @param revision first revision to serialize
* @param revisions revisions to serialize
*/
public AbstractSerializer(final XmlResourceSession resMgr, final @NonNegative long key,
final @NonNegative int revision, final int... revisions) {
mStack = new ArrayDeque<>();
mRevisions = revisions == null
? new int[1]
: new int[revisions.length + 1];
initialize(revision, revisions);
mResMgr = requireNonNull(resMgr);
mNodeKey = key;
}
/**
* Initialize.
*
* @param revision first revision to serialize
* @param revisions revisions to serialize
*/
private void initialize(final @NonNegative int revision, final int... revisions) {
mRevisions[0] = revision;
if (revisions != null) {
for (int i = 0; i < revisions.length; i++) {
mRevisions[i + 1] = revisions[i];
}
}
}
/**
* Serialize the storage.
*
* @return null.
* @throws SirixException if can't call serailzer
*/
@Override
public Void call() throws SirixException {
emitStartDocument();
final int nrOfRevisions = mRevisions.length;
final int length = (nrOfRevisions == 1 && mRevisions[0] < 0)
? (int) mResMgr.getMostRecentRevisionNumber()
: nrOfRevisions;
for (int i = 1; i <= length; i++) {
try (final XmlNodeReadOnlyTrx rtx = mResMgr.beginNodeReadOnlyTrx((nrOfRevisions == 1 && mRevisions[0] < 0)
? i
: mRevisions[i - 1])) {
emitRevisionStartTag(rtx);
rtx.moveTo(mNodeKey);
final Axis descAxis = new DescendantAxis(rtx, IncludeSelf.YES);
// Setup primitives.
boolean closeElements = false;
long key = rtx.getNodeKey();
// Iterate over all nodes of the subtree including self.
while (descAxis.hasNext()) {
key = descAxis.next();
// Emit all pending end elements.
if (closeElements) {
while (!mStack.isEmpty() && mStack.peek() != rtx.getLeftSiblingKey()) {
rtx.moveTo(mStack.pop());
emitEndTag(rtx);
rtx.moveTo(key);
}
if (!mStack.isEmpty()) {
rtx.moveTo(mStack.pop());
emitEndTag(rtx);
}
rtx.moveTo(key);
closeElements = false;
}
// Emit node.
emitNode(rtx);
// Push end element to stack if we are a start element with
// children.
if (rtx.getKind() == NodeKind.ELEMENT && rtx.hasFirstChild()) {
mStack.push(rtx.getNodeKey());
}
// Remember to emit all pending end elements from stack if
// required.
if (!rtx.hasFirstChild() && !rtx.hasRightSibling()) {
closeElements = true;
}
}
// Finally emit all pending end elements.
while (!mStack.isEmpty() && mStack.peek() != Constants.NULL_ID_LONG) {
rtx.moveTo(mStack.pop());
emitEndTag(rtx);
}
emitRevisionEndTag(rtx);
}
}
emitEndDocument();
return null;
}
/**
* Emit start document.
*/
protected abstract void emitStartDocument();
/**
* Emit start tag.
*
* @param rtx Sirix {@link XmlNodeReadOnlyTrx}
*/
protected abstract void emitNode(XmlNodeReadOnlyTrx rtx);
/**
* Emit end tag.
*
* @param rtx Sirix {@link XmlNodeReadOnlyTrx}
*/
protected abstract void emitEndTag(XmlNodeReadOnlyTrx rtx);
/**
* Emit a start tag, which specifies a revision.
*
* @param rtx Sirix {@link XmlNodeReadOnlyTrx}
*/
protected abstract void emitRevisionStartTag(XmlNodeReadOnlyTrx rtx);
/**
* Emit an end tag, which specifies a revision.
*
* @param rtx Sirix {@link XmlNodeReadOnlyTrx}
*/
protected abstract void emitRevisionEndTag(XmlNodeReadOnlyTrx rtx);
/** Emit end document. */
protected abstract void emitEndDocument();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy