com.helger.maven.schematron.SchematronPreprocessMojo Maven / Gradle / Ivy
/*
* Copyright (C) 2014-2024 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.maven.schematron;
import java.io.File;
import javax.annotation.Nonnull;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.sonatype.plexus.build.incremental.BuildContext;
import com.helger.commons.annotation.Since;
import com.helger.commons.io.resource.FileSystemResource;
import com.helger.commons.string.StringHelper;
import com.helger.schematron.CSchematron;
import com.helger.schematron.SchematronException;
import com.helger.schematron.pure.binding.IPSQueryBinding;
import com.helger.schematron.pure.binding.PSQueryBindingRegistry;
import com.helger.schematron.pure.exchange.PSReader;
import com.helger.schematron.pure.model.PSNS;
import com.helger.schematron.pure.model.PSSchema;
import com.helger.schematron.pure.preprocess.PSPreprocessor;
import com.helger.schematron.pure.preprocess.SchematronPreprocessException;
import com.helger.schematron.svrl.CSVRL;
import com.helger.xml.microdom.IMicroDocument;
import com.helger.xml.microdom.MicroDocument;
import com.helger.xml.microdom.serialize.MicroWriter;
import com.helger.xml.namespace.MapBasedNamespaceContext;
import com.helger.xml.serialize.write.EXMLSerializeIndent;
import com.helger.xml.serialize.write.IXMLWriterSettings;
import com.helger.xml.serialize.write.XMLWriterSettings;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
/**
* Applies Schematron preprocessing
*
* @author Philip Helger
* @since 5.0.9
*/
@SuppressFBWarnings ({ "NP_UNWRITTEN_FIELD", "UWF_UNWRITTEN_FIELD" })
@Mojo (name = "preprocess", defaultPhase = LifecyclePhase.GENERATE_RESOURCES, threadSafe = true)
public final class SchematronPreprocessMojo extends AbstractMojo
{
/**
* BuildContext for m2e (it's a pass-though straight to the filesystem when
* invoked from the Maven cli)
*/
@Component
private BuildContext buildContext;
/**
* The Maven Project.
*/
@Parameter (defaultValue = "${project}", readonly = true)
private MavenProject project;
/**
* The Schematron source file to be preprocessed
*/
@Parameter (name = "sourceFile", required = true)
private File m_aSourceFile;
/**
* The target preprocessed Schematron file.
*/
@Parameter (name = "targetFile", required = true)
private File m_aTargetFile;
/**
* Overwrite existing Schematron files without notice? If this is set to
* false than existing Schematron files are not overwritten.
*/
@Parameter (name = "overwriteWithoutNotice", defaultValue = "true")
private boolean m_bOverwriteWithoutNotice;
/**
* If this is set to false than <title>
* elements will be removed.
*/
@Parameter (name = "keepTitles", defaultValue = "false")
private boolean m_bKeepTitles;
/**
* If this is set to false than <diagnostics>
* elements will be removed.
*/
@Parameter (name = "keepDiagnostics", defaultValue = "false")
private boolean m_bKeepDiagnostics;
/**
* Should <report> elements be kept or should they be
* converted to <assert> elements?
*/
@Parameter (name = "keepReports", defaultValue = "false")
private boolean m_bKeepReports;
/**
* Should <pattern> elements without a single rule be kept
* or deleted?
*/
@Parameter (name = "keepEmptyPatterns", defaultValue = "false")
private boolean m_bKeepEmptyPatterns;
/**
* A constant header string that should be added to all preprocessed SCH
* files, e.g. as a version number etc.
*/
@Parameter (name = "schHeader")
@Since ("6.2.2")
private String m_sSCHHeader;
public void setSourceFile (@Nonnull final File aFile)
{
m_aSourceFile = aFile;
if (!m_aSourceFile.isAbsolute ())
m_aSourceFile = new File (project.getBasedir (), aFile.getPath ());
if (getLog ().isDebugEnabled ())
getLog ().debug ("Using Source file '" + m_aSourceFile + "'");
}
public void setTargetFile (@Nonnull final File aFile)
{
m_aTargetFile = aFile;
if (!m_aTargetFile.isAbsolute ())
m_aTargetFile = new File (project.getBasedir (), aFile.getPath ());
if (getLog ().isDebugEnabled ())
getLog ().debug ("Using Target file '" + m_aTargetFile + "'");
}
public void setOverwriteWithoutNotice (final boolean bOverwrite)
{
m_bOverwriteWithoutNotice = bOverwrite;
if (m_bOverwriteWithoutNotice)
getLog ().debug ("Overwriting Target file without notice");
else
getLog ().debug ("Ignoring existing Target file");
}
public void setKeepTitles (final boolean bKeepTitles)
{
m_bKeepTitles = bKeepTitles;
if (bKeepTitles)
getLog ().debug ("Keeping elements");
else
getLog ().debug ("Removing <title> elements");
}
public void setKeepDiagnostics (final boolean bKeepDiagnostics)
{
m_bKeepDiagnostics = bKeepDiagnostics;
if (bKeepDiagnostics)
getLog ().debug ("Keeping <diagnostic> elements");
else
getLog ().debug ("Removing <diagnostic> elements");
}
public void setKeepReports (final boolean bKeepReports)
{
m_bKeepReports = bKeepReports;
if (bKeepReports)
getLog ().debug ("Keeping <report> elements");
else
getLog ().debug ("Converting <report> to <assert> elements");
}
public void setKeepEmptyPatterns (final boolean bKeepEmptyPatterns)
{
m_bKeepEmptyPatterns = bKeepEmptyPatterns;
if (bKeepEmptyPatterns)
getLog ().debug ("Keeping <pattern> elements without rules");
else
getLog ().debug ("Removing <pattern> elements without rules");
}
public void setSchHeader (final String s)
{
m_sSCHHeader = s;
if (StringHelper.hasText (m_sSCHHeader))
getLog ().debug ("Using the SCH header '" + m_sSCHHeader + "'");
else
getLog ().debug ("No SCH header is configured");
}
public void execute () throws MojoExecutionException, MojoFailureException
{
if (m_aSourceFile == null)
throw new MojoExecutionException ("No Source file specified!");
if (m_aSourceFile.exists () && !m_aSourceFile.isFile ())
throw new MojoExecutionException ("The specified Source file " + m_aSourceFile + " is not a file!");
if (m_aTargetFile == null)
throw new MojoExecutionException ("No Target file specified!");
if (m_aTargetFile.exists ())
{
if (!m_bOverwriteWithoutNotice)
{
// 3.1 Not overwriting the existing file
getLog ().debug ("Skipping Target file '" + m_aTargetFile.getPath () + "' because it already exists!");
}
else
{
if (!m_aTargetFile.isFile ())
throw new MojoExecutionException ("The specified Target file " + m_aTargetFile + " is not a file!");
}
}
try
{
final PSSchema aSchema = new PSReader (new FileSystemResource (m_aSourceFile), null, null).readSchema ();
final IPSQueryBinding aQueryBinding = PSQueryBindingRegistry.getQueryBindingOfNameOrThrow (aSchema.getQueryBinding ());
final PSPreprocessor aPreprocessor = new PSPreprocessor (aQueryBinding).setKeepTitles (m_bKeepTitles)
.setKeepDiagnostics (m_bKeepDiagnostics)
.setKeepReports (m_bKeepReports)
.setKeepEmptyPatterns (m_bKeepEmptyPatterns);
// Pre-process
final PSSchema aPreprocessedSchema = aPreprocessor.getForcedPreprocessedSchema (aSchema);
if (aPreprocessedSchema == null)
throw new SchematronPreprocessException ("Failed to preprocess schema " +
aSchema +
" with query binding " +
aQueryBinding);
// Convert to XML string
final MapBasedNamespaceContext aNSCtx = new MapBasedNamespaceContext ();
aNSCtx.addDefaultNamespaceURI (CSchematron.NAMESPACE_SCHEMATRON);
aNSCtx.addMapping ("xsl", CSchematron.NAMESPACE_URI_XSL);
aNSCtx.addMapping ("svrl", CSVRL.SVRL_NAMESPACE_URI);
// Add all <ns> elements from schema as NS context
for (final PSNS aItem : aSchema.getAllNSs ())
aNSCtx.setMapping (aItem.getPrefix (), aItem.getUri ());
final IXMLWriterSettings aXWS = new XMLWriterSettings ().setIndent (EXMLSerializeIndent.INDENT_AND_ALIGN)
.setNamespaceContext (aNSCtx);
final IMicroDocument aDoc = new MicroDocument ();
if (StringHelper.hasText (m_sSCHHeader))
{
// Add the optional header as a comment
aDoc.appendComment (m_sSCHHeader);
}
aDoc.appendChild (aPreprocessedSchema.getAsMicroElement ());
if (MicroWriter.writeToFile (aDoc, m_aTargetFile, aXWS).isSuccess ())
getLog ().info ("Successfully wrote preprocessed Schematron file '" + m_aTargetFile.getPath () + "'");
else
getLog ().error ("Error writing preprocessed Schematron file to '" + m_aTargetFile.getPath () + "'");
}
catch (final SchematronException ex)
{
throw new MojoExecutionException ("Error preprocessing Schematron file '" + m_aSourceFile + "'", ex);
}
}
}
</code></pre> <br/>
<br/>
<div class='clear'></div>
</main>
</div>
<br/><br/>
<div class="align-center">© 2015 - 2025 <a href="/legal-notice.php">Weber Informatics LLC</a> | <a href="/data-protection.php">Privacy Policy</a></div>
<br/><br/><br/><br/><br/><br/>
</body>
</html>