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
      • makeAbsolute

        java.net.URI makeAbsolute​(java.lang.String relativeURI,
                                  java.lang.String base)
                           throws java.net.URISyntaxException
        Construct an absolute URI from a relative URI and a base URI
        Parameters:
        relativeURI - the relative URI. Null is permitted provided that the base URI is an absolute URI
        base - the base URI
        Returns:
        the absolutized URI
        Throws:
        java.net.URISyntaxException
      • 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
      • 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
      • compileRegularExpression

        RegularExpression compileRegularExpression​(java.lang.CharSequence regex,
                                                   int xmlVersion,
                                                   int syntax,
                                                   java.lang.CharSequence flags)
                                            throws XPathException
        Create a compiled regular expression
        Parameters:
        regex - the source text of the regular expression, in XML Schema or XPath syntax
        xmlVersion - version of XML in use (1.0 or 1.1)
        syntax -
        flags - the flags argument as supplied to functions such as fn:matches(), in string form @throws XPathException if the syntax of the regular expression or flags is incorrect @return the compiled regular expression
        Throws:
        XPathException
      • 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=ed-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​(NamedCollation 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)
      • makeExtensionLibrary

        void makeExtensionLibrary​(Configuration config)
        Make the default extension function library (or libraries) appropriate to the platform, and register them with the Configuration. Note that this does not actually add the libraries to any library list.
        Parameters:
        config - the Saxon Configuration
      • declareJavaClass

        void declareJavaClass​(FunctionLibrary library,
                              java.lang.String uri,
                              java.lang.Class theClass)
        Register a namespace-to-Java-class mapping declared using saxon:script in an XSLT stylesheet
        Parameters:
        library - the library to contain the function, which must be a JavaExtensionLibrary
        uri - the namespace of the function name
        theClass - the Java class that implements this namespace
      • 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