io.sirix.diff.service.FMSEImport 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
/**
 * 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.diff.service;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

import io.sirix.access.DatabaseConfiguration;
import io.sirix.access.Databases;
import io.sirix.access.ResourceConfiguration;
import io.sirix.diff.algorithm.fmse.DefaultNodeComparisonFactory;
import io.sirix.diff.algorithm.fmse.FMSE;
import io.sirix.exception.SirixException;
import io.sirix.exception.SirixIOException;
import io.sirix.service.InsertPosition;
import io.sirix.service.xml.shredder.XmlShredder;
import io.sirix.utils.SirixFiles;
import org.checkerframework.checker.nullness.qual.NonNull;
import io.brackit.query.atomic.QNm;
import io.sirix.utils.LogWrapper;
import org.slf4j.LoggerFactory;

import static java.util.Objects.requireNonNull;

/**
 * Import using the FMSE algorithm.
 *
 * @author Johannes Lichtenberger, University of Konstanz
 *
 */
public final class FMSEImport {

  /** {@link LogWrapper} reference. */
  private static final LogWrapper LOGWRAPPER = new LogWrapper(LoggerFactory.getLogger(FMSEImport.class));

  /**
   * Shredder new revision as temporal resource.
   *
   * @param resNewRev {@link File} reference for new revision (XML resource)
   * @param newRev {@link File} reference for shreddered new revision (sirix resource)
   * @throws SirixIOException if sirix fails to shredder the file
   * @throws NullPointerException if {@code resNewRev} or {@code newRev} is {@code null}
   */
  public void shredder(final Path resNewRev, @NonNull final Path newRev) {
    assert resNewRev != null;
    assert newRev != null;
    final var conf = new DatabaseConfiguration(newRev);
    Databases.removeDatabase(newRev);
    Databases.createXmlDatabase(conf);

    try (final var db = Databases.openXmlDatabase(newRev)) {
      db.createResource(new ResourceConfiguration.Builder("shredded").buildPathSummary(true).useDeweyIDs(true).build());
      try (final var resMgr = db.beginResourceSession("shredded");
           final var wtx = resMgr.beginNodeTrx();
           final var fis = new FileInputStream(resNewRev.toFile())) {
        final var fileReader = XmlShredder.createFileReader(fis);
        final var shredder =
            new XmlShredder.Builder(wtx, fileReader, InsertPosition.AS_FIRST_CHILD).commitAfterwards().build();
        shredder.call();
      } catch (final IOException e) {
        throw new SirixIOException(e.getCause());
      }
    }
  }

  /**
   * Import the data.
   *
   * @param resOldRev {@link File} for old revision (sirix resource)
   * @param resNewRev {@link File} for new revision (XML resource)
   * @param idName the QName of the ID to use for matching elements
   */
  public void xmlDataImport(final Path resOldRev, @NonNull final Path resNewRev, final QNm idName) {
    importData(resOldRev, resNewRev, idName);
  }

  /**
   * Import the data.
   *
   * @param resOldRev {@link File} for old revision (sirix resource)
   * @param resNewRev {@link File} for new revision (XML resource)
   */
  private void xmlDataImport(final Path resOldRev, @NonNull final Path resNewRev) {
    importData(resOldRev, resNewRev, null);
  }

  private void importData(final Path resOldRev, final Path resNewRev, final QNm idName) {
    try {
      final var newRevTarget = Files.createTempDirectory(resNewRev.getFileName().toString());
      if (Files.exists(newRevTarget)) {
        SirixFiles.recursiveRemove(newRevTarget);
      }
      shredder(requireNonNull(resNewRev), newRevTarget);

      try (final var databaseOld = Databases.openXmlDatabase(resOldRev);
           final var resMgrOld = databaseOld.beginResourceSession("shredded");
           final var wtx = resMgrOld.beginNodeTrx();
           final var databaseNew = Databases.openXmlDatabase(newRevTarget);
           final var resourceNew = databaseNew.beginResourceSession("shredded");
           final var rtx = resourceNew.beginNodeReadOnlyTrx();
           final var fmes = idName == null
              ? FMSE.createInstance(new DefaultNodeComparisonFactory())
              : FMSE.createWithIdentifier(idName, new DefaultNodeComparisonFactory())) {
        fmes.diff(wtx, rtx);
      }
    } catch (final SirixException | IOException e) {
      LOGWRAPPER.error(e.getMessage(), e);
    }
  }

  /**
   * Main entry point.
   *
   * @param args
   *        
   *        arguments:
   *        
   *        
   *        args[0] - path to resource to update
   *        args[1] - path to new XML document
   *        
   */
  public static void main(final String[] args) {
    if (args.length < 2 || args.length > 4) {
      throw new IllegalArgumentException("Usage: FSME oldResource newXMLDocument [startNodeKeyOld] [startNodeKeyNew]");
    }

    final var resOldRev = Paths.get(args[0]);
    final var resNewRev = Paths.get(args[1]);

    if (args.length == 3)
      new FMSEImport().xmlDataImport(resOldRev, resNewRev, new QNm(args[2]));
    else
      new FMSEImport().xmlDataImport(resOldRev, resNewRev);
  }
}