com.helger.schematron.xslt.ISchematronXSLTBasedProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-schematron Show documentation

Library for validating XML documents with Schematron

There is a newer version: 5.6.5

/**
 * Copyright (C) 2014-2020 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.schematron.xslt;

import javax.annotation.Nullable;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;

import org.w3c.dom.Document;

/**
 * Interface for a factory creating Schematron validators from XSLT. Sometimes
 * the pre-built XSLTs are already available, and sometimes they need to be
 * built from the underlying Schematron file.
 *
 * @author Philip Helger
 */
public interface ISchematronXSLTBasedProvider
{
  /**
   * @return true if the Schematron was successfully interpreted,
   *         false otherwise.
   */
  boolean isValidSchematron ();

  /**
   * @return The produced XSLT document from the Schematron document or
   *         null if preprocessing failed.
   * @see #isValidSchematron()
   */
  @Nullable
  Document getXSLTDocument ();

  /**
   * @return The XSLT transformer to be used. May be null if the
   *         compilation of the XSLT failed.
   * @throws TransformerConfigurationException
   *         In case of an internal error
   */
  @Nullable
  Transformer getXSLTTransformer () throws TransformerConfigurationException;
}