1 /**
2 * Copyright (C) 2014-2018 Philip Helger (www.helger.com)
3 * philip[at]helger[dot]com
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package com.helger.schematron.svrl;
18
19 import javax.annotation.Nonnull;
20 import javax.annotation.Nullable;
21
22 import com.helger.commons.annotation.IsSPIInterface;
23
24 /**
25 * Implement this SPI interface to beautify SVRL error messages by replacing
26 * namespaceURLs with common prefixes.
27 *
28 * @author Philip Helger
29 */
30 @IsSPIInterface
31 public interface ISVRLLocationBeautifierSPI
32 {
33 /**
34 * Beautify the passed combination.
35 *
36 * @param sNamespaceURI
37 * Namespace URI
38 * @param sLocalName
39 * Element local name
40 * @return <code>null</code> to indicate that this object does not know how to
41 * handle the namespace. Otherwise the replacement text should be
42 * returned.<br>
43 * Example for UBL: Input parameters
44 * <code>urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2</code>
45 * and <code>Party</code>. The result may be <code>cac:Party</code> as
46 * <i>cac</i> is the common namespace prefix for the passed namespace
47 * URI.
48 */
49 @Nullable
50 String getReplacementText (@Nonnull String sNamespaceURI, @Nonnull String sLocalName);
51 }