com.helger.schematron.svrl.ISVRLLocationBeautifierSPI 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.svrl;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.annotation.IsSPIInterface;

/**
 * Implement this SPI interface to beautify SVRL error messages by replacing
 * namespaceURLs with common prefixes.
 *
 * @author Philip Helger
 */
@IsSPIInterface
public interface ISVRLLocationBeautifierSPI
{
  /**
   * Beautify the passed combination.
   *
   * @param sNamespaceURI
   *        Namespace URI
   * @param sLocalName
   *        Element local name
   * @return null to indicate that this object does not know how to
   *         handle the namespace. Otherwise the replacement text should be
   *         returned.

   *         Example for UBL: Input parameters
   *         urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2
   *         and Party. The result may be cac:Party as
   *         cac is the common namespace prefix for the passed namespace
   *         URI.
   */
  @Nullable
  String getReplacementText (@Nonnull String sNamespaceURI, @Nonnull String sLocalName);
}