net.sf.saxon.java

Class JavaPlatform

Implemented Interfaces:
Platform, Serializable

public class JavaPlatform
extends java.lang.Object
implements Platform

Implementation of the Platform class containing methods specific to the Java platform (as distinct from .NET). This is a singleton class with no instance data.

Method Summary

void
addFunctionLibraries(FunctionLibraryList list, Configuration config)
Add the platform-specific function libraries to a function library list.
boolean
canReturnCollationKeys(StringCollator collation)
Given a collation, determine whether it is capable of returning collation keys.
RegularExpression
compileRegularExpression(CharSequence regex, int xmlVersion, int syntax, CharSequence flags)
Create a compiled regular expression
void
declareJavaClass(FunctionLibrary library, String uri, Class theClass)
Register a namespace-to-Java-class mapping declared using saxon:script in an XSLT stylesheet
Object
getCollationKey(NamedCollation namedCollation, String value)
Given a collation, get a collation key.
SchemaType
getExternalObjectType(Configuration config, String uri, String localName)
static JavaPlatform
getInstance()
Source
getParserSource(Configuration config, 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
String
getPlatformSuffix()
Get a suffix letter to add to the Saxon version number to identify the platform
String
getPlatformVersion()
Get the platform version
void
initialize(Configuration config)
Perform platform-specific initialization of the configuration
boolean
isDotNet()
Return true if this is the .NET platform
boolean
isJava()
Return true if this is the Java platform
URI
makeAbsolute(String relativeURI, String base)
Construct an absolute URI from a relative URI and a base URI.
StringCollator
makeCollation(Configuration config, Properties props, String uri)
Obtain a collation with a given set of properties.
void
makeExtensionLibrary(Configuration config)
Make the default extension function factory appropriate to the platform

Method Details

addFunctionLibraries

public void addFunctionLibraries(FunctionLibraryList list,
                                 Configuration config)
Add the platform-specific function libraries to a function library list. The libraries that are added are those registered with the Configuration using Configuration.setExtensionBinder(String,FunctionLibrary)
Specified by:
addFunctionLibraries in interface Platform
Parameters:
list - the function library list that is to be extended
config - the Configuration

canReturnCollationKeys

public 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.
Specified by:
canReturnCollationKeys in interface Platform
Parameters:
collation - the collation, provided as a Comparator
Returns:
true if this collation can supply collation keys

compileRegularExpression

public RegularExpression compileRegularExpression(CharSequence regex,
                                                  int xmlVersion,
                                                  int syntax,
                                                  CharSequence flags)
            throws XPathException
Create a compiled regular expression
Specified by:
compileRegularExpression in interface Platform
Parameters:
regex - the source text of the regular expression, in XML Schema or XPath syntax
xmlVersion - set to integer 10 for XML 1.0, 11 for XML 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

declareJavaClass

public void declareJavaClass(FunctionLibrary library,
                             String uri,
                             Class theClass)
Register a namespace-to-Java-class mapping declared using saxon:script in an XSLT stylesheet
Specified by:
declareJavaClass in interface Platform
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

getCollationKey

public Object getCollationKey(NamedCollation namedCollation,
                              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 compare correctly under the equals() method.
Specified by:
getCollationKey in interface Platform

getExternalObjectType

public SchemaType getExternalObjectType(Configuration config,
                                        String uri,
                                        String localName)
Specified by:
getExternalObjectType in interface Platform

getInstance

public static JavaPlatform getInstance()

getParserSource

public Source getParserSource(Configuration config,
                              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
Specified by:
getParserSource in interface Platform
Parameters:
config -
input - the supplied StreamSource
validation -
dtdValidation -
stripspace -
Returns:
the PullSource or SAXSource, initialized with a suitable parser, or the original input Source, if now special handling is required or possible. This implementation always returns the original input unchanged.

getPlatformSuffix

public String getPlatformSuffix()
Get a suffix letter to add to the Saxon version number to identify the platform
Specified by:
getPlatformSuffix in interface Platform

getPlatformVersion

public String getPlatformVersion()
Get the platform version
Specified by:
getPlatformVersion in interface Platform

initialize

public void initialize(Configuration config)
Perform platform-specific initialization of the configuration
Specified by:
initialize in interface Platform

isDotNet

public boolean isDotNet()
Return true if this is the .NET platform
Specified by:
isDotNet in interface Platform

isJava

public boolean isJava()
Return true if this is the Java platform
Specified by:
isJava in interface Platform

makeAbsolute

public URI makeAbsolute(String relativeURI,
                        String base)
            throws URISyntaxException
Construct an absolute URI from a relative URI and a base URI. The method uses the resolve method of the java.net.URI class, except where the base URI uses the (non-standard) "jar:" scheme, in which case the method used is new URL(baseURL, relativeURL).

Spaces in either URI are converted to %20

If no base URI is available, and the relative URI is not an absolute URI, then the current directory is used as a base URI.

Specified by:
makeAbsolute in interface Platform
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

makeCollation

public StringCollator makeCollation(Configuration config,
                                    Properties props,
                                    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.
Specified by:
makeCollation in interface Platform
Parameters:
config - the configuration object
props - the desired properties of the collation
uri -
Returns:
a collation with these properties
Throws:
XPathException - if a fatal error occurs

makeExtensionLibrary

public void makeExtensionLibrary(Configuration config)
Make the default extension function factory appropriate to the platform
Specified by:
makeExtensionLibrary in interface Platform