io.sirix.index.Materializable 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

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.

There is a newer version: 0.11.0

Show newest version

package io.sirix.index;

import io.brackit.query.jdm.DocumentException;
import io.brackit.query.jdm.node.Node;

/**
 * Materializable structure.
 * 
 * @author Sebastian Baechle
 *
 */
public interface Materializable {
  /**
   * Materialize the object as a {@link Node} tree
   * 
   * @return the root of the materialized tree
   * @throws DocumentException if materialization fails
   */
  Node materialize();

  /**
   * Initializes the materialized locator facet
   * 
   * @param root root of the materialized facet subtree
   * @throws DocumentException if initialization fails
   */
  void init(Node root);
}