This package collects together interfaces intended for user applications to implement in order to customize Saxon's behavior, default implementations of these interfaces, and classes containing constants that are used in public Saxon interfaces.
These interfaces were brought together into this package in Saxon 9.3, having previously been dispersed around the package hierarchy and mixed with classes and interfaces intended only for internal use.
Interface Summary Interface Description ActiveSourceAn ActiveSource is a Source that is capable of delivering an XML document to a Receiver; CollationURIResolverA CollationURIResolver accepts a collation name as input, and returns a collation (represented by a
CollectionFinderAn instance of CollectionFinder can be registered with the Saxon configuration; it is called in response to calls on the fn:collection() and fn:uri-collection() functions. ConfigurableResourceResolverA ResourceResolver that allows properties to be set and examined EnvironmentVariableResolverThis interface defines a Saxon plug-in used to resolve calls on the XPath 3.0 functions available-environment-variables() and environment-variable(). ErrorReporterThe ErrorReporter is a generic functional interface for reporting errors and warnings. ExternalObjectModelThis interface must be implemented by any third-party object model that can be wrapped with a wrapper that implements the Saxon Object Model (the NodeInfo interface). FunctionAnnotationHandlerInterface to a user-supplied class that handles XQuery annotation assertions in a particular namespace. IDynamicLoaderInterface to a class used to perform dynamic loading of classes such as user-hook implementations, as well as product-supplied resources like stylesheets and DTDs. InitializerThis interface can be implemented by users (there are no implementations in Saxon itself). InvalidityAn
Invalidityis a validation error, that is, a failure of the instance document to conform to the schema being used for validation.
InvalidityHandlerInterface for reporting validation errors found during validation of an instance document against a schema. ModuleURIResolverA ModuleURIResolver is used when resolving references to query modules. NumbererInterface Numberer supports number formatting. OutputURIResolverThis interface defines an OutputURIResolver. RelativeURIResolverThe standard JAXP URIResolver is given a relative URI and a base URI and returns the resource identified by this combination. ResourceThis interface defines a Resource. ResourceCollectionThis interface defines a ResourceCollection. ResourceFactoryA ResourceFactory is used for constructing a particular type of resource ResourceResolverInterface for processing a resource request to deliver a resource ResultDocumentResolverThe
ResultDocumentResolverinterface may be implemented by a user application; it is a callback that is called whenever an xsl:result-document instruction is executed.
SchemaURIResolverA SchemaURIResolver is used when resolving references to schema documents. SourceResolverThis interface defines a SourceResolver. StAXResultHandlerStAxResultHandler is a helper class StringCollatorThis interface represents a "collation" as defined in XPath, that is, a set of rules for comparing strings SubstringMatcherThis interface is implemented by a collation that is capable of supporting the XPath functions that require matching of a substring: namely contains(), starts-with, ends-with, substring-before, and substring-after. TraceListenerThis interface defines methods that are called by Saxon during the execution of a stylesheet or query, if tracing is switched on. UnparsedTextURIResolverAn UnparsedTextURIResolver accepts an absolute URI and optionally an encoding name as input, and returns a Reader as its result. URICheckerThis interface defines a method for checking whether a string is considered to be a valid URI. ValidationStatisticsRecipientDefines a class that is notified of validation statistics at the end of a validation episode
Class Summary Class Description AugmentedSourceThis class is an extension of the JAXP Source interface. CatalogResourceResolverThe standard implementation of the
ResourceResolverinterface for use with catalogs.
ChainedEntityResolverAn EntityResolver that first tries one supplied EntityResolver, and if that returns null, falls back to another. ChainedResourceResolverAn ResourceResolver that first tries one supplied ResourceResolver, and if that returns null, falls back to another. ConversionRulesThis class defines a set of rules for converting between different atomic types. DirectResourceResolverA
ResourceResolverthat resolves requests using the direct, native capabilities of the platform.
EmptySourceThis class is an implementation of the JAXP Source interface. EntityResolverWrappingResourceResolverAn implementation of the SAX
EntityResolver2interface implemented by calling a supplied
ErrorReporterToListenerA bridging class that allows errors in an XSLT Transformation, or in a Query, to be reported to a JAXP
ExtensionFunctionCallThis abstract class is provided to allow user-written extension functions to be implemented with the full capabilities of functions that are an intrinsic part of the Saxon product. ExtensionFunctionDefinitionThis abstract class is provided to allow user-written extension functions to be implemented with the full capabilities of functions that are an intrinsic part of the Saxon product. Feature<T>Feature defines a set of constants, representing the details of Saxon configuration options which can be supplied to the Saxon method Configuration.setProperty(), and to other interfaces FeatureCodeFeatureCode defines a set of integer constants, representing unique identifiers for the features that can be configured. FeatureData FeatureIndex FeatureKeysFeatureKeys defines a set of constants, representing the names of Saxon configuration options which can be supplied to the Saxon implementations of the JAXP interfaces TransformerFactory, SchemaFactory, Validator, and ValidationHandler, and to other interfaces such as the s9api
InvalidityHandlerWrappingErrorListenerInterface for reporting validation errors found during validation of an instance document against a schema. InvalidityHandlerWrappingErrorReporterInterface for reporting validation errors found during validation of an instance document against a schema. InvalidityReportGeneratorThis class
InvalidityReportGeneratorextends the standard error handler for errors found during validation of an instance document against a schema, used if user specifies -report option on validate.
LocalizerFactoryInterface allowing localization modules for different languages to be dynamically loaded LoggerInterface to diagnostic event logging mechanism. NamespaceConstantThis class is not instantiated, it exists to hold a set of constants representing known namespaces. OutputURIResolverWrapperThis class is an implementation of the
ResultDocumentResolverinterface that wraps a supplied
ParseOptionsThis class defines options for parsing and/or validating a source document. ProtocolRestrictorThis class implements the rules in a property such as
XMLConstants.ACCESS_EXTERNAL_SCHEMA, which constrain the set of URIs that can be used by supplying a list of permitted protocols.
RawResultThis class is an implementation of the JAXP Result interface. ResourceRequestA bundle of information made available when requesting resource resolution. ResourceResolverDelegateConvenience class to allow a ResourceResolver to be implemented as a lambda expression. ResourceResolverWrappingURIResolverA
ResourceResolverimplemented by wrapping a supplied
SaxonOutputKeysProvides string constants that can be used to set output properties for a Transformer, or to retrieve output properties from a Transformer or Templates object. SerializerFactoryHelper class to construct a serialization pipeline for a given result destination and a given set of output properties. StandardCollationURIResolverStandardCollationURIResolver allows a Collation to be created given a URI starting with "http://saxon.sf.net/collation" followed by a set of query parameters. StandardDiagnosticsThis class is an abstract superclass of classes such as the
StandardInvalidityHandler, and exists to provide common utility methods for these classes, and for similar user-written classes if required
StandardEnvironmentVariableResolverDefault implementation of the
StandardErrorHandlerA default implementation of the SAX ErrorHandler interface. StandardErrorListenerStandardErrorListener is the standard error handler for XSLT and XQuery processing errors, used if no other ErrorListener is nominated. StandardErrorReporterStandardErrorReporter is the standard error handler for processing XSLT and XQuery static errors, used if no other error handler is nominated. StandardInvalidityHandlerThis class
StandardInvalidityHandler, despite its name, is not directly used by Saxon, and in particular it is NOT the default InvalidityHandler.
StandardLoggerThe default Logger used by Saxon on the Java platform. StandardMessageHandlerThis is the default implementation of the new Saxon 11 interface for user-defined handling of
StandardModuleURIResolverThis class is the standard ModuleURIResolver used to implement the "import module" declaration in a Query Prolog. StandardOutputResolverThis class defines the default OutputURIResolver. StandardResultDocumentResolverThis class defines the default ResultDocumentResolver. StandardUnparsedTextResolverDefault implementation of the UnparsedTextURIResolver, used if no other implementation is nominated to the Configuration. StandardURICheckerThis class checks whether a string is a valid URI. StandardURIResolverThis class provides the service of converting a URI into an
StaticQueryContextFactoryFactory class for creating a customized instance of StaticQueryContext SystemLoggerAn implementation of Saxon's
Loggerinterface that writes all messages through to a supplied
ValidationThis class contains constants and static methods to manipulate the validation property of a type. XQueryFunctionAnnotationHandlerFunction annotation handler for annotations in the built-in namespace http://www.w3.org/2012/xquery.