Package net.sf.saxon

Interface Platform

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    JavaPlatform

    public interface Platform
    extends java.io.Serializable
    This interface provides access to methods whose implementation depends on the chosen platform (typically Java or .NET)
    • Method Detail

      • initialize

        void initialize​(Configuration config)
        Perform platform-specific initialization of the configuration
        Parameters:
        config - the Saxon Configuration
      • isJava

        boolean isJava()
        Return true if this is the Java platform
        Returns:
        true if this is the Java platform
      • isDotNet

        boolean isDotNet()
        Return true if this is the .NET platform
        Returns:
        true if this is the .NET platform
      • getVerifierClassName

        java.lang.String getVerifierClassName()
        Get the verifier class name appropriate to the platform
      • getPlatformVersion

        java.lang.String getPlatformVersion()
        Get the platform version
        Returns:
        the version of the platform, for example "Java version 1.5.09"
      • getPlatformSuffix

        java.lang.String getPlatformSuffix()
        Get a suffix letter to add to the Saxon version number to identify the platform
        Returns:
        "J" for Java, "N" for .NET
      • loadParser

        org.xml.sax.XMLReader loadParser()
        Get a parser by instantiating the SAXParserFactory
        Returns:
        the parser (XMLReader)
      • getParserSource

        javax.xml.transform.Source getParserSource​(PipelineConfiguration pipe,
                                                   javax.xml.transform.stream.StreamSource input,
                                                   int validation,
                                                   boolean dtdValidation,
                                                   int stripspace)
        Convert a StreamSource to either a SAXSource or a PullSource, depending on the native parser of the selected platform
        Parameters:
        pipe - the pipeline Configuration
        input - the supplied StreamSource
        validation - required validation mode, for example Validation.STRICT
        dtdValidation - true if DTD-based input validation is required
        stripspace - option for whitespace-stripping (ALL, NONE, or IGNORABLE)
        Returns:
        the PullSource or SAXSource, initialized with a suitable parser, or the original input Source, if now special handling is required or possible
      • makeCollation

        StringCollator makeCollation​(Configuration config,
                                     java.util.Properties props,
                                     java.lang.String uri)
                              throws XPathException
        Obtain a collation with a given set of properties. The set of properties is extensible and variable across platforms. Common properties with example values include lang=en-GB, strength=primary, case-order=upper-first, ignore-modifiers=yes, alphanumeric=yes. Properties that are not supported are generally ignored; however some errors, such as failing to load a requested class, are fatal.
        Parameters:
        config - the configuration object
        props - the desired properties of the collation
        uri - the collation URI
        Returns:
        a collation with these properties
        Throws:
        XPathException - if a fatal error occurs
      • canReturnCollationKeys

        boolean canReturnCollationKeys​(StringCollator collation)
        Given a collation, determine whether it is capable of returning collation keys. The essential property of collation keys is that if two values are equal under the collation, then the collation keys are equal under the equals() method.
        Parameters:
        collation - the collation being examined, provided as a Comparator
        Returns:
        true if this collation can supply collation keys
      • getCollationKey

        java.lang.Object getCollationKey​(SimpleCollation namedCollation,
                                         java.lang.String value)
        Given a collation, get a collation key. The essential property of collation keys is that if two values are equal under the collation, then the collation keys are equal under the equals() method.
        Parameters:
        namedCollation - the collation in use
        value - the string whose collation key is required
        Returns:
        a representation of the collation key, such that two collation keys are equal() if and only if the string values they represent are equal under the specified collation.
        Throws:
        java.lang.ClassCastException - if the collation is not one that is capable of supplying collation keys (this should have been checked in advance)
      • getExternalObjectType

        SchemaType getExternalObjectType​(Configuration config,
                                         java.lang.String uri,
                                         java.lang.String localName)
        Get a SchemaType representing a wrapped external (Java or .NET) object
        Parameters:
        config - the Saxon Configuration
        uri - the namespace URI of the schema type
        localName - the local name of the schema type
        Returns:
        the SchemaType object representing this type
      • getInstallationDirectory

        java.lang.String getInstallationDirectory​(java.lang.String edition,
                                                  Configuration config)
        Return the name of the directory in which the software is installed (if available)
        Parameters:
        edition - The edition of the software that is loaded ("HE", "PE", or "EE")
        config - the Saxon configuration
        Returns:
        the name of the directory in which Saxon is installed, if available, or null otherwise
      • registerAllBuiltInObjectModels

        void registerAllBuiltInObjectModels​(Configuration config)
        Register all the external object models that are provided as standard with the relevant edition of Saxon for this Configuration
        Since:
        9.3
      • setDefaultSAXParserFactory

        void setDefaultSAXParserFactory()
        Set the default XML parser to be loaded by the SAXParserFactory on this platform. Needed because the Apache catalog resolver uses the SAXParserFactory to instantiate a parser, and if not customized this causes a failure on the .NET platform.
        Since:
        9.4
      • getClassLoaderForGeneratedClass

        java.lang.ClassLoader getClassLoaderForGeneratedClass​(java.lang.String definedClassName,
                                                              byte[] classFile,
                                                              Configuration config,
                                                              java.lang.Class thisClass)
        Return the class loader required to load the bytecode generated classes
        Parameters:
        definedClassName - The generated class name
        classFile - The bytecode of the generated class
        config - The cThe saxon configuration
        thisClass - The class object generated
        Returns:
        the class loader object
        Since:
        9.4