FeatureKeys


1   package net.sf.saxon;
2   
3   
4   /**
5     * FeatureKeys defines a set of constants, names of Saxon configuration
6     * options which can be supplied to the TransformerFactoryImpl interface
7     *
8     * @author Michael H. Kay
9     */
10  
11  
12  public class FeatureKeys {
13  
14      /**
15      * ALLOW_EXTERNAL_FUNCTIONS must be a Boolean; it determines whether calls to external functions are allowed
16      */
17  
18      public static final String   ALLOW_EXTERNAL_FUNCTIONS =
19              "http://saxon.sf.net/feature/allow-external-functions";
20  
21      /**
22      * RECOGNIZE_URI_QUERY_PARAMETERS must be a Boolean; it determines whether query parameters (things after "?")
23       * in a URI passed to the document() or doc() function are specially recognized by the system default URIResolver.
24       * Allowed parameters include, for example validation=strict to perform schema validation, and strip-space=yes
25       * to perform stripping of all whitespace-only text nodes.
26      */
27  
28      public static final String   RECOGNIZE_URI_QUERY_PARAMETERS =
29              "http://saxon.sf.net/feature/recognize-uri-query-parameters";
30  
31      /**
32      * TRACE_EXTERNAL_FUNCTIONS must be a Boolean; it determines whether the loading and binding of extension
33       * functions is traced
34      */
35  
36      public static final String   TRACE_EXTERNAL_FUNCTIONS =
37              "http://saxon.sf.net/feature/trace-external-functions";
38  
39      /**
40      * TIMING must be an Boolean; it determines whether basic timing information is output to System.err
41      */
42  
43      public static final String   TIMING =
44              "http://saxon.sf.net/feature/timing";
45  
46      /**
47      * TREE_MODEL must be an Integer: Builder.STANDARD_TREE or Builder.TINY_TREE
48      */
49  
50      public static final String   TREE_MODEL =
51              "http://saxon.sf.net/feature/treeModel";
52  
53      /**
54      * TRACE_LISTENER must be a class that implements net.sf.saxon.trace.TraceListener
55      */
56  
57      public static final String   TRACE_LISTENER =
58              "http://saxon.sf.net/feature/traceListener";
59  
60      /**
61      * LINE_NUMBERING must be a Boolean(); it determines whether line numbers are maintained for the
62       * source document
63      */
64  
65      public static final String   LINE_NUMBERING =
66              "http://saxon.sf.net/feature/linenumbering";
67  
68      /**
69      * RECOVERY_POLICY must be an Integer: Controller.RECOVER_SILENTLY,
70      * Controller.RECOVER_WITH_WARNINGS, or Controller.DO_NOT_RECOVER
71      */
72  
73      public static final String   RECOVERY_POLICY =
74              "http://saxon.sf.net/feature/recoveryPolicy";
75  
76      /**
77      * MESSAGE_EMITTER_CLASS must be the class name of an Emitter
78      */
79  
80      public static final String   MESSAGE_EMITTER_CLASS =
81              "http://saxon.sf.net/feature/messageEmitterClass";
82  
83      /**
84      * SOURCE_PARSER_CLASS must be the full class name of an XMLReader
85      */
86  
87      public static final String   SOURCE_PARSER_CLASS =
88              "http://saxon.sf.net/feature/sourceParserClass";
89  
90      /**
91      * STYLE_PARSER_CLASS must be an XMLReader
92      */
93  
94      public static final String   STYLE_PARSER_CLASS =
95              "http://saxon.sf.net/feature/styleParserClass";
96  
97      /**
98      * NAME_POOL must be an instance of net.sf.saxon.om.NamePool
99      */
100 
101     public static final String   NAME_POOL =
102             "http://saxon.sf.net/feature/namePool";
103 
104     /**
105     * OUTPUT_URI_RESOLVER must be an instance of net.sf.saxon.OutputURIResolver
106     */
107 
108     public static final String   OUTPUT_URI_RESOLVER =
109             "http://saxon.sf.net/feature/outputURIResolver";
110 
111     /**
112     * DTD_VALIDATION must be a Boolean. This determines whether source documents should be
113     * parsed with DTD-validation enabled.
114     */
115 
116     public static final String   DTD_VALIDATION =
117             "http://saxon.sf.net/feature/validation";
118 
119     /**
120     * SCHEMA_VALIDATION must be a Boolean. This determines whether source documents should be
121     * parsed with schema-validation enabled.
122     */
123 
124     public static final String   SCHEMA_VALIDATION =
125             "http://saxon.sf.net/feature/schema-validation";
126 
127     /**
128     * VALIDATION_WARNINGS must be a Boolean. This determines whether validation errors in result
129     * documents should be treated as fatal. By default they are fatal; with this option set, they
130     * are treated as warnings.
131     */
132 
133     public static final String   VALIDATION_WARNINGS =
134             "http://saxon.sf.net/feature/validation-warnings";
135 
136 
137     /**
138     * VERSION_WARNING must be a Boolean. This determines whether a warning should be output when
139      * running an XSLT 2.0 processor against an XSLT 1.0 stylesheet. The XSLT specification requires
140      * this to be done by default.
141     */
142 
143     public static final String   VERSION_WARNING =
144             "http://saxon.sf.net/feature/version-warning";
145 
146     /**
147     * COLLATION_URI_RESOLVER must be a {@link net.sf.saxon.sort.CollationURIResolver}.
148      * This resolver will be used to resolve collation URIs used in stylesheets compiled or executed under the
149      * control of this TransformerFactory
150     */
151 
152     public static final String   COLLATION_URI_RESOLVER = "http://saxon.sf.net/feature/collation-uri-resolver";
153 
154     /**
155     * COLLECTION_URI_RESOLVER must be a {@link net.sf.saxon.CollectionURIResolver}.
156      * This resolver will be used to resolve collection URIs used in calls of the collection() function
157     */
158 
159     public static final String   COLLECTION_URI_RESOLVER = "http://saxon.sf.net/feature/collection-uri-resolver";
160 
161     private FeatureKeys() {
162     }
163 }
164 
165 //
166 // The contents of this file are subject to the Mozilla Public License Version 1.0 (the "License");
167 // you may not use this file except in compliance with the License. You may obtain a copy of the
168 // License at http://www.mozilla.org/MPL/
169 //
170 // Software distributed under the License is distributed on an "AS IS" basis,
171 // WITHOUT WARRANTY OF ANY KIND, either express or implied.
172 // See the License for the specific language governing rights and limitations under the License.
173 //
174 // The Original Code is: all this file
175 //
176 // The Initial Developer of the Original Code is Michael H. Kay.
177 //
178 // Contributor(s):
179 //
180
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags