Sophie

Sophie

distrib > Mageia > 7 > i586 > by-pkgid > b3bdfe6d859a3d6920ff2c44b38e9a6f > files > 2231

saxon-manual-9.4.0.9-2.mga7.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:50 GMT 2011 -->
<TITLE>
net.sf.saxon.lib
</TITLE>

<META NAME="date" CONTENT="2011-12-09">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="net.sf.saxon.lib";
    }
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">
<HR>


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../net/sf/saxon/java/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../net/sf/saxon/om/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?net/sf/saxon/lib/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<H2>
Package net.sf.saxon.lib
</H2>
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.
<P>
<B>See:</B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
<P>

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/CollationURIResolver.html" title="interface in net.sf.saxon.lib">CollationURIResolver</A></B></TD>
<TD>A CollationURIResolver accepts a collation name as input, and returns
 a collation (represented by a <A HREF="../../../../net/sf/saxon/lib/StringCollator.html" title="interface in net.sf.saxon.lib"><CODE>StringCollator</CODE></A> as output.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/CollectionURIResolver.html" title="interface in net.sf.saxon.lib">CollectionURIResolver</A></B></TD>
<TD>This interface defines a CollectionURIResolver.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/ExternalObjectModel.html" title="interface in net.sf.saxon.lib">ExternalObjectModel</A></B></TD>
<TD>This 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).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/Initializer.html" title="interface in net.sf.saxon.lib">Initializer</A></B></TD>
<TD>This interface can be implemented by users (there are no implementations in Saxon itself).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/ModuleURIResolver.html" title="interface in net.sf.saxon.lib">ModuleURIResolver</A></B></TD>
<TD>A ModuleURIResolver is used when resolving references to
 query modules.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/Numberer.html" title="interface in net.sf.saxon.lib">Numberer</A></B></TD>
<TD>Interface Numberer supports number formatting.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/OutputURIResolver.html" title="interface in net.sf.saxon.lib">OutputURIResolver</A></B></TD>
<TD>This interface defines an OutputURIResolver.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/RelativeURIResolver.html" title="interface in net.sf.saxon.lib">RelativeURIResolver</A></B></TD>
<TD>The standard JAXP URIResolver is given a relative URI and a base URI and returns the resource
 identified by this combination.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/SchemaURIResolver.html" title="interface in net.sf.saxon.lib">SchemaURIResolver</A></B></TD>
<TD>A SchemaURIResolver is used when resolving references to
 schema documents.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/SourceResolver.html" title="interface in net.sf.saxon.lib">SourceResolver</A></B></TD>
<TD>This interface defines a SourceResolver.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/StringCollator.html" title="interface in net.sf.saxon.lib">StringCollator</A></B></TD>
<TD>This interface represents a "collation" as defined in XPath, that is, a set of rules for comparing strings</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/SubstringMatcher.html" title="interface in net.sf.saxon.lib">SubstringMatcher</A></B></TD>
<TD>This 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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/TraceListener.html" title="interface in net.sf.saxon.lib">TraceListener</A></B></TD>
<TD>This interface defines methods that are called by Saxon during the execution of
 a stylesheet, if tracing is switched on.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/UnparsedTextURIResolver.html" title="interface in net.sf.saxon.lib">UnparsedTextURIResolver</A></B></TD>
<TD>An UnparsedTextURIResolver accepts an absolute URI and optionally an encoding name as input,
 and returns a Reader as its result.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/URIChecker.html" title="interface in net.sf.saxon.lib">URIChecker</A></B></TD>
<TD>This interface defines a method for checking whether a string is considered to be a valid URI.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/ValidationStatisticsRecipient.html" title="interface in net.sf.saxon.lib">ValidationStatisticsRecipient</A></B></TD>
<TD>Defines a class that is notified of validation statistics at the end of a validation episode</TD>
</TR>
</TABLE>
&nbsp;

<P>

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html" title="class in net.sf.saxon.lib">AugmentedSource</A></B></TD>
<TD>This class is an extension of the JAXP Source interface.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/ConversionRules.html" title="class in net.sf.saxon.lib">ConversionRules</A></B></TD>
<TD>This class defines a set of rules for converting between different atomic types.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/ExtensionFunctionCall.html" title="class in net.sf.saxon.lib">ExtensionFunctionCall</A></B></TD>
<TD>This 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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/ExtensionFunctionDefinition.html" title="class in net.sf.saxon.lib">ExtensionFunctionDefinition</A></B></TD>
<TD>This 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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/FeatureKeys.html" title="class in net.sf.saxon.lib">FeatureKeys</A></B></TD>
<TD>FeatureKeys 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 <A HREF="../../../../net/sf/saxon/s9api/Processor.html" title="class in net.sf.saxon.s9api"><CODE>Processor</CODE></A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/LocalizerFactory.html" title="class in net.sf.saxon.lib">LocalizerFactory</A></B></TD>
<TD>Interface allowing localization modules for different languages to be dynamically loaded</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/NamespaceConstant.html" title="class in net.sf.saxon.lib">NamespaceConstant</A></B></TD>
<TD>This class is not instantiated, it exists to hold a set of constants representing known
 namespaces.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/ParseOptions.html" title="class in net.sf.saxon.lib">ParseOptions</A></B></TD>
<TD>This class defines options for parsing a source document</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/SaxonOutputKeys.html" title="class in net.sf.saxon.lib">SaxonOutputKeys</A></B></TD>
<TD>Provides string constants that can be used to set
 output properties for a Transformer, or to retrieve
 output properties from a Transformer or Templates object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/SerializerFactory.html" title="class in net.sf.saxon.lib">SerializerFactory</A></B></TD>
<TD>Helper class to construct a serialization pipeline for a given result destination
 and a given set of output properties.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/StandardCollationURIResolver.html" title="class in net.sf.saxon.lib">StandardCollationURIResolver</A></B></TD>
<TD>StandardCollationURIResolver allows a Collation to be created given
 a URI starting with "http://saxon.sf.net/collation" followed by a set of query parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/StandardCollectionURIResolver.html" title="class in net.sf.saxon.lib">StandardCollectionURIResolver</A></B></TD>
<TD>This class implements the default collection URI Resolver.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/StandardEntityResolver.html" title="class in net.sf.saxon.lib">StandardEntityResolver</A></B></TD>
<TD>This class is an EntityResolver used to resolve references to common
 DTDs and entity files, using local copies provided with the Saxon product.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/StandardErrorHandler.html" title="class in net.sf.saxon.lib">StandardErrorHandler</A></B></TD>
<TD>A default implementation of the SAX ErrorHandler interface.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/StandardErrorListener.html" title="class in net.sf.saxon.lib">StandardErrorListener</A></B></TD>
<TD><B>StandardErrorListener</B> is the standard error handler for XSLT and XQuery processing
 errors, used if no other ErrorListener is nominated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/StandardModuleURIResolver.html" title="class in net.sf.saxon.lib">StandardModuleURIResolver</A></B></TD>
<TD>This class is the standard ModuleURIResolver used to implement the "import module" declaration
 in a Query Prolog.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/StandardOutputResolver.html" title="class in net.sf.saxon.lib">StandardOutputResolver</A></B></TD>
<TD>This class defines the default OutputURIResolver.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/StandardUnparsedTextResolver.html" title="class in net.sf.saxon.lib">StandardUnparsedTextResolver</A></B></TD>
<TD>Default implementation of the UnparsedTextURIResolver, used if no other implementation
 is nominated to the Configuration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/StandardURIChecker.html" title="class in net.sf.saxon.lib">StandardURIChecker</A></B></TD>
<TD>This class checks whether a string is a valid URI.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/StandardURIResolver.html" title="class in net.sf.saxon.lib">StandardURIResolver</A></B></TD>
<TD>This class provides the service of converting a URI into an InputSource.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/lib/Validation.html" title="class in net.sf.saxon.lib">Validation</A></B></TD>
<TD>This class contains constants and static methods to manipulate the validation
 property of a type.</TD>
</TR>
</TABLE>
&nbsp;

<P>
<A NAME="package_description"><!-- --></A><H2>
Package net.sf.saxon.lib Description
</H2>

<P>
<p>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.</p>

<p>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.</p>


<hr>

<p align="center"><i>Michael H. Kay<br/>
Saxonica Limited<br/>
20 July 2010</i></p>
<P>

<P>
<DL>
</DL>
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../net/sf/saxon/java/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../net/sf/saxon/om/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?net/sf/saxon/lib/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>