com.helger.schematron.svrl.SVRLHelper 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
Show all versions of ph-schematron Show documentation
Library for validating XML documents with Schematron
/**
* 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 java.util.regex.Matcher;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.ThreadSafe;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.PresentForCodeCoverage;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.impl.CommonsArrayList;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.concurrent.SimpleReadWriteLock;
import com.helger.commons.error.level.IErrorLevel;
import com.helger.commons.regex.RegExHelper;
import com.helger.commons.string.StringHelper;
import com.helger.schematron.svrl.jaxb.FailedAssert;
import com.helger.schematron.svrl.jaxb.SchematronOutputType;
import com.helger.schematron.svrl.jaxb.SuccessfulReport;
import com.helger.schematron.svrl.jaxb.Text;
/**
* Miscellaneous utility methods for handling Schematron output (SVRL).
*
* @author Philip Helger
*/
@ThreadSafe
public final class SVRLHelper
{
private static final SimpleReadWriteLock s_aRWLock = new SimpleReadWriteLock ();
private static ISVRLErrorLevelDeterminator s_aELD = new DefaultSVRLErrorLevelDeterminator ();
@PresentForCodeCoverage
private static final SVRLHelper s_aInstance = new SVRLHelper ();
private SVRLHelper ()
{}
@Nullable
public static String getAsString (@Nullable final Text aText)
{
if (aText == null)
return null;
final StringBuilder aSB = new StringBuilder ();
for (final Object aObj : aText.getContent ())
aSB.append (aObj);
return aSB.toString ();
}
/**
* Get a list of all failed assertions in a given schematron output.
*
* @param aSchematronOutput
* The schematron output to be used. May be null.
* @return A non-null list with all failed assertions.
*/
@Nonnull
@ReturnsMutableCopy
public static ICommonsList getAllFailedAssertions (@Nullable final SchematronOutputType aSchematronOutput)
{
final ICommonsList ret = new CommonsArrayList <> ();
if (aSchematronOutput != null)
for (final Object aObj : aSchematronOutput.getActivePatternAndFiredRuleAndFailedAssert ())
if (aObj instanceof FailedAssert)
ret.add (new SVRLFailedAssert ((FailedAssert) aObj));
return ret;
}
/**
* Get a list of all failed assertions in a given schematron output, with an
* error level equally or more severe than the passed error level.
*
* @param aSchematronOutput
* The schematron output to be used. May be null.
* @param aErrorLevel
* Minimum error level to be queried
* @return A non-null list with all failed assertions.
*/
@Nonnull
@ReturnsMutableCopy
public static ICommonsList getAllFailedAssertionsMoreOrEqualSevereThan (@Nullable final SchematronOutputType aSchematronOutput,
@Nonnull final IErrorLevel aErrorLevel)
{
final ICommonsList ret = new CommonsArrayList <> ();
if (aSchematronOutput != null)
for (final Object aObj : aSchematronOutput.getActivePatternAndFiredRuleAndFailedAssert ())
if (aObj instanceof FailedAssert)
{
final SVRLFailedAssert aFA = new SVRLFailedAssert ((FailedAssert) aObj);
if (aFA.getFlag ().isGE (aErrorLevel))
ret.add (aFA);
}
return ret;
}
/**
* Get a list of all successful reports in a given schematron output.
*
* @param aSchematronOutput
* The schematron output to be used. May be null.
* @return A non-null list with all successful reports.
*/
@Nonnull
@ReturnsMutableCopy
public static ICommonsList getAllSuccessfulReports (@Nullable final SchematronOutputType aSchematronOutput)
{
final ICommonsList ret = new CommonsArrayList <> ();
if (aSchematronOutput != null)
for (final Object aObj : aSchematronOutput.getActivePatternAndFiredRuleAndFailedAssert ())
if (aObj instanceof SuccessfulReport)
ret.add (new SVRLSuccessfulReport ((SuccessfulReport) aObj));
return ret;
}
/**
* Get a list of all successful reports in a given schematron output, with an
* error level equally or more severe than the passed error level.
*
* @param aSchematronOutput
* The schematron output to be used. May be null.
* @param aErrorLevel
* Minimum error level to be queried
* @return A non-null list with all successful reports.
*/
@Nonnull
@ReturnsMutableCopy
public static ICommonsList getAllSuccessfulReportsMoreOrEqualSevereThan (@Nullable final SchematronOutputType aSchematronOutput,
@Nonnull final IErrorLevel aErrorLevel)
{
final ICommonsList ret = new CommonsArrayList <> ();
if (aSchematronOutput != null)
for (final Object aObj : aSchematronOutput.getActivePatternAndFiredRuleAndFailedAssert ())
if (aObj instanceof SuccessfulReport)
{
final SVRLSuccessfulReport aSR = new SVRLSuccessfulReport ((SuccessfulReport) aObj);
if (aSR.getFlag ().isGE (aErrorLevel))
ret.add (aSR);
}
return ret;
}
/**
* Get a list of all failed assertions and successful reports in a given
* schematron output.
*
* @param aSchematronOutput
* The schematron output to be used. May be null.
* @return A non-null list with all failed assertions and
* successful reports. Maybe an empty list if the input is
* null.
*/
@Nonnull
@ReturnsMutableCopy
public static ICommonsList getAllFailedAssertionsAndSuccessfulReports (@Nullable final SchematronOutputType aSchematronOutput)
{
final ICommonsList ret = new CommonsArrayList <> ();
if (aSchematronOutput != null)
for (final Object aObj : aSchematronOutput.getActivePatternAndFiredRuleAndFailedAssert ())
if (aObj instanceof FailedAssert)
ret.add (new SVRLFailedAssert ((FailedAssert) aObj));
else
if (aObj instanceof SuccessfulReport)
ret.add (new SVRLSuccessfulReport ((SuccessfulReport) aObj));
return ret;
}
/**
* Get the error level associated with a single failed assertion.
*
* @param aFailedAssert
* The failed assert to be queried. May not be null.
* @return The error level and never null.
*/
@Nonnull
public static IErrorLevel getErrorLevelFromFailedAssert (@Nonnull final FailedAssert aFailedAssert)
{
return getErrorLevelDeterminator ().getErrorLevelFromFailedAssert (aFailedAssert);
}
/**
* Get the error level associated with a single successful report.
*
* @param aSuccessfulReport
* The failed assert to be queried. May not be null.
* @return The error level and never null.
*/
@Nonnull
public static IErrorLevel getErrorLevelFromSuccessfulReport (@Nonnull final SuccessfulReport aSuccessfulReport)
{
return getErrorLevelDeterminator ().getErrorLevelFromSuccessfulReport (aSuccessfulReport);
}
/**
* @return The default error level determinator. May not be null.
*/
@Nonnull
public static ISVRLErrorLevelDeterminator getErrorLevelDeterminator ()
{
return s_aRWLock.readLockedGet ( () -> s_aELD);
}
/**
* Set the global error level determinator.
*
* @param aELD
* The determinator to use. May not be null.
*/
public static void setErrorLevelDeterminator (@Nonnull final ISVRLErrorLevelDeterminator aELD)
{
ValueEnforcer.notNull (aELD, "ErrorLevelDeterminator");
s_aRWLock.writeLockedGet ( () -> s_aELD = aELD);
}
/**
* Convert an "unsexy" location string in the for, of
* *:xx[namespace-uri()='yy'] to something more readable like
* prefix:xx by using the mapping registered in the
* {@link SVRLLocationBeautifierRegistry}.
*
* @param sLocation
* The original location string. May not be null.
* @return The beautified string. Never null. Might be identical
* to the original string if the pattern was not found.
* @since 5.0.1
*/
@Nonnull
public static String getBeautifiedLocation (@Nonnull final String sLocation)
{
String sResult = sLocation;
// Handle namespaces:
// Search for "*:xx[namespace-uri()='yy']" where xx is the localname and yy
// is the namespace URI
final Matcher aMatcher = RegExHelper.getMatcher ("\\Q*:\\E([a-zA-Z0-9_]+)\\Q[namespace-uri()='\\E([^']+)\\Q']\\E", sResult);
while (aMatcher.find ())
{
final String sLocalName = aMatcher.group (1);
final String sNamespaceURI = aMatcher.group (2);
// Check if there is a known beautifier for this pair of namespace and
// local name
final String sBeautified = SVRLLocationBeautifierRegistry.getBeautifiedLocation (sNamespaceURI, sLocalName);
if (sBeautified != null)
sResult = StringHelper.replaceAll (sResult, aMatcher.group (), sBeautified);
}
return sResult;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy