Java Doc for Configuration.java in  » XML » saxonb » net » sf » saxon » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » XML » saxonb » net.sf.saxon 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   net.sf.saxon.Configuration

Configuration
public class Configuration implements Serializable,SourceResolver(Code)
This class holds details of user-selected configuration options for a transformation or query. When running XSLT, the preferred way of setting configuration options is via the JAXP TransformerFactory interface, but the Configuration object provides a finer level of control. As yet there is no standard API for XQuery, so the only way of setting Configuration information is to use the methods on this class directly.

Since Saxon 8.4, the JavaDoc documentation for Saxon attempts to identify interfaces that are considered stable, and will only be changed in a backwards-incompatible way if there is an overriding reason to do so. These interfaces and methods are labelled with the JavaDoc "since" tag. The value 8.n indicates a method in this category that was introduced in Saxon version 8.n: or in the case of 8.4, that was present in Saxon 8.4 and possibly in earlier releases. (In some cases, these methods have been unchanged for a long time.) Methods without a "since" tag, although public, are provided for internal use or for use by advanced users, and are subject to change from one release to the next. The presence of a "since" tag on a class or interface indicates that there are one or more methods in the class that are considered stable; it does not mean that all methods are stable.
since:
   8.4



Field Summary
final public static  intDO_NOT_RECOVER
     Constant indicating that when a recoverable error occurs, the processor should not attempt to take the defined recovery action, but should terminate with an error.
final public static  intJAVA_APPLICATION
    
final public static  intRECOVER_SILENTLY
     Constant indicating that the processor should take the recovery action when a recoverable error occurs, with no warning message.
final public static  intRECOVER_WITH_WARNINGS
     Constant indicating that the processor should produce a warning when a recoverable error occurs, and should then take the recovery action and continue.
final public static  intXML10
    
final public static  intXML11
    
final public static  intXML_SCHEMA
    
final public static  intXPATH
    
final public static  intXQUERY
    
final public static  intXSLT
    
protected transient  ErrorListenerlistener
    
protected  Optimizeroptimizer
    
protected  intrecoveryPolicy
    
protected  VendorFunctionLibraryvendorFunctionLibrary
    

Constructor Summary
public  Configuration()
     Create a configuration object with default settings for all options.

Method Summary
public  voidaddSchema(Object schema)
     Add a schema to the cache.
public  voidaddSchemaSource(Source schemaSource)
     Load a schema, which will be available for use by all subsequent operations using this Configuration.
public  booleanareAllNodesUntyped()
    
public  voiddisplayLicenseMessage()
    
public  ExternalObjectModelfindExternalObjectModel(Object node)
     Find the external object model corresponding to a given node.
public  ReceivergetAnnotationStripper(Receiver destination)
     Add to a pipeline a receiver that strips all type annotations.
public  SchemaDeclarationgetAttributeDeclaration(int fingerprint)
     Get a global attribute declaration.
public  ClassgetClass(String className, boolean tracing, ClassLoader classLoader)
     Load a class using the class name provided. Note that the method does not check that the object is of the right class.

This method is intended for internal use only.
Parameters:
  className - A string containing the name of theclass, for example "com.microstar.sax.LarkDriver"
Parameters:
  classLoader - The ClassLoader to be used to load the class.

public  ClassLoadergetClassLoader()
     Get the ClassLoader supplied using the method Configuration.setClassLoader .
public  CollationURIResolvergetCollationURIResolver()
     Get the collation URI resolver associated with this configuration.
public  CollectionURIResolvergetCollectionURIResolver()
     Get the collection URI resolver associated with this configuration.
public static  ConfigurationgetConfiguration(XPathContext context)
     Get the configuration, given the context.
public  ObjectgetConfigurationProperty(String name)
    
public  XPathContextgetConversionContext()
    
public  DebuggergetDebugger()
     Get the debugger in use.
public  DocumentNumberAllocatorgetDocumentNumberAllocator()
     Get the document number allocator.
public  ReceivergetDocumentValidator(Receiver receiver, String systemId, NamePool namePool, int validationMode, int stripSpace, SchemaType schemaType)
     Get a document-level validator to add to a Receiver pipeline.

This method is intended for internal use.
Parameters:
  receiver - The receiver to which events should be sent after validation
Parameters:
  systemId - the base URI of the document being validated
Parameters:
  namePool - the namePool to be used by the validator
Parameters:
  validationMode - for example Validation.STRICT or Validation.STRIP.

public  SchemaDeclarationgetElementDeclaration(int fingerprint)
     Get a global element declaration.
public  ReceivergetElementValidator(Receiver receiver, int nameCode, int locationId, SchemaType schemaType, int validation, NamePool pool)
     Get a Receiver that can be used to validate an element, and that passes the validated element on to a target receiver.
public  ErrorListenergetErrorListener()
     Get the ErrorListener used in this configuration.
public  FunctionLibrarygetExtensionBinder()
     Get the FunctionLibrary used to bind calls on extension functions.
public  ExtensionFunctionFactorygetExtensionFunctionFactory()
     Get an ExtensionFunctionFactory.
public  ListgetExternalObjectModels()
     Get all the registered external object models.
public  intgetHostLanguage()
     Get the host language used in this configuration.
public  intgetImplicitTimezone()
     Get the implicit timezone, as a positive or negative offset from UTC in minutes.
public  SetgetImportedNamespaces()
    
public  ObjectgetInstance(String className, ClassLoader classLoader)
     Instantiate a class using the class name provided. Note that the method does not check that the object is of the right class.

This method is intended for internal use only.
Parameters:
  className - A string containing the name of theclass, for example "com.microstar.sax.LarkDriver"
Parameters:
  classLoader - The ClassLoader to be used to load the class.

public static  LocalegetLocale(String lang)
     Get a locale given a language code in XML format.
public  StringgetMessageEmitterClass()
     Get the name of the class that will be instantiated to create a MessageEmitter, to process the output of xsl:message instructions in XSLT.
public  ModuleURIResolvergetModuleURIResolver()
     Get the user-defined ModuleURIResolver for resolving URIs used in "import module" declarations in the XQuery prolog; returns null if none has been explicitly set.
public  NameCheckergetNameChecker()
    
public  NamePoolgetNamePool()
     Get the target namepool to be used for stylesheets/queries and for source documents. the target name pool.
public  OptimizergetOptimizer()
     Factory method to get an Optimizer.
public  ReceivergetOutputMethod(String clarkName)
     Get a configuration-defined output method.
public  OutputURIResolvergetOutputURIResolver()
     Get the OutputURIResolver that will be used to resolve URIs used in the href attribute of the xsl:result-document instruction. the OutputURIResolver.
public  StringgetProductTitle()
    
public  intgetRecoveryPolicy()
     Determine how recoverable run-time errors are to be handled.
public  ObjectgetSchema(String namespace)
     Get a schema from the cache.
public  SchemaTypegetSchemaType(int fingerprint)
     Get the top-level schema type definition with a given fingerprint.

This method is intended for internal use and for use by advanced applications.

public  intgetSchemaValidationMode()
    
public synchronized  XMLReadergetSourceParser()
     Get a parser for source documents.
public  StringgetSourceParserClass()
     Get the name of the class that will be instantiated to create an XML parser for parsing source documents (for example, documents loaded using the document() or doc() functions).
public  SourceResolvergetSourceResolver()
     Get the current SourceResolver.
public  ModuleURIResolvergetStandardModuleURIResolver()
     Get the standard system-defined ModuleURIResolver for resolving URIs used in "import module" declarations in the XQuery prolog.
public  intgetStripsWhiteSpace()
     Set which kinds of whitespace-only text node should be stripped. kind the kind of whitespace-only text node that should be stripped when buildinga source tree.
public synchronized  XMLReadergetStyleParser()
     Get the parser for stylesheet documents.
public  StringgetStyleParserClass()
     Get the name of the class that will be instantiated to create an XML parser for parsing stylesheet modules.
public  StandardURIResolvergetSystemURIResolver()
     Get the system-defined URI Resolver.
public  TraceListenergetTraceListener()
     Get the TraceListener used for run-time tracing of instruction execution.
public  intgetTreeModel()
     Get the Tree Model used by this Configuration.
public  URIResolvergetURIResolver()
     Get the URIResolver used in this configuration the URIResolver.
public  VendorFunctionLibrarygetVendorFunctionLibrary()
     Get the FunctionLibrary used to bind calls on Saxon-defined extension functions.
public  intgetXMLVersion()
    
public  booleanisAllowExternalFunctions()
     Determine whether calls to external Java functions are permitted.
public  booleanisLazyConstructionMode()
     Determine whether lazy construction mode is on or off.
public  booleanisLineNumbering()
     Determine whether source documents will maintain line numbers, for the benefit of the saxon:line-number() extension function as well as run-time tracing.
public  booleanisMultiThreading()
    
public  booleanisRetainDTDAttributeTypes()
    
public  booleanisSchemaAware(int language)
    
public  booleanisSealedNamespace(String namespace)
     Test whether a schema namespace is sealed.
public  booleanisStripsAllWhiteSpace()
     Determine whether whitespace-only text nodes are to be stripped unconditionally from source documents.
public  booleanisTiming()
     Determine whether brief progress messages and timing information will be output to System.err.

This method is provided largely for internal use.

public  booleanisTraceExternalFunctions()
     Determine whether calls on external functions are to be traced for diagnostic purposes.
public  booleanisValidation()
    
public  booleanisValidationWarnings()
     Determine whether schema validation failures on result documents are to be treated as fatal errors or as warnings.
public  booleanisVersionWarning()
     Determine whether a warning is to be output when running against a stylesheet labelled as version="1.0".
public  ComparatormakeCollator(String className)
     Load a named collator class and check it is OK.
public  XMLReadermakeParser(String className)
     Create a new SAX XMLReader object using the class name provided.
public  PipelineConfigurationmakePipelineConfiguration()
    
public  SlotManagermakeSlotManager()
     Factory method to create a SlotManager.
public  NodeTestmakeSubstitutionGroupTest(SchemaDeclaration elementDecl)
     Make a test for elements corresponding to a give element declaration.
public  TraceListenermakeTraceListener(String className)
    
public  URIResolvermakeURIResolver(String className)
    
public  booleanmustCheckForXML11Input()
     Determine whether it is necessary to check for XML 1.1 input when parsing.
public  StringreadInlineSchema(PipelineConfiguration pipe, NodeInfo root, String expected)
     Read an inline schema from a stylesheet.

This method is intended for internal use.
Parameters:
  pipe -
Parameters:
  root - the xs:schema element in the stylesheet
Parameters:
  expected - the target namespace expected; null if there is noexpectation.

public  voidreadMultipleSchemas(PipelineConfiguration pipe, String baseURI, List schemaLocations, String expected)
     Read schemas from a list of schema locations.
public  StringreadSchema(PipelineConfiguration pipe, String baseURI, String schemaLocation, String expected)
    
public  voidregisterExternalObjectModel(ExternalObjectModel model)
     Register an external object model with this Configuration.
public  voidreportFatalError(XPathException err)
    
public  SourceresolveSource(Source source, Configuration config)
    
public synchronized  voidreuseSourceParser(XMLReader parser)
    
public synchronized  voidreuseStyleParser(XMLReader parser)
    
public  voidsealNamespace(String namespace)
     Mark a schema namespace as being sealed.
public  voidsetAllNodesUntyped(boolean allUntyped)
    
public  voidsetAllowExternalFunctions(boolean allowExternalFunctions)
     Determine whether calls to external Java functions are permitted.
public  voidsetClassLoader(ClassLoader loader)
     Set a ClassLoader to be used when loading external classes.
public  voidsetCollationURIResolver(CollationURIResolver resolver)
     Set a CollationURIResolver to be used to resolve collation URIs (that is, to take a URI identifying a collation, and return the corresponding collation). Note that Saxon attempts first to resolve a collation URI using the resolver registered with the Controller; if that returns null, it tries again using the resolver registered with the Configuration.

Note that it is undefined whether collation URIs are resolved at compile time or at run-time.

public  voidsetCollectionURIResolver(CollectionURIResolver resolver)
     Set a CollectionURIResolver to be used to resolve collection URIs (that is, the URI supplied in a call to the collection() function).

Collection URIs are always resolved at run-time, using the CollectionURIResolver in force at the time the collection() function is called.
Parameters:
  resolver - the collection URI resolver to be used.

public  voidsetConfigurationProperty(String name, Object value)
     Set a property of the configuration.
public  voidsetDebugger(Debugger debugger)
     Set the debugger to be used.
public  voidsetErrorListener(ErrorListener listener)
     Set the ErrorListener to be used in this configuration.
public  voidsetExtensionBinder(FunctionLibrary binder)
     Set the FunctionLibrary used to bind calls on extension functions.
public  voidsetExtensionFunctionFactory(ExtensionFunctionFactory factory)
     Set an ExtensionFunctionFactory.
public  voidsetHostLanguage(int hostLanguage)
     Set the host language used in this configuration.
public  voidsetImplicitTimezone(int minutes)
     Set the implicit timezone, as a positive or negative offset from UTC in minutes.
public  voidsetLazyConstructionMode(boolean lazy)
     Set lazy construction mode on or off.
public  voidsetLineNumbering(boolean lineNumbering)
     Determine whether source documents will maintain line numbers, for the benefit of the saxon:line-number() extension function as well as run-time tracing.
public  voidsetMessageEmitterClass(String messageEmitterClass)
     Set the name of the class that will be instantiated to create a MessageEmitter, to process the output of xsl:message instructions in XSLT.
Parameters:
  messageEmitterClass - the full class name of the message emitter class.
public  voidsetModuleURIResolver(ModuleURIResolver resolver)
    
public  voidsetModuleURIResolver(String className)
    
public  voidsetMultiThreading(boolean multithreading)
    
public  voidsetNamePool(NamePool targetNamePool)
     Set the NamePool to be used for stylesheets/queries and for source documents.

Normally all transformations and queries run under a single Java VM share the same NamePool.

public  voidsetOutputURIResolver(OutputURIResolver outputURIResolver)
     Set the OutputURIResolver that will be used to resolve URIs used in the href attribute of the xsl:result-document instruction.
public  voidsetRecoveryPolicy(int recoveryPolicy)
     Determine how recoverable run-time errors are to be handled.
public  voidsetRetainDTDAttributeTypes(boolean useTypes)
     Determine whether attribute types obtained from a DTD are to be used to set type annotations on the resulting nodes.
public  voidsetSchemaValidationMode(int validationMode)
    
public  voidsetSourceParserClass(String sourceParserClass)
     Set the name of the class that will be instantiated to create an XML parser for parsing source documents (for example, documents loaded using the document() or doc() functions).

This method is retained in Saxon for backwards compatibility, but the preferred way of choosing an XML parser is to use JAXP interfaces, for example by supplying a JAXP Source object initialized with an appropriate implementation of org.xml.sax.XMLReader.
Parameters:
  sourceParserClass - the fully qualified name of the XML parser class.

public  voidsetSourceResolver(SourceResolver resolver)
    
public  voidsetStripsAllWhiteSpace(boolean stripsAllWhiteSpace)
     Determine whether whitespace-only text nodes are to be stripped unconditionally from source documents.
public  voidsetStripsWhiteSpace(int kind)
     Set which kinds of whitespace-only text node should be stripped.
Parameters:
  kind - the kind of whitespace-only text node that should be stripped when buildinga source tree.
public  voidsetStyleParserClass(String styleParserClass)
     Set the name of the class that will be instantiated to create an XML parser for parsing stylesheet modules.
public  voidsetTiming(boolean timing)
     Determine whether brief progress messages and timing information will be output to System.err.

This method is provided largely for internal use.

public  voidsetTraceExternalFunctions(boolean traceExternalFunctions)
     Determine whether calls on external functions are to be traced for diagnostic purposes.
public  voidsetTraceListener(TraceListener traceListener)
     Set the TraceListener to be used for run-time tracing of instruction execution.
public  voidsetTreeModel(int treeModel)
     Set the Tree Model used by this Configuration.
public  voidsetURIResolver(URIResolver resolver)
     Set the URIResolver to be used in this configuration.
public  voidsetValidation(boolean validation)
    
public  voidsetValidationWarnings(boolean warn)
     Indicate whether schema validation failures on result documents are to be treated as fatal errors or as warnings.
public  voidsetVersionWarning(boolean warn)
     Determine whether a warning is to be output when running against a stylesheet labelled as version="1.0".
public  voidsetXMLVersion(int version)
    
public  intvalidateAttribute(int nameCode, CharSequence value, int validation)
     Validate an attribute value.

Field Detail
DO_NOT_RECOVER
final public static int DO_NOT_RECOVER(Code)
Constant indicating that when a recoverable error occurs, the processor should not attempt to take the defined recovery action, but should terminate with an error.



JAVA_APPLICATION
final public static int JAVA_APPLICATION(Code)
Constant indicating that the host language is Java: that is, this is a free-standing Java application with no XSLT or XQuery content



RECOVER_SILENTLY
final public static int RECOVER_SILENTLY(Code)
Constant indicating that the processor should take the recovery action when a recoverable error occurs, with no warning message.



RECOVER_WITH_WARNINGS
final public static int RECOVER_WITH_WARNINGS(Code)
Constant indicating that the processor should produce a warning when a recoverable error occurs, and should then take the recovery action and continue.



XML10
final public static int XML10(Code)
Constant indicating the XML Version 1.0



XML11
final public static int XML11(Code)
Constant indicating the XML Version 1.1



XML_SCHEMA
final public static int XML_SCHEMA(Code)
Constant indicating that the "host language" is XML Schema



XPATH
final public static int XPATH(Code)
Constant indicating that the host language is XPATH itself - that is, a free-standing XPath environment



XQUERY
final public static int XQUERY(Code)
Constant indicating that the host language is XQuery



XSLT
final public static int XSLT(Code)
Constant indicating that the host language is XSLT



listener
protected transient ErrorListener listener(Code)



optimizer
protected Optimizer optimizer(Code)



recoveryPolicy
protected int recoveryPolicy(Code)



vendorFunctionLibrary
protected VendorFunctionLibrary vendorFunctionLibrary(Code)




Constructor Detail
Configuration
public Configuration()(Code)
Create a configuration object with default settings for all options. This is equivalent to calling new Configuration(true).
since:
   8.4




Method Detail
addSchema
public void addSchema(Object schema) throws TransformerConfigurationException(Code)
Add a schema to the cache.

This method is intended for internal use
Parameters:
  schema - an object of class javax.xml.validation.schema, which is not declared as suchto avoid creating a dependency on this JDK 1.5 class




addSchemaSource
public void addSchemaSource(Source schemaSource) throws SchemaException(Code)
Load a schema, which will be available for use by all subsequent operations using this Configuration.
Parameters:
  schemaSource - the JAXP Source object identifying the schema document to be loaded
throws:
  SchemaException - if the schema cannot be read or parsed or if it is invalid
throws:
  UnsupportedOperationException - if the configuration is not schema-aware
since:
   8.4



areAllNodesUntyped
public boolean areAllNodesUntyped()(Code)
Determine whether all nodes encountered within this query or transformation are guaranteed to be untyped



displayLicenseMessage
public void displayLicenseMessage()(Code)
Display a message about the license status



findExternalObjectModel
public ExternalObjectModel findExternalObjectModel(Object node)(Code)
Find the external object model corresponding to a given node.

This method is intended for internal use only.
Parameters:
  node - a Node as implemented in some external object model the first registered external object model that recognizesthis node; or null if no-one will own up to it.




getAnnotationStripper
public Receiver getAnnotationStripper(Receiver destination)(Code)
Add to a pipeline a receiver that strips all type annotations. This has a null implementation in the Saxon-B product, because type annotations can never arise.

This method is intended for internal use.




getAttributeDeclaration
public SchemaDeclaration getAttributeDeclaration(int fingerprint)(Code)
Get a global attribute declaration.

This method is intended for internal use the attribute declaration whose name matches the givenfingerprint, or null if no element declaration with this name hasbeen registered.




getClass
public Class getClass(String className, boolean tracing, ClassLoader classLoader) throws XPathException(Code)
Load a class using the class name provided. Note that the method does not check that the object is of the right class.

This method is intended for internal use only.
Parameters:
  className - A string containing the name of theclass, for example "com.microstar.sax.LarkDriver"
Parameters:
  classLoader - The ClassLoader to be used to load the class. If this is null, thenthe classLoader used will be the first one available of: the classLoader registeredwith the Configuration using Configuration.setClassLoader; the context class loader forthe current thread; or failing that, the class loader invoked implicitly by a callof Class.forName() (which is the ClassLoader that was used to load the Configurationobject itself). an instance of the class named, or null if it is notloadable.
throws:
  XPathException - if the class cannot be loaded.




getClassLoader
public ClassLoader getClassLoader()(Code)
Get the ClassLoader supplied using the method Configuration.setClassLoader . If none has been supplied, return null.

This method is intended for external use by advanced users, but should be regarded as experimental.




getCollationURIResolver
public CollationURIResolver getCollationURIResolver()(Code)
Get the collation URI resolver associated with this configuration. This will return the CollationURIResolver previously set using the Configuration.setCollationURIResolver method; if this has not been called, it returns the system-defined collation URI resolver the registered CollationURIResolver
since:
   8.5



getCollectionURIResolver
public CollectionURIResolver getCollectionURIResolver()(Code)
Get the collection URI resolver associated with this configuration. This will return the CollectionURIResolver previously set using the Configuration.setCollectionURIResolver method; if this has not been called, it returns the system-defined collection URI resolver the registered CollationURIResolver
since:
   8.5



getConfiguration
public static Configuration getConfiguration(XPathContext context)(Code)
Get the configuration, given the context. This is provided as a static method to make it accessible as an extension function.



getConfigurationProperty
public Object getConfigurationProperty(String name)(Code)
Get a property of the configuration
Parameters:
  name - the name of the required property the value of the property
throws:
  IllegalArgumentException - thrown if the property is not one that Saxon recognizes.



getConversionContext
public XPathContext getConversionContext()(Code)
Get an XPathContext object with sufficient capability to perform comparisons and conversions



getDebugger
public Debugger getDebugger()(Code)
Get the debugger in use. This will be null if no debugger has been registered.

This method is provided for advanced users only, and is subject to change.




getDocumentNumberAllocator
public DocumentNumberAllocator getDocumentNumberAllocator()(Code)
Get the document number allocator.

This is intended primarily for internal use




getDocumentValidator
public Receiver getDocumentValidator(Receiver receiver, String systemId, NamePool namePool, int validationMode, int stripSpace, SchemaType schemaType)(Code)
Get a document-level validator to add to a Receiver pipeline.

This method is intended for internal use.
Parameters:
  receiver - The receiver to which events should be sent after validation
Parameters:
  systemId - the base URI of the document being validated
Parameters:
  namePool - the namePool to be used by the validator
Parameters:
  validationMode - for example Validation.STRICT or Validation.STRIP. The integer mayalso have the bit Validation.VALIDATE_OUTPUT set, indicating that the strean being validatedis to be treated as a final output stream (which means multiple errors can be reported)
Parameters:
  stripSpace -
Parameters:
  schemaType - The type against which the outermost element of the document must be validated(null if there is no constraint) A Receiver to which events can be sent for validation




getElementDeclaration
public SchemaDeclaration getElementDeclaration(int fingerprint)(Code)
Get a global element declaration.

This method is intended for internal use. the element declaration whose name matches the givenfingerprint, or null if no element declaration with this name hasbeen registered.




getElementValidator
public Receiver getElementValidator(Receiver receiver, int nameCode, int locationId, SchemaType schemaType, int validation, NamePool pool) throws XPathException(Code)
Get a Receiver that can be used to validate an element, and that passes the validated element on to a target receiver. If validation is not supported, the returned receiver will be the target receiver.

This method is intended for internal use.
Parameters:
  receiver - the target receiver tp receive the validated element
Parameters:
  nameCode - the nameCode of the element to be validated. This must correspond to thename of an element declaration in a loaded schema
Parameters:
  schemaType - the schema type (typically a complex type) against which the element is tobe validated
Parameters:
  validation - The validation mode, for example Validation.STRICT or Validation.LAX
Parameters:
  pool - The name pool The target receiver, indicating that with this configuration, no validationis performed.




getErrorListener
public ErrorListener getErrorListener()(Code)
Get the ErrorListener used in this configuration. If no ErrorListener has been supplied explicitly, the default ErrorListener is used. the ErrorListener.
since:
   8.4



getExtensionBinder
public FunctionLibrary getExtensionBinder()(Code)
Get the FunctionLibrary used to bind calls on extension functions.

This mechanism is for advanced users only, and the details are subject to change. the registered FunctionLibrary for extension functions if one has beenregistered; or the default FunctionLibrary for extension functions otherwise




getExtensionFunctionFactory
public ExtensionFunctionFactory getExtensionFunctionFactory()(Code)
Get an ExtensionFunctionFactory. This is used at compile time for generating the code that calls Java extension functions. It is possible to supply a user-defined ExtensionFunctionFactory to customize the way extension functions are bound.

This mechanism is intended for advanced use only, and is subject to change. the factory object registered to generate calls on extension functions,if one has been registered; if not, the default factory used by Saxon.




getExternalObjectModels
public List getExternalObjectModels()(Code)
Get all the registered external object models.

This method is intended for internal use only.




getHostLanguage
public int getHostLanguage()(Code)
Get the host language used in this configuration. The typical values are XSLT and XQUERY. The values XML_SCHEMA and JAVA_APPLICATION may also be encountered.

This method is problematic because it is possible to run multiple transformations or queries within the same configuration. The method is therefore best avoided. Instead, use net.sf.saxon.instruct.Executable.getHostLanguage . Internally its only use is in deciding (in Saxon-SA only) which error listener to use by default at compile time, and since the standard XSLT and XQuery listeners have no differences when used for static errors, the choice is immaterial. Configuration.XSLT or Configuration.XQUERY




getImplicitTimezone
public int getImplicitTimezone()(Code)
Get the implicit timezone, as a positive or negative offset from UTC in minutes. The range is -14hours to +14hours the value set using Configuration.setImplicitTimezone, or failing thatthe timezone from the system clock at the time the Configuration was created.



getImportedNamespaces
public Set getImportedNamespaces()(Code)
Get the set of namespaces of imported schemas



getInstance
public Object getInstance(String className, ClassLoader classLoader) throws XPathException(Code)
Instantiate a class using the class name provided. Note that the method does not check that the object is of the right class.

This method is intended for internal use only.
Parameters:
  className - A string containing the name of theclass, for example "com.microstar.sax.LarkDriver"
Parameters:
  classLoader - The ClassLoader to be used to load the class. If this is null, thenthe classLoader used will be the first one available of: the classLoader registeredwith the Configuration using Configuration.setClassLoader; the context class loader forthe current thread; or failing that, the class loader invoked implicitly by a callof Class.forName() (which is the ClassLoader that was used to load the Configurationobject itself). an instance of the class named, or null if it is notloadable.
throws:
  XPathException - if the class cannot be loaded.




getLocale
public static Locale getLocale(String lang)(Code)
Get a locale given a language code in XML format.

This method is intended for internal use.




getMessageEmitterClass
public String getMessageEmitterClass()(Code)
Get the name of the class that will be instantiated to create a MessageEmitter, to process the output of xsl:message instructions in XSLT. the full class name of the message emitter class.
since:
   8.4



getModuleURIResolver
public ModuleURIResolver getModuleURIResolver()(Code)
Get the user-defined ModuleURIResolver for resolving URIs used in "import module" declarations in the XQuery prolog; returns null if none has been explicitly set.



getNameChecker
public NameChecker getNameChecker()(Code)
Get a class that can be used to check names against the selected XML version a class that can be used for name checking
since:
   8.6



getNamePool
public NamePool getNamePool()(Code)
Get the target namepool to be used for stylesheets/queries and for source documents. the target name pool. If no NamePool has been specified explicitly, thedefault NamePool is returned.
since:
   8.4



getOptimizer
public Optimizer getOptimizer()(Code)
Factory method to get an Optimizer.

This method is intended for internal use only.




getOutputMethod
public Receiver getOutputMethod(String clarkName)(Code)
Get a configuration-defined output method. a Receiver that implements the method, or null if the method name is not recognized



getOutputURIResolver
public OutputURIResolver getOutputURIResolver()(Code)
Get the OutputURIResolver that will be used to resolve URIs used in the href attribute of the xsl:result-document instruction. the OutputURIResolver. If none has been supplied explicitly, thedefault OutputURIResolver is returned.
since:
   8.4



getProductTitle
public String getProductTitle()(Code)
Get a message used to identify this product when a transformation is run using the -t option A string containing both the product name and the productversion
since:
   8.4



getRecoveryPolicy
public int getRecoveryPolicy()(Code)
Determine how recoverable run-time errors are to be handled. This applies only if the standard ErrorListener is used. the current recovery policy. The options are Configuration.RECOVER_SILENTLY,Configuration.RECOVER_WITH_WARNINGS, or Configuration.DO_NOT_RECOVER.
since:
   8.4



getSchema
public Object getSchema(String namespace)(Code)
Get a schema from the cache. Return null if not found.

This method is intended for internal use. an object of class javax.xml.validation.schema, which is not declared as suchto avoid creating a dependency on this JDK 1.5 class




getSchemaType
public SchemaType getSchemaType(int fingerprint)(Code)
Get the top-level schema type definition with a given fingerprint.

This method is intended for internal use and for use by advanced applications. (The SchemaType object returned cannot yet be considered a stable API, and may be superseded when a JAXP API for schema information is defined.)
Parameters:
  fingerprint - the fingerprint of the schema type the schema type , or null if there is nonewith this name.




getSchemaValidationMode
public int getSchemaValidationMode()(Code)
Determine whether source documents (supplied as a StreamSource or SAXSource) should be subjected to schema validation the schema validation mode previously set using setSchemaValidationMode(),or the default mode Validation.STRIP otherwise.



getSourceParser
public synchronized XMLReader getSourceParser() throws TransformerFactoryConfigurationError(Code)
Get a parser for source documents. The parser is allocated from a pool if any are available from the pool: the client should ideally return the parser to the pool after use, so that it can be reused.

This method is intended primarily for internal use.




getSourceParserClass
public String getSourceParserClass()(Code)
Get the name of the class that will be instantiated to create an XML parser for parsing source documents (for example, documents loaded using the document() or doc() functions).

This method is retained in Saxon for backwards compatibility, but the preferred way of choosing an XML parser is to use JAXP interfaces, for example by supplying a JAXP Source object initialized with an appropriate implementation of org.xml.sax.XMLReader. the fully qualified name of the XML parser class




getSourceResolver
public SourceResolver getSourceResolver()(Code)
Get the current SourceResolver. If none has been supplied, a system-defined SourceResolver is returned. the current SourceResolver



getStandardModuleURIResolver
public ModuleURIResolver getStandardModuleURIResolver()(Code)
Get the standard system-defined ModuleURIResolver for resolving URIs used in "import module" declarations in the XQuery prolog.



getStripsWhiteSpace
public int getStripsWhiteSpace()(Code)
Set which kinds of whitespace-only text node should be stripped. kind the kind of whitespace-only text node that should be stripped when buildinga source tree. One of Whitespace.NONE (none), Whitespace.ALL (all),or Whitespace.IGNORABLE (element-content whitespace as defined in a DTD or schema)



getStyleParser
public synchronized XMLReader getStyleParser() throws TransformerFactoryConfigurationError(Code)
Get the parser for stylesheet documents. This parser is also used for schema documents.

This method is intended for internal use only.




getStyleParserClass
public String getStyleParserClass()(Code)
Get the name of the class that will be instantiated to create an XML parser for parsing stylesheet modules.

This method is retained in Saxon for backwards compatibility, but the preferred way of choosing an XML parser is to use JAXP interfaces, for example by supplying a JAXP Source object initialized with an appropriate implementation of org.xml.sax.XMLReader. the fully qualified name of the XML parser class




getSystemURIResolver
public StandardURIResolver getSystemURIResolver()(Code)
Get the system-defined URI Resolver. This is used when the user-defined URI resolver returns null as the result of the resolve() method



getTraceListener
public TraceListener getTraceListener()(Code)
Get the TraceListener used for run-time tracing of instruction execution. the TraceListener, or null if none is in use.
since:
   8.4



getTreeModel
public int getTreeModel()(Code)
Get the Tree Model used by this Configuration. This is either Builder.STANDARD_TREE or Builder.TINY_TREE. The default (confusingly) is Builder.TINY_TREE. the selected Tree Model
since:
   8.4



getURIResolver
public URIResolver getURIResolver()(Code)
Get the URIResolver used in this configuration the URIResolver. If no URIResolver has been set explicitly, thedefault URIResolver is used.
since:
   8.4



getVendorFunctionLibrary
public VendorFunctionLibrary getVendorFunctionLibrary()(Code)
Get the FunctionLibrary used to bind calls on Saxon-defined extension functions.

This method is intended for internal use only.




getXMLVersion
public int getXMLVersion()(Code)
Get the XML version to be used by default for validating characters and names one of the constants XML10 or XML11
since:
   8.6



isAllowExternalFunctions
public boolean isAllowExternalFunctions()(Code)
Determine whether calls to external Java functions are permitted. true if such calls are permitted.
since:
   8.4



isLazyConstructionMode
public boolean isLazyConstructionMode()(Code)
Determine whether lazy construction mode is on or off. In lazy construction mode, element constructors are not evaluated until the content of the tree is required. Lazy construction mode is currently experimental and is therefore off by default. true if lazy construction mode is enabled



isLineNumbering
public boolean isLineNumbering()(Code)
Determine whether source documents will maintain line numbers, for the benefit of the saxon:line-number() extension function as well as run-time tracing. true if line numbers are maintained in source documents
since:
   8.4



isMultiThreading
public boolean isMultiThreading()(Code)
Determine whether multithreading optimizations are allowed



isRetainDTDAttributeTypes
public boolean isRetainDTDAttributeTypes()(Code)
Determine whether attribute types obtained from a DTD are to be used to set type annotations on the resulting nodes true if DTD types are to be taken into account
since:
   8.4



isSchemaAware
public boolean isSchemaAware(int language)(Code)
Determine if the configuration is schema-aware, for the given host language
Parameters:
  language - the required host language: XSLT, XQUERY, or XML_SCHEMA
since:
   8.4



isSealedNamespace
public boolean isSealedNamespace(String namespace)(Code)
Test whether a schema namespace is sealed. Once a namespace has been sealed, it is not permitted to change the schema components in that namespace by redefining them, deriving new types by extension, or adding to their substitution groups.
Parameters:
  namespace - the namespace URI of the components to be tested true if this namespace has been sealed, otherwise false



isStripsAllWhiteSpace
public boolean isStripsAllWhiteSpace()(Code)
Determine whether whitespace-only text nodes are to be stripped unconditionally from source documents. true if all whitespace-only text nodes are stripped.
since:
   8.4



isTiming
public boolean isTiming()(Code)
Determine whether brief progress messages and timing information will be output to System.err.

This method is provided largely for internal use. Progress messages are normally controlled directly from the command line interfaces, and are not normally used when driving Saxon from the Java API. true if these messages are to be output.




isTraceExternalFunctions
public boolean isTraceExternalFunctions()(Code)
Determine whether calls on external functions are to be traced for diagnostic purposes. true if tracing is enabled for calls to external Java functions



isValidation
public boolean isValidation()(Code)
Determine whether the XML parser for source documents will be asked to perform DTD validation of source documents true if DTD validation is requested.
since:
   8.4



isValidationWarnings
public boolean isValidationWarnings()(Code)
Determine whether schema validation failures on result documents are to be treated as fatal errors or as warnings. true if validation errors are to be treated as warnings (that is, thevalidation failure is reported but processing continues as normal); falseif validation errors are fatal.
since:
   8.4



isVersionWarning
public boolean isVersionWarning()(Code)
Determine whether a warning is to be output when running against a stylesheet labelled as version="1.0". The XSLT specification requires such a warning unless the user disables it. true if these messages are to be output.
since:
   8.4



makeCollator
public Comparator makeCollator(String className) throws XPathException(Code)
Load a named collator class and check it is OK.

This method is intended for internal use only.




makeParser
public XMLReader makeParser(String className) throws TransformerFactoryConfigurationError(Code)
Create a new SAX XMLReader object using the class name provided.

The named class must exist and must implement the org.xml.sax.XMLReader or Parser interface.

This method returns an instance of the parser named.

This method is intended for internal use.
Parameters:
  className - A string containing the name of theSAX parser class, for example "com.microstar.sax.LarkDriver" an instance of the Parser class named, or null if it is notloadable or is not a Parser.




makePipelineConfiguration
public PipelineConfiguration makePipelineConfiguration()(Code)
Make a PipelineConfiguration from the properties of this Configuration
since:
   8.4



makeSlotManager
public SlotManager makeSlotManager()(Code)
Factory method to create a SlotManager.

This method is provided for advanced users only, and is subject to change.




makeSubstitutionGroupTest
public NodeTest makeSubstitutionGroupTest(SchemaDeclaration elementDecl)(Code)
Make a test for elements corresponding to a give element declaration.

This method is intended for internal use.




makeTraceListener
public TraceListener makeTraceListener(String className) throws XPathException(Code)
Create an instance of a TraceListener with a specified class name
exception:
  net.sf.saxon.trans.XPathException - if the requested class does notimplement the net.sf.saxon.trace.TraceListener interface
Parameters:
  className - The fully qualified class name of the TraceListener tobe constructed the newly constructed TraceListener



makeURIResolver
public URIResolver makeURIResolver(String className) throws TransformerException(Code)
Create an instance of a URIResolver with a specified class name
exception:
  TransformerException - if the requested class does notimplement the javax.xml.transform.URIResolver interface
Parameters:
  className - The fully-qualified name of the URIResolver class The newly created URIResolver



mustCheckForXML11Input
public boolean mustCheckForXML11Input()(Code)
Determine whether it is necessary to check for XML 1.1 input when parsing. This check is necessary if (a) the configuration is set to XML 1.0, and (b) some loaded parser has indicated that it can handle XML 1.1.



readInlineSchema
public String readInlineSchema(PipelineConfiguration pipe, NodeInfo root, String expected) throws SchemaException(Code)
Read an inline schema from a stylesheet.

This method is intended for internal use.
Parameters:
  pipe -
Parameters:
  root - the xs:schema element in the stylesheet
Parameters:
  expected - the target namespace expected; null if there is noexpectation. the actual target namespace of the schema




readMultipleSchemas
public void readMultipleSchemas(PipelineConfiguration pipe, String baseURI, List schemaLocations, String expected) throws SchemaException(Code)
Read schemas from a list of schema locations.

This method is intended for internal use.




readSchema
public String readSchema(PipelineConfiguration pipe, String baseURI, String schemaLocation, String expected) throws TransformerConfigurationException(Code)
Read a schema from a given schema location the target namespace of the schema

This method is intended for internal use.




registerExternalObjectModel
public void registerExternalObjectModel(ExternalObjectModel model)(Code)
Register an external object model with this Configuration.
Parameters:
  model - The external object model.This can either be one of the system-supplied externalobject models for JDOM, XOM, or DOM, or a user-supplied external object model.

This method is intended for advanced users only, and is subject to change.




reportFatalError
public void reportFatalError(XPathException err)(Code)
Report a fatal error



resolveSource
public Source resolveSource(Source source, Configuration config) throws XPathException(Code)
Implement the SourceResolver interface



reuseSourceParser
public synchronized void reuseSourceParser(XMLReader parser)(Code)
Return a source parser to the pool, for reuse
Parameters:
  parser - The parser: the caller must not supply a parser that was obtained by anymechanism other than calling the getSourceParser() method.



reuseStyleParser
public synchronized void reuseStyleParser(XMLReader parser)(Code)
Return a stylesheet (or schema) parser to the pool, for reuse
Parameters:
  parser - The parser: the caller must not supply a parser that was obtained by anymechanism other than calling the getStyleParser() method.



sealNamespace
public void sealNamespace(String namespace)(Code)
Mark a schema namespace as being sealed. This is done when components from this namespace are first used for validating a source document or compiling a source document or query. Once a namespace has been sealed, it is not permitted to change the schema components in that namespace by redefining them, deriving new types by extension, or adding to their substitution groups.
Parameters:
  namespace - the namespace URI of the components to be sealed



setAllNodesUntyped
public void setAllNodesUntyped(boolean allUntyped)(Code)
Specify that all nodes encountered within this query or transformation will be untyped



setAllowExternalFunctions
public void setAllowExternalFunctions(boolean allowExternalFunctions)(Code)
Determine whether calls to external Java functions are permitted. Allowing external function calls is potentially a security risk if the stylesheet or Query is untrusted, as it allows arbitrary Java methods to be invoked, which can examine or modify the contents of filestore and other resources on the machine where the query/stylesheet is executed
Parameters:
  allowExternalFunctions - true if external function calls are to bepermitted.
since:
   8.4



setClassLoader
public void setClassLoader(ClassLoader loader)(Code)
Set a ClassLoader to be used when loading external classes. Examples of classes that are loaded include SAX parsers, localization modules for formatting numbers and dates, extension functions, external object models. In an environment such as Eclipse that uses its own ClassLoader, this ClassLoader should be nominated to ensure that any class loaded by Saxon is identical to a class of the same name loaded by the external environment.

This method is intended for external use by advanced users, but should be regarded as experimental.




setCollationURIResolver
public void setCollationURIResolver(CollationURIResolver resolver)(Code)
Set a CollationURIResolver to be used to resolve collation URIs (that is, to take a URI identifying a collation, and return the corresponding collation). Note that Saxon attempts first to resolve a collation URI using the resolver registered with the Controller; if that returns null, it tries again using the resolver registered with the Configuration.

Note that it is undefined whether collation URIs are resolved at compile time or at run-time. It is therefore inadvisable to change the CollationURIResolver after compiling a query or stylesheet and before running it.
Parameters:
  resolver - the collation URI resolver to be used. This replaces any collationURI resolver previously registered.
since:
   8.5




setCollectionURIResolver
public void setCollectionURIResolver(CollectionURIResolver resolver)(Code)
Set a CollectionURIResolver to be used to resolve collection URIs (that is, the URI supplied in a call to the collection() function).

Collection URIs are always resolved at run-time, using the CollectionURIResolver in force at the time the collection() function is called.
Parameters:
  resolver - the collection URI resolver to be used. This replaces any collectionURI resolver previously registered.
since:
   8.5




setConfigurationProperty
public void setConfigurationProperty(String name, Object value)(Code)
Set a property of the configuration. This method underpins the setAttribute() method of the TransformerFactory implementation, and is provided to enable setting of Configuration properties using URIs without instantiating a TransformerFactory: specifically, this may be useful when running XQuery, and it is also used by the Validator API
Parameters:
  name - the URI identifying the property to be set
Parameters:
  value - the value of the property
throws:
  IllegalArgumentException - if the property name is not recognized



setDebugger
public void setDebugger(Debugger debugger)(Code)
Set the debugger to be used.

This method is provided for advanced users only, and is subject to change.




setErrorListener
public void setErrorListener(ErrorListener listener)(Code)
Set the ErrorListener to be used in this configuration. The ErrorListener is informed of all static and dynamic errors detected, and can decide whether run-time warnings are to be treated as fatal.
Parameters:
  listener - the ErrorListener to be used
since:
   8.4



setExtensionBinder
public void setExtensionBinder(FunctionLibrary binder)(Code)
Set the FunctionLibrary used to bind calls on extension functions. This allows the rules for identifying extension functions to be customized (in principle, it would allow support for extension functions in other languages to be provided).

When an application supplies its own FunctionLibrary for binding extension functions, this replaces the default binding mechanism for Java extension functions, namely JavaExtensionLibrary . It thus disables the function libraries for built-in Saxon extensions and for EXSLT extensions. It is possible to create a function library that adds to the existing mechanisms, rather than replacing them, by supplying as the FunctionLibrary a net.sf.saxon.functions.FunctionLibraryList that itself contains two FunctionLibrary objects: a JavaExtensionLibrary, and a user-written FunctionLibrary.
Parameters:
  binder - The FunctionLibrary object used to locate implementations of extensionfunctions, based on their name and arity
See Also:   Configuration.setExtensionFunctionFactory




setExtensionFunctionFactory
public void setExtensionFunctionFactory(ExtensionFunctionFactory factory)(Code)
Set an ExtensionFunctionFactory. This is used at compile time for generating the code that calls Java extension functions. It is possible to supply a user-defined ExtensionFunctionFactory to customize the way extension functions are called. The ExtensionFunctionFactory determines how external methods are called, but is not involved in binding the external method corresponding to a given function name or URI.

This mechanism is intended for advanced use only, and is subject to change.
See Also:   Configuration.setExtensionBinder




setHostLanguage
public void setHostLanguage(int hostLanguage)(Code)
Set the host language used in this configuration. The possible values are XSLT and XQUERY.
Parameters:
  hostLanguage - Configuration.XSLT or Configuration.XQUERY



setImplicitTimezone
public void setImplicitTimezone(int minutes)(Code)
Set the implicit timezone, as a positive or negative offset from UTC in minutes. The range is -14hours to +14hours



setLazyConstructionMode
public void setLazyConstructionMode(boolean lazy)(Code)
Set lazy construction mode on or off. In lazy construction mode, element constructors are not evaluated until the content of the tree is required. Lazy construction mode is currently experimental and is therefore off by default.
Parameters:
  lazy - true to switch lazy construction mode on, false to switch it off.



setLineNumbering
public void setLineNumbering(boolean lineNumbering)(Code)
Determine whether source documents will maintain line numbers, for the benefit of the saxon:line-number() extension function as well as run-time tracing.
Parameters:
  lineNumbering - true if line numbers are maintained in source documents
since:
   8.4



setMessageEmitterClass
public void setMessageEmitterClass(String messageEmitterClass)(Code)
Set the name of the class that will be instantiated to create a MessageEmitter, to process the output of xsl:message instructions in XSLT.
Parameters:
  messageEmitterClass - the full class name of the message emitter class. Thismust implement net.sf.saxon.event.Emitter.
since:
   8.4



setModuleURIResolver
public void setModuleURIResolver(ModuleURIResolver resolver)(Code)
Set a user-defined ModuleURIResolver for resolving URIs used in "import module" declarations in the XQuery prolog



setModuleURIResolver
public void setModuleURIResolver(String className) throws TransformerException(Code)
Create and register an instance of a ModuleURIResolver with a specified class name
exception:
  TransformerException - if the requested class does notimplement the net.sf.saxon.query.ModuleURIResolver interface
Parameters:
  className - The fully-qualified name of the ModuleURIResolver class



setMultiThreading
public void setMultiThreading(boolean multithreading)(Code)
Set whether multithreading optimizations are allowed



setNamePool
public void setNamePool(NamePool targetNamePool)(Code)
Set the NamePool to be used for stylesheets/queries and for source documents.

Normally all transformations and queries run under a single Java VM share the same NamePool. This creates a potential bottleneck, since changes to the namepool are synchronized. It is possible therefore to allocate a distinct NamePool to each Configuration. This requires considerable care and should only be done when the default arrangement is found to cause problems. There is a basic rule to follow: any compiled stylesheet or query must use the same NamePool as its source and result documents.
Parameters:
  targetNamePool - The NamePool to be used.
since:
   8.4




setOutputURIResolver
public void setOutputURIResolver(OutputURIResolver outputURIResolver)(Code)
Set the OutputURIResolver that will be used to resolve URIs used in the href attribute of the xsl:result-document instruction.
Parameters:
  outputURIResolver - the OutputURIResolver to be used.
since:
   8.4



setRecoveryPolicy
public void setRecoveryPolicy(int recoveryPolicy)(Code)
Determine how recoverable run-time errors are to be handled. This applies only if the standard ErrorListener is used. The recovery policy applies to errors classified in the XSLT 2.0 specification as recoverable dynamic errors, but only in those cases where Saxon provides a choice over how the error is handled: in some cases, Saxon makes the decision itself.
Parameters:
  recoveryPolicy - the recovery policy to be used. The options are Configuration.RECOVER_SILENTLY,Configuration.RECOVER_WITH_WARNINGS, or Configuration.DO_NOT_RECOVER.
since:
   8.4



setRetainDTDAttributeTypes
public void setRetainDTDAttributeTypes(boolean useTypes) throws TransformerFactoryConfigurationError(Code)
Determine whether attribute types obtained from a DTD are to be used to set type annotations on the resulting nodes.
Parameters:
  useTypes - set to true if DTD types are to be taken into account
since:
   8.4



setSchemaValidationMode
public void setSchemaValidationMode(int validationMode)(Code)
Indicate whether source documents (supplied as a StreamSource or SAXSource) should be subjected to schema validation
Parameters:
  validationMode - the validation (or construction) mode to be used for source documents.One of Validation.STRIP, Validation.PRESERVE, Validation.STRICT,Validation.LAX
since:
   8.4



setSourceParserClass
public void setSourceParserClass(String sourceParserClass)(Code)
Set the name of the class that will be instantiated to create an XML parser for parsing source documents (for example, documents loaded using the document() or doc() functions).

This method is retained in Saxon for backwards compatibility, but the preferred way of choosing an XML parser is to use JAXP interfaces, for example by supplying a JAXP Source object initialized with an appropriate implementation of org.xml.sax.XMLReader.
Parameters:
  sourceParserClass - the fully qualified name of the XML parser class. This must implementthe SAX2 XMLReader interface.




setSourceResolver
public void setSourceResolver(SourceResolver resolver)(Code)
Supply a SourceResolver



setStripsAllWhiteSpace
public void setStripsAllWhiteSpace(boolean stripsAllWhiteSpace)(Code)
Determine whether whitespace-only text nodes are to be stripped unconditionally from source documents.
Parameters:
  stripsAllWhiteSpace - if all whitespace-only text nodes are to be stripped.
since:
   8.4



setStripsWhiteSpace
public void setStripsWhiteSpace(int kind)(Code)
Set which kinds of whitespace-only text node should be stripped.
Parameters:
  kind - the kind of whitespace-only text node that should be stripped when buildinga source tree. One of Whitespace.NONE (none), Whitespace.ALL (all),or Whitespace.IGNORABLE (element-content whitespace as defined in a DTD or schema)



setStyleParserClass
public void setStyleParserClass(String styleParserClass)(Code)
Set the name of the class that will be instantiated to create an XML parser for parsing stylesheet modules.

This method is retained in Saxon for backwards compatibility, but the preferred way of choosing an XML parser is to use JAXP interfaces, for example by supplying a JAXP Source object initialized with an appropriate implementation of org.xml.sax.XMLReader.
Parameters:
  styleParserClass - the fully qualified name of the XML parser class




setTiming
public void setTiming(boolean timing)(Code)
Determine whether brief progress messages and timing information will be output to System.err.

This method is provided largely for internal use. Progress messages are normally controlled directly from the command line interfaces, and are not normally used when
Parameters:
  timing - true if these messages are to be output.




setTraceExternalFunctions
public void setTraceExternalFunctions(boolean traceExternalFunctions)(Code)
Determine whether calls on external functions are to be traced for diagnostic purposes.
Parameters:
  traceExternalFunctions - true if tracing is to be enabledfor calls to external Java functions



setTraceListener
public void setTraceListener(TraceListener traceListener)(Code)
Set the TraceListener to be used for run-time tracing of instruction execution.
Parameters:
  traceListener - The TraceListener to be used.
since:
   8.4



setTreeModel
public void setTreeModel(int treeModel)(Code)
Set the Tree Model used by this Configuration. This is either Builder.STANDARD_TREE or Builder.TINY_TREE. The default (confusingly) is Builder.TINY_TREE.
Parameters:
  treeModel - the selected Tree Model
since:
   8.4



setURIResolver
public void setURIResolver(URIResolver resolver)(Code)
Set the URIResolver to be used in this configuration. This will be used to resolve the URIs used statically (e.g. by xsl:include) and also the URIs used dynamically by functions such as document() and doc(). Note that the URIResolver does not resolve the URI in the sense of RFC 2396 (which is also the sense in which the resolve-uri() function uses the term): rather it dereferences an absolute URI to obtain an actual resource, which is returned as a Source object.
Parameters:
  resolver - The URIResolver to be used.
since:
   8.4



setValidation
public void setValidation(boolean validation)(Code)
Determine whether the XML parser for source documents will be asked to perform DTD validation of source documents
Parameters:
  validation - true if DTD validation is to be requested.
since:
   8.4



setValidationWarnings
public void setValidationWarnings(boolean warn)(Code)
Indicate whether schema validation failures on result documents are to be treated as fatal errors or as warnings.
Parameters:
  warn - true if schema validation failures are to be treated as warnings; false if theyare to be treated as fatal errors.
since:
   8.4



setVersionWarning
public void setVersionWarning(boolean warn)(Code)
Determine whether a warning is to be output when running against a stylesheet labelled as version="1.0". The XSLT specification requires such a warning unless the user disables it.
Parameters:
  warn - true if these messages are to be output.
since:
   8.4



setXMLVersion
public void setXMLVersion(int version)(Code)
Set the XML version to be used by default for validating characters and names
Parameters:
  version - one of the constants XML10 or XML11
since:
   8.6



validateAttribute
public int validateAttribute(int nameCode, CharSequence value, int validation) throws ValidationException(Code)
Validate an attribute value.

This method is intended for internal use.
Parameters:
  nameCode - the name of the attribute
Parameters:
  value - the value of the attribute as a string
Parameters:
  validation - STRICT or LAX the type annotation to apply to the attribute node
throws:
  ValidationException - if the value is invalid




Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.