com.helger.schematron.schxslt.xslt2.SchematronResourceSchXslt_XSLT2 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-schematron-schxslt Show documentation
Show all versions of ph-schematron-schxslt Show documentation
Library for validating XML documents using the SchXslt implementation
/*
* Copyright (C) 2020-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.schematron.schxslt.xslt2;
import java.io.File;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.charset.Charset;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.annotation.OverrideOnDemand;
import com.helger.commons.io.resource.ClassPathResource;
import com.helger.commons.io.resource.FileSystemResource;
import com.helger.commons.io.resource.IReadableResource;
import com.helger.commons.io.resource.URLResource;
import com.helger.commons.io.resource.inmemory.ReadableResourceByteArray;
import com.helger.commons.io.resource.inmemory.ReadableResourceInputStream;
import com.helger.schematron.api.xslt.AbstractSchematronXSLTBasedResource;
import com.helger.schematron.api.xslt.ISchematronXSLTBasedProvider;
/**
* A Schematron resource that is based on the original SCH file. It uses SchXslt
* to convert SCH to XSLT.
*
* @author Philip Helger
*/
@NotThreadSafe
public class SchematronResourceSchXslt_XSLT2 extends
AbstractSchematronXSLTBasedResource
{
private String m_sPhase;
private String m_sLanguageCode;
private boolean m_bForceCacheResult = TransformerCustomizerSchXslt_XSLT2.DEFAULT_FORCE_CACHE_RESULT;
/**
* Constructor
*
* @param aSCHResource
* The Schematron resource. May not be null.
*/
public SchematronResourceSchXslt_XSLT2 (@Nonnull final IReadableResource aSCHResource)
{
super (aSCHResource);
// Avoid creating the SVRL Metadata, because it is not schema compliant
parameters ().put ("schxslt.compile.metadata", "false");
}
@Nullable
public final String getPhase ()
{
return m_sPhase;
}
public final void setPhase (@Nullable final String sPhase)
{
m_sPhase = sPhase;
}
@Nullable
public final String getLanguageCode ()
{
return m_sLanguageCode;
}
public final void setLanguageCode (@Nullable final String sLanguageCode)
{
m_sLanguageCode = sLanguageCode;
}
/**
* @return true if internal caching of the result should be
* forced, false if not.
*/
public final boolean isForceCacheResult ()
{
return m_bForceCacheResult;
}
/**
* Force the caching of results. This only applies when Schematron to XSLT
* conversion is performed.
*
* @param bForceCacheResult
* true to force result caching, false to
* cache only if no parameters are present.
*/
public final void setForceCacheResult (final boolean bForceCacheResult)
{
m_bForceCacheResult = bForceCacheResult;
}
@Nonnull
protected final TransformerCustomizerSchXslt_XSLT2 applyDefaultValuesOnTransformerCustomizer (@Nonnull final TransformerCustomizerSchXslt_XSLT2 aTC)
{
ValueEnforcer.notNull (aTC, "TransformerCustomizer");
aTC.setErrorListener (getErrorListener ())
.setURIResolver (getURIResolver ())
.setParameters (parameters ())
.setPhase (m_sPhase)
.setLanguageCode (m_sLanguageCode)
.setForceCacheResult (m_bForceCacheResult);
return aTC;
}
@Nonnull
@OverrideOnDemand
protected TransformerCustomizerSchXslt_XSLT2 createTransformerCustomizer ()
{
return applyDefaultValuesOnTransformerCustomizer (new TransformerCustomizerSchXslt_XSLT2 ());
}
@Override
@Nullable
public ISchematronXSLTBasedProvider getXSLTProvider ()
{
final TransformerCustomizerSchXslt_XSLT2 aTransformerCustomizer = createTransformerCustomizer ();
if (isUseCache ())
return SchematronResourceSchXslt_XSLT2Cache.getSchematronXSLTProvider (getResource (), aTransformerCustomizer);
// Always create a new one
return SchematronResourceSchXslt_XSLT2Cache.createSchematronXSLTProvider (getResource (), aTransformerCustomizer);
}
/**
* Create a new {@link SchematronResourceSchXslt_XSLT2} resource.
*
* @param sSCHPath
* The classpath relative path to the Schematron file. May neither be
* null nor empty.
* @return Never null.
*/
@Nonnull
public static SchematronResourceSchXslt_XSLT2 fromClassPath (@Nonnull @Nonempty final String sSCHPath)
{
return new SchematronResourceSchXslt_XSLT2 (new ClassPathResource (sSCHPath));
}
/**
* Create a new {@link SchematronResourceSchXslt_XSLT2} resource.
*
* @param sSCHPath
* The classpath relative path to the Schematron file. May neither be
* null nor empty.
* @param aClassLoader
* The class loader to be used to retrieve the classpath resource. May
* be null.
* @return Never null.
* @since 6.0.4
*/
@Nonnull
public static SchematronResourceSchXslt_XSLT2 fromClassPath (@Nonnull @Nonempty final String sSCHPath,
@Nullable final ClassLoader aClassLoader)
{
return new SchematronResourceSchXslt_XSLT2 (new ClassPathResource (sSCHPath, aClassLoader));
}
/**
* Create a new {@link SchematronResourceSchXslt_XSLT2} resource.
*
* @param sSCHPath
* The file system path to the Schematron file. May neither be
* null nor empty.
* @return Never null.
*/
@Nonnull
public static SchematronResourceSchXslt_XSLT2 fromFile (@Nonnull @Nonempty final String sSCHPath)
{
return new SchematronResourceSchXslt_XSLT2 (new FileSystemResource (sSCHPath));
}
/**
* Create a new {@link SchematronResourceSchXslt_XSLT2} resource.
*
* @param aSCHFile
* The Schematron file. May not be null.
* @return Never null.
*/
@Nonnull
public static SchematronResourceSchXslt_XSLT2 fromFile (@Nonnull final File aSCHFile)
{
return new SchematronResourceSchXslt_XSLT2 (new FileSystemResource (aSCHFile));
}
/**
* Create a new {@link SchematronResourceSchXslt_XSLT2} from Schematron rules
* provided at a URL
*
* @param sSCHURL
* The URL to the Schematron rules. May neither be null
* nor empty.
* @return Never null.
* @throws MalformedURLException
* In case an invalid URL is provided
* @since 6.2.5
*/
@Nonnull
public static SchematronResourceSchXslt_XSLT2 fromURL (@Nonnull @Nonempty final String sSCHURL) throws MalformedURLException
{
return new SchematronResourceSchXslt_XSLT2 (new URLResource (sSCHURL));
}
/**
* Create a new {@link SchematronResourceSchXslt_XSLT2} from Schematron rules
* provided at a URL
*
* @param aSCHURL
* The URL to the Schematron rules. May not be null.
* @return Never null.
* @since 6.2.5
*/
@Nonnull
public static SchematronResourceSchXslt_XSLT2 fromURL (@Nonnull final URL aSCHURL)
{
return new SchematronResourceSchXslt_XSLT2 (new URLResource (aSCHURL));
}
/**
* Create a new {@link SchematronResourceSchXslt_XSLT2} from Schematron rules
* provided by an arbitrary {@link InputStream}.
*
* @param sResourceID
* Resource ID to be used as the cache key. Should neither be
* null nor empty.
* @param aSchematronIS
* The {@link InputStream} to read the Schematron rules from. May not
* be null.
* @return Never null.
* @since 6.2.5
*/
@Nonnull
public static SchematronResourceSchXslt_XSLT2 fromInputStream (@Nonnull @Nonempty final String sResourceID,
@Nonnull final InputStream aSchematronIS)
{
return new SchematronResourceSchXslt_XSLT2 (new ReadableResourceInputStream (sResourceID, aSchematronIS));
}
/**
* Create a new {@link SchematronResourceSchXslt_XSLT2} from Schematron rules
* provided by an arbitrary byte array.
*
* @param aSchematron
* The byte array representing the Schematron. May not be
* null.
* @return Never null.
* @since 6.2.5
*/
@Nonnull
public static SchematronResourceSchXslt_XSLT2 fromByteArray (@Nonnull final byte [] aSchematron)
{
return new SchematronResourceSchXslt_XSLT2 (new ReadableResourceByteArray (aSchematron));
}
/**
* Create a new {@link SchematronResourceSchXslt_XSLT2} from Schematron rules
* provided by an arbitrary String.
*
* @param sSchematron
* The String representing the Schematron. May not be null
* .
* @param aCharset
* The charset to be used to convert the String to a byte array.
* @return Never null.
* @since 6.2.5
*/
@Nonnull
public static SchematronResourceSchXslt_XSLT2 fromString (@Nonnull final String sSchematron,
@Nonnull final Charset aCharset)
{
return fromByteArray (sSchematron.getBytes (aCharset));
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy