001 /*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements. See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership. The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the "License");
007 * you may not use this file except in compliance with the License.
008 * You may obtain a copy of the License at
009 *
010 * http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018 /*
019 * $Id: XMLErrorResources.java 468653 2006-10-28 07:07:05Z minchau $
020 */
021 package org.apache.xml.res;
022
023
024 import java.util.ListResourceBundle;
025 import java.util.Locale;
026 import java.util.MissingResourceException;
027 import java.util.ResourceBundle;
028
029 /**
030 * Set up error messages.
031 * We build a two dimensional array of message keys and
032 * message strings. In order to add a new message here,
033 * you need to first add a String constant. And you need
034 * to enter key, value pair as part of the contents
035 * array. You also need to update MAX_CODE for error strings
036 * and MAX_WARNING for warnings ( Needed for only information
037 * purpose )
038 */
039 public class XMLErrorResources extends ListResourceBundle
040 {
041
042 /*
043 * This file contains error and warning messages related to Xalan Error
044 * Handling.
045 *
046 * General notes to translators:
047 *
048 * 1) Xalan (or more properly, Xalan-interpretive) and XSLTC are names of
049 * components.
050 * XSLT is an acronym for "XML Stylesheet Language: Transformations".
051 * XSLTC is an acronym for XSLT Compiler.
052 *
053 * 2) A stylesheet is a description of how to transform an input XML document
054 * into a resultant XML document (or HTML document or text). The
055 * stylesheet itself is described in the form of an XML document.
056 *
057 * 3) A template is a component of a stylesheet that is used to match a
058 * particular portion of an input document and specifies the form of the
059 * corresponding portion of the output document.
060 *
061 * 4) An element is a mark-up tag in an XML document; an attribute is a
062 * modifier on the tag. For example, in <elem attr='val' attr2='val2'>
063 * "elem" is an element name, "attr" and "attr2" are attribute names with
064 * the values "val" and "val2", respectively.
065 *
066 * 5) A namespace declaration is a special attribute that is used to associate
067 * a prefix with a URI (the namespace). The meanings of element names and
068 * attribute names that use that prefix are defined with respect to that
069 * namespace.
070 *
071 * 6) "Translet" is an invented term that describes the class file that
072 * results from compiling an XML stylesheet into a Java class.
073 *
074 * 7) XPath is a specification that describes a notation for identifying
075 * nodes in a tree-structured representation of an XML document. An
076 * instance of that notation is referred to as an XPath expression.
077 *
078 */
079
080 /*
081 * Message keys
082 */
083 public static final String ER_FUNCTION_NOT_SUPPORTED = "ER_FUNCTION_NOT_SUPPORTED";
084 public static final String ER_CANNOT_OVERWRITE_CAUSE = "ER_CANNOT_OVERWRITE_CAUSE";
085 public static final String ER_NO_DEFAULT_IMPL = "ER_NO_DEFAULT_IMPL";
086 public static final String ER_CHUNKEDINTARRAY_NOT_SUPPORTED = "ER_CHUNKEDINTARRAY_NOT_SUPPORTED";
087 public static final String ER_OFFSET_BIGGER_THAN_SLOT = "ER_OFFSET_BIGGER_THAN_SLOT";
088 public static final String ER_COROUTINE_NOT_AVAIL = "ER_COROUTINE_NOT_AVAIL";
089 public static final String ER_COROUTINE_CO_EXIT = "ER_COROUTINE_CO_EXIT";
090 public static final String ER_COJOINROUTINESET_FAILED = "ER_COJOINROUTINESET_FAILED";
091 public static final String ER_COROUTINE_PARAM = "ER_COROUTINE_PARAM";
092 public static final String ER_PARSER_DOTERMINATE_ANSWERS = "ER_PARSER_DOTERMINATE_ANSWERS";
093 public static final String ER_NO_PARSE_CALL_WHILE_PARSING = "ER_NO_PARSE_CALL_WHILE_PARSING";
094 public static final String ER_TYPED_ITERATOR_AXIS_NOT_IMPLEMENTED = "ER_TYPED_ITERATOR_AXIS_NOT_IMPLEMENTED";
095 public static final String ER_ITERATOR_AXIS_NOT_IMPLEMENTED = "ER_ITERATOR_AXIS_NOT_IMPLEMENTED";
096 public static final String ER_ITERATOR_CLONE_NOT_SUPPORTED = "ER_ITERATOR_CLONE_NOT_SUPPORTED";
097 public static final String ER_UNKNOWN_AXIS_TYPE = "ER_UNKNOWN_AXIS_TYPE";
098 public static final String ER_AXIS_NOT_SUPPORTED = "ER_AXIS_NOT_SUPPORTED";
099 public static final String ER_NO_DTMIDS_AVAIL = "ER_NO_DTMIDS_AVAIL";
100 public static final String ER_NOT_SUPPORTED = "ER_NOT_SUPPORTED";
101 public static final String ER_NODE_NON_NULL = "ER_NODE_NON_NULL";
102 public static final String ER_COULD_NOT_RESOLVE_NODE = "ER_COULD_NOT_RESOLVE_NODE";
103 public static final String ER_STARTPARSE_WHILE_PARSING = "ER_STARTPARSE_WHILE_PARSING";
104 public static final String ER_STARTPARSE_NEEDS_SAXPARSER = "ER_STARTPARSE_NEEDS_SAXPARSER";
105 public static final String ER_COULD_NOT_INIT_PARSER = "ER_COULD_NOT_INIT_PARSER";
106 public static final String ER_EXCEPTION_CREATING_POOL = "ER_EXCEPTION_CREATING_POOL";
107 public static final String ER_PATH_CONTAINS_INVALID_ESCAPE_SEQUENCE = "ER_PATH_CONTAINS_INVALID_ESCAPE_SEQUENCE";
108 public static final String ER_SCHEME_REQUIRED = "ER_SCHEME_REQUIRED";
109 public static final String ER_NO_SCHEME_IN_URI = "ER_NO_SCHEME_IN_URI";
110 public static final String ER_NO_SCHEME_INURI = "ER_NO_SCHEME_INURI";
111 public static final String ER_PATH_INVALID_CHAR = "ER_PATH_INVALID_CHAR";
112 public static final String ER_SCHEME_FROM_NULL_STRING = "ER_SCHEME_FROM_NULL_STRING";
113 public static final String ER_SCHEME_NOT_CONFORMANT = "ER_SCHEME_NOT_CONFORMANT";
114 public static final String ER_HOST_ADDRESS_NOT_WELLFORMED = "ER_HOST_ADDRESS_NOT_WELLFORMED";
115 public static final String ER_PORT_WHEN_HOST_NULL = "ER_PORT_WHEN_HOST_NULL";
116 public static final String ER_INVALID_PORT = "ER_INVALID_PORT";
117 public static final String ER_FRAG_FOR_GENERIC_URI ="ER_FRAG_FOR_GENERIC_URI";
118 public static final String ER_FRAG_WHEN_PATH_NULL = "ER_FRAG_WHEN_PATH_NULL";
119 public static final String ER_FRAG_INVALID_CHAR = "ER_FRAG_INVALID_CHAR";
120 public static final String ER_PARSER_IN_USE = "ER_PARSER_IN_USE";
121 public static final String ER_CANNOT_CHANGE_WHILE_PARSING = "ER_CANNOT_CHANGE_WHILE_PARSING";
122 public static final String ER_SELF_CAUSATION_NOT_PERMITTED = "ER_SELF_CAUSATION_NOT_PERMITTED";
123 public static final String ER_NO_USERINFO_IF_NO_HOST = "ER_NO_USERINFO_IF_NO_HOST";
124 public static final String ER_NO_PORT_IF_NO_HOST = "ER_NO_PORT_IF_NO_HOST";
125 public static final String ER_NO_QUERY_STRING_IN_PATH = "ER_NO_QUERY_STRING_IN_PATH";
126 public static final String ER_NO_FRAGMENT_STRING_IN_PATH = "ER_NO_FRAGMENT_STRING_IN_PATH";
127 public static final String ER_CANNOT_INIT_URI_EMPTY_PARMS = "ER_CANNOT_INIT_URI_EMPTY_PARMS";
128 public static final String ER_METHOD_NOT_SUPPORTED ="ER_METHOD_NOT_SUPPORTED";
129 public static final String ER_INCRSAXSRCFILTER_NOT_RESTARTABLE = "ER_INCRSAXSRCFILTER_NOT_RESTARTABLE";
130 public static final String ER_XMLRDR_NOT_BEFORE_STARTPARSE = "ER_XMLRDR_NOT_BEFORE_STARTPARSE";
131 public static final String ER_AXIS_TRAVERSER_NOT_SUPPORTED = "ER_AXIS_TRAVERSER_NOT_SUPPORTED";
132 public static final String ER_ERRORHANDLER_CREATED_WITH_NULL_PRINTWRITER = "ER_ERRORHANDLER_CREATED_WITH_NULL_PRINTWRITER";
133 public static final String ER_SYSTEMID_UNKNOWN = "ER_SYSTEMID_UNKNOWN";
134 public static final String ER_LOCATION_UNKNOWN = "ER_LOCATION_UNKNOWN";
135 public static final String ER_PREFIX_MUST_RESOLVE = "ER_PREFIX_MUST_RESOLVE";
136 public static final String ER_CREATEDOCUMENT_NOT_SUPPORTED = "ER_CREATEDOCUMENT_NOT_SUPPORTED";
137 public static final String ER_CHILD_HAS_NO_OWNER_DOCUMENT = "ER_CHILD_HAS_NO_OWNER_DOCUMENT";
138 public static final String ER_CHILD_HAS_NO_OWNER_DOCUMENT_ELEMENT = "ER_CHILD_HAS_NO_OWNER_DOCUMENT_ELEMENT";
139 public static final String ER_CANT_OUTPUT_TEXT_BEFORE_DOC = "ER_CANT_OUTPUT_TEXT_BEFORE_DOC";
140 public static final String ER_CANT_HAVE_MORE_THAN_ONE_ROOT = "ER_CANT_HAVE_MORE_THAN_ONE_ROOT";
141 public static final String ER_ARG_LOCALNAME_NULL = "ER_ARG_LOCALNAME_NULL";
142 public static final String ER_ARG_LOCALNAME_INVALID = "ER_ARG_LOCALNAME_INVALID";
143 public static final String ER_ARG_PREFIX_INVALID = "ER_ARG_PREFIX_INVALID";
144 public static final String ER_NAME_CANT_START_WITH_COLON = "ER_NAME_CANT_START_WITH_COLON";
145
146 /*
147 * Now fill in the message text.
148 * Then fill in the message text for that message code in the
149 * array. Use the new error code as the index into the array.
150 */
151
152 // Error messages...
153
154 /**
155 * Get the lookup table for error messages
156 *
157 * @return The association list.
158 */
159 public Object[][] getContents()
160 {
161 return new Object[][] {
162
163 /** Error message ID that has a null message, but takes in a single object. */
164 {"ER0000" , "{0}" },
165
166 { ER_FUNCTION_NOT_SUPPORTED,
167 "Function not supported!"},
168
169 { ER_CANNOT_OVERWRITE_CAUSE,
170 "Cannot overwrite cause"},
171
172 { ER_NO_DEFAULT_IMPL,
173 "No default implementation found "},
174
175 { ER_CHUNKEDINTARRAY_NOT_SUPPORTED,
176 "ChunkedIntArray({0}) not currently supported"},
177
178 { ER_OFFSET_BIGGER_THAN_SLOT,
179 "Offset bigger than slot"},
180
181 { ER_COROUTINE_NOT_AVAIL,
182 "Coroutine not available, id={0}"},
183
184 { ER_COROUTINE_CO_EXIT,
185 "CoroutineManager received co_exit() request"},
186
187 { ER_COJOINROUTINESET_FAILED,
188 "co_joinCoroutineSet() failed"},
189
190 { ER_COROUTINE_PARAM,
191 "Coroutine parameter error ({0})"},
192
193 { ER_PARSER_DOTERMINATE_ANSWERS,
194 "\nUNEXPECTED: Parser doTerminate answers {0}"},
195
196 { ER_NO_PARSE_CALL_WHILE_PARSING,
197 "parse may not be called while parsing"},
198
199 { ER_TYPED_ITERATOR_AXIS_NOT_IMPLEMENTED,
200 "Error: typed iterator for axis {0} not implemented"},
201
202 { ER_ITERATOR_AXIS_NOT_IMPLEMENTED,
203 "Error: iterator for axis {0} not implemented "},
204
205 { ER_ITERATOR_CLONE_NOT_SUPPORTED,
206 "Iterator clone not supported"},
207
208 { ER_UNKNOWN_AXIS_TYPE,
209 "Unknown axis traversal type: {0}"},
210
211 { ER_AXIS_NOT_SUPPORTED,
212 "Axis traverser not supported: {0}"},
213
214 { ER_NO_DTMIDS_AVAIL,
215 "No more DTM IDs are available"},
216
217 { ER_NOT_SUPPORTED,
218 "Not supported: {0}"},
219
220 { ER_NODE_NON_NULL,
221 "Node must be non-null for getDTMHandleFromNode"},
222
223 { ER_COULD_NOT_RESOLVE_NODE,
224 "Could not resolve the node to a handle"},
225
226 { ER_STARTPARSE_WHILE_PARSING,
227 "startParse may not be called while parsing"},
228
229 { ER_STARTPARSE_NEEDS_SAXPARSER,
230 "startParse needs a non-null SAXParser"},
231
232 { ER_COULD_NOT_INIT_PARSER,
233 "could not initialize parser with"},
234
235 { ER_EXCEPTION_CREATING_POOL,
236 "exception creating new instance for pool"},
237
238 { ER_PATH_CONTAINS_INVALID_ESCAPE_SEQUENCE,
239 "Path contains invalid escape sequence"},
240
241 { ER_SCHEME_REQUIRED,
242 "Scheme is required!"},
243
244 { ER_NO_SCHEME_IN_URI,
245 "No scheme found in URI: {0}"},
246
247 { ER_NO_SCHEME_INURI,
248 "No scheme found in URI"},
249
250 { ER_PATH_INVALID_CHAR,
251 "Path contains invalid character: {0}"},
252
253 { ER_SCHEME_FROM_NULL_STRING,
254 "Cannot set scheme from null string"},
255
256 { ER_SCHEME_NOT_CONFORMANT,
257 "The scheme is not conformant."},
258
259 { ER_HOST_ADDRESS_NOT_WELLFORMED,
260 "Host is not a well formed address"},
261
262 { ER_PORT_WHEN_HOST_NULL,
263 "Port cannot be set when host is null"},
264
265 { ER_INVALID_PORT,
266 "Invalid port number"},
267
268 { ER_FRAG_FOR_GENERIC_URI,
269 "Fragment can only be set for a generic URI"},
270
271 { ER_FRAG_WHEN_PATH_NULL,
272 "Fragment cannot be set when path is null"},
273
274 { ER_FRAG_INVALID_CHAR,
275 "Fragment contains invalid character"},
276
277 { ER_PARSER_IN_USE,
278 "Parser is already in use"},
279
280 { ER_CANNOT_CHANGE_WHILE_PARSING,
281 "Cannot change {0} {1} while parsing"},
282
283 { ER_SELF_CAUSATION_NOT_PERMITTED,
284 "Self-causation not permitted"},
285
286 { ER_NO_USERINFO_IF_NO_HOST,
287 "Userinfo may not be specified if host is not specified"},
288
289 { ER_NO_PORT_IF_NO_HOST,
290 "Port may not be specified if host is not specified"},
291
292 { ER_NO_QUERY_STRING_IN_PATH,
293 "Query string cannot be specified in path and query string"},
294
295 { ER_NO_FRAGMENT_STRING_IN_PATH,
296 "Fragment cannot be specified in both the path and fragment"},
297
298 { ER_CANNOT_INIT_URI_EMPTY_PARMS,
299 "Cannot initialize URI with empty parameters"},
300
301 { ER_METHOD_NOT_SUPPORTED,
302 "Method not yet supported "},
303
304 { ER_INCRSAXSRCFILTER_NOT_RESTARTABLE,
305 "IncrementalSAXSource_Filter not currently restartable"},
306
307 { ER_XMLRDR_NOT_BEFORE_STARTPARSE,
308 "XMLReader not before startParse request"},
309
310 { ER_AXIS_TRAVERSER_NOT_SUPPORTED,
311 "Axis traverser not supported: {0}"},
312
313 { ER_ERRORHANDLER_CREATED_WITH_NULL_PRINTWRITER,
314 "ListingErrorHandler created with null PrintWriter!"},
315
316 { ER_SYSTEMID_UNKNOWN,
317 "SystemId Unknown"},
318
319 { ER_LOCATION_UNKNOWN,
320 "Location of error unknown"},
321
322 { ER_PREFIX_MUST_RESOLVE,
323 "Prefix must resolve to a namespace: {0}"},
324
325 { ER_CREATEDOCUMENT_NOT_SUPPORTED,
326 "createDocument() not supported in XPathContext!"},
327
328 { ER_CHILD_HAS_NO_OWNER_DOCUMENT,
329 "Attribute child does not have an owner document!"},
330
331 { ER_CHILD_HAS_NO_OWNER_DOCUMENT_ELEMENT,
332 "Attribute child does not have an owner document element!"},
333
334 { ER_CANT_OUTPUT_TEXT_BEFORE_DOC,
335 "Warning: can't output text before document element! Ignoring..."},
336
337 { ER_CANT_HAVE_MORE_THAN_ONE_ROOT,
338 "Can't have more than one root on a DOM!"},
339
340 { ER_ARG_LOCALNAME_NULL,
341 "Argument 'localName' is null"},
342
343 // Note to translators: A QNAME has the syntactic form [NCName:]NCName
344 // The localname is the portion after the optional colon; the message indicates
345 // that there is a problem with that part of the QNAME.
346 { ER_ARG_LOCALNAME_INVALID,
347 "Localname in QNAME should be a valid NCName"},
348
349 // Note to translators: A QNAME has the syntactic form [NCName:]NCName
350 // The prefix is the portion before the optional colon; the message indicates
351 // that there is a problem with that part of the QNAME.
352 { ER_ARG_PREFIX_INVALID,
353 "Prefix in QNAME should be a valid NCName"},
354
355 { ER_NAME_CANT_START_WITH_COLON,
356 "Name cannot start with a colon"},
357
358 { "BAD_CODE", "Parameter to createMessage was out of bounds"},
359 { "FORMAT_FAILED", "Exception thrown during messageFormat call"},
360 { "line", "Line #"},
361 { "column","Column #"}
362
363
364 };
365 }
366
367 /**
368 * Return a named ResourceBundle for a particular locale. This method mimics the behavior
369 * of ResourceBundle.getBundle().
370 *
371 * @param className the name of the class that implements the resource bundle.
372 * @return the ResourceBundle
373 * @throws MissingResourceException
374 */
375 public static final XMLErrorResources loadResourceBundle(String className)
376 throws MissingResourceException
377 {
378
379 Locale locale = Locale.getDefault();
380 String suffix = getResourceSuffix(locale);
381
382 try
383 {
384
385 // first try with the given locale
386 return (XMLErrorResources) ResourceBundle.getBundle(className
387 + suffix, locale);
388 }
389 catch (MissingResourceException e)
390 {
391 try // try to fall back to en_US if we can't load
392 {
393
394 // Since we can't find the localized property file,
395 // fall back to en_US.
396 return (XMLErrorResources) ResourceBundle.getBundle(className,
397 new Locale("en", "US"));
398 }
399 catch (MissingResourceException e2)
400 {
401
402 // Now we are really in trouble.
403 // very bad, definitely very bad...not going to get very far
404 throw new MissingResourceException(
405 "Could not load any resource bundles.", className, "");
406 }
407 }
408 }
409
410 /**
411 * Return the resource file suffic for the indicated locale
412 * For most locales, this will be based the language code. However
413 * for Chinese, we do distinguish between Taiwan and PRC
414 *
415 * @param locale the locale
416 * @return an String suffix which canbe appended to a resource name
417 */
418 private static final String getResourceSuffix(Locale locale)
419 {
420
421 String suffix = "_" + locale.getLanguage();
422 String country = locale.getCountry();
423
424 if (country.equals("TW"))
425 suffix += "_" + country;
426
427 return suffix;
428 }
429
430 }