io.sirix.node.delegates.ValueNodeDelegate 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.node.delegates;

import com.google.common.base.MoreObjects;
import com.google.common.base.Objects;
import io.sirix.node.AbstractForwardingNode;
import io.sirix.node.NodeKind;
import io.sirix.node.interfaces.Node;
import io.sirix.node.interfaces.ValueNode;
import io.sirix.settings.Constants;
import io.sirix.utils.Compression;
import net.openhft.chronicle.bytes.Bytes;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.checker.nullness.qual.NonNull;

import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.zip.Deflater;

/**
 * Delegate method for all nodes containing "value"-data. That means that independent values are
 * stored by the nodes delegating the calls of the interface {@link ValueNode} to this class.
 *
 * @author Sebastian Graf, University of Konstanz
 *
 */
public class ValueNodeDelegate extends AbstractForwardingNode implements ValueNode {

  /** Delegate for common node information. */
  private final NodeDelegate nodeDelegate;

  /** Storing the value. */
  private byte[] value;

  /** Determines if input has been compressed. */
  private boolean compressed;

  /**
   * Constructor
   *
   * @param nodeDel {@link NodeDelegate} reference
   * @param val the value
   * @param compressed compress value or not
   */
  public ValueNodeDelegate(final NodeDelegate nodeDel, final byte[] val, final boolean compressed) {
    assert nodeDel != null : "nodeDel must not be null!";
    assert val != null : "val must not be null!";
    nodeDelegate = nodeDel;
    value = val;
    this.compressed = compressed;
  }

  @Override
  public long computeHash(Bytes bytes) {
    throw new UnsupportedOperationException();
  }

  @Override
  public long getHash() {
    throw new UnsupportedOperationException();
  }

  @Override
  public void setHash(final long hash) {
    throw new UnsupportedOperationException();
  }

  @Override
  public byte[] getRawValue() {
    return compressed
        ? Compression.decompress(value)
        : value;
  }

  @Override
  public String getValue() {
    return new String(getRawValue(), Constants.DEFAULT_ENCODING);
  }

  /**
   * Get value which might be compressed.
   *
   * @return {@code value} which might be compressed
   */
  public byte[] getCompressed() {
    return value;
  }

  @Override
  public void setRawValue(final byte[] value) {
    compressed = new String(value).length() > 10;
    this.value = compressed
        ? Compression.compress(value, Deflater.DEFAULT_COMPRESSION)
        : value;
  }

  /**
   * Determine if input value has been compressed.
   *
   * @return {@code true}, if it has been compressed, {@code false} otherwise
   */
  public boolean isCompressed() {
    return compressed;
  }

  /**
   * Set compression.
   *
   * @param compressed determines if value is compressed or not
   */
  public void setCompressed(final boolean compressed) {
    this.compressed = compressed;
  }

  @Override
  public int hashCode() {
    return Objects.hashCode(nodeDelegate, value);
  }

  @Override
  public boolean equals(final @Nullable Object obj) {
    if (!(obj instanceof final ValueNodeDelegate other))
      return false;

    return Objects.equal(nodeDelegate, other.nodeDelegate) && Arrays.equals(value, other.value);
  }

  @Override
  public @NonNull String toString() {
    return MoreObjects.toStringHelper(this).add("value", new String(value)).toString();
  }

  @Override
  public boolean isSameItem(final @Nullable Node other) {
    return nodeDelegate.isSameItem(other);
  }

  @Override
  public NodeKind getKind() {
    return NodeKind.UNKNOWN;
  }

  @Override
  protected @NonNull NodeDelegate delegate() {
    return nodeDelegate;
  }

  @Override
  public byte[] getDeweyIDAsBytes() {
    return nodeDelegate.getDeweyIDAsBytes();
  }
}