io.sirix.axis.NonStructuralWrapperAxis Maven / Gradle / Ivy

Go to download
/**
 * 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.axis;

import io.sirix.api.Axis;
import io.sirix.api.xml.XmlNodeReadOnlyTrx;
import io.sirix.settings.Fixed;

import static java.util.Objects.requireNonNull;

/**
 * 
 * Adds non-structural nodes (that is namespaces and attributes) to an axis.
 * 
 *
 * @author Johannes Lichtenberger
 */
public final class NonStructuralWrapperAxis extends AbstractAxis {

  /** Parent axis. */
  private final Axis mParentAxis;

  /** Namespace index. */
  private int mNspIndex;

  /** Attribute index. */
  private int mAttIndex;

  /** Determines if transaction has moved to the next structural node at first. */
  private boolean mFirst;

  /**
   * Constructor initializing internal state.
   *
   * @param parentAxis inner nested axis
   */
  public NonStructuralWrapperAxis(final Axis parentAxis) {
    super(parentAxis.asXmlNodeReadTrx());
    mParentAxis = requireNonNull(parentAxis);
  }

  @Override
  public void reset(final long nodeKey) {
    super.reset(nodeKey);
    if (mParentAxis != null) {
      mParentAxis.reset(nodeKey);
    }
    mNspIndex = 0;
    mAttIndex = 0;
    mFirst = true;
  }

  @Override
  protected long nextKey() {
    final XmlNodeReadOnlyTrx trx = mParentAxis.asXmlNodeReadTrx();
    if (mParentAxis.includeSelf() == IncludeSelf.NO || !mFirst) {
      final long nodeKey = nonStructural(trx);
      if (nodeKey != Fixed.NULL_NODE_KEY.getStandardProperty()) {
        return nodeKey;
      }
    }

    if (mParentAxis.hasNext()) {
      final long key = mParentAxis.next();
      mFirst = false;
      mNspIndex = 0;
      mAttIndex = 0;
      return key;
    }

    return done();
  }

  /**
   * Determine if non structural nodes must be emitted.
   *
   * @param trx Sirix {@link XmlNodeReadOnlyTrx}
   * @return the node key of the non structural node, or the {@code NULL_NODE_KEY}
   */
  private long nonStructural(final XmlNodeReadOnlyTrx trx) {
    if (trx.isNamespace()) {
      trx.moveToParent();
    }
    if (trx.isElement() && mNspIndex < trx.getNamespaceCount()) {
      trx.moveToNamespace(mNspIndex++);
      return trx.getNodeKey();
    }
    if (trx.isAttribute()) {
      trx.moveToParent();
    }
    if (trx.isElement() && mAttIndex < trx.getAttributeCount()) {
      trx.moveToAttribute(mAttIndex++);
      return trx.getNodeKey();
    }
    return Fixed.NULL_NODE_KEY.getStandardProperty();
  }
}