You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by sa...@apache.org on 2001/10/25 22:19:36 UTC
cvs commit: xml-xerces/java/docs faq-pcfp.xml limitations-schema.xml docs-book.xml features.xml limitations.xml releases.xml
sandygao 01/10/25 13:19:36
Modified: java/docs docs-book.xml features.xml limitations.xml
releases.xml
Added: java/docs faq-pcfp.xml limitations-schema.xml
Log:
Documentation changes for new Schema alpha release.
Revision Changes Path
1.10 +2 -0 xml-xerces/java/docs/docs-book.xml
Index: docs-book.xml
===================================================================
RCS file: /home/cvs/xml-xerces/java/docs/docs-book.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- docs-book.xml 2001/08/28 04:26:22 1.9
+++ docs-book.xml 2001/10/25 20:19:36 1.10
@@ -37,6 +37,7 @@
<faqs label='FAQs' title='Frequently Asked Questions' id='faqs'>
<faq title='Common FAQs' id='faq-common' source='faq-common.xml'/>
<faq title='General FAQs' id='faq-general' source='faq-general.xml'/>
+ <faq title='Parser Configuration, Features and Properties FAQs' id='faq-pcfp' source='faq-pcfp.xml'/>
<faq title='Building and Running FAQs'
id='faq-build' source='faq-build.xml'/>
<faq title='Writing Applications FAQs'
@@ -54,6 +55,7 @@
id='releases' source='releases.xml'/>
<document label='Limitations' title='Parser Limitations'
id='limitations' source='limitations.xml'/>
+ <hidden title='Schema Implementation Limitations' id='limitations-schema' source='limitations-schema.xml'/>
<external label='Report a Bug'
href='http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Xerces2-J'/>
</book>
1.18 +15 -6 xml-xerces/java/docs/features.xml
Index: features.xml
===================================================================
RCS file: /home/cvs/xml-xerces/java/docs/features.xml,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- features.xml 2001/08/28 00:49:14 1.17
+++ features.xml 2001/10/25 20:19:36 1.18
@@ -96,16 +96,25 @@
<default value='false'/>
<see idref='validation'/>
</feature>
- <!--
- - REVISIT: Add these features back in once we have Schema
- - support in this version.
- -
<feature name='http://apache.org/xml/features/validation/schema'
id='validation.schema'>
- <true>Turn on XML Schema support.</true>
- <false>Turn off XML Schema support.</false>
+ <true>Report XML Schema validation errors.</true>
+ <false>Do not report XML Schema validation errors.</false>
<default value='true'/>
+ <access parsing='read-only' not-parsing='read-write'/>
+ <note>
+ The meaning of this feature is not finalized. Please refer
+ to FAQ <link idref='faq-pcfp'>Parser configuration, Features
+ and Properties FAQs</link>.
+ </note>
+ <see idref='validation'/>
+ <see idref='validation.dynamic'/>
+ <see idref='namespaces'/>
</feature>
+ <!--
+ - REVISIT: Do we still need this feature in X2?
+ - Or still use it to control whether we do UPA/PD checking?
+ -
<feature name='http://apache.org/xml/features/validation/schema-full-checking'
id='validation.schema-full-checking'>
<true>
1.3 +3 -1 xml-xerces/java/docs/limitations.xml
Index: limitations.xml
===================================================================
RCS file: /home/cvs/xml-xerces/java/docs/limitations.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- limitations.xml 2001/08/23 00:35:14 1.2
+++ limitations.xml 2001/10/25 20:19:36 1.3
@@ -3,7 +3,9 @@
<s1 title='Limitations'>
<s2 title='Known Limitations'>
<p>
- This is a list of the limitations in this release of &ParserName;:
+ This is a list of the limitations in this release of &ParserName;.
+ There is also a list of <link idref='limitations-schema'>
+ XML Schema limitations</link>.
</p>
<ul>
<li>
1.81 +1 -1 xml-xerces/java/docs/releases.xml
Index: releases.xml
===================================================================
RCS file: /home/cvs/xml-xerces/java/docs/releases.xml,v
retrieving revision 1.80
retrieving revision 1.81
diff -u -r1.80 -r1.81
--- releases.xml 2001/10/24 05:27:21 1.80
+++ releases.xml 2001/10/25 20:19:36 1.81
@@ -3,7 +3,7 @@
<releases>
<release version='Xerces 2.0.0 (beta3)'>
<desc>
- This releases fixes a number of bugs, introduces some changes to
+ This release fixes a number of bugs, introduces some changes to
the Xerces Native Interface, and is the first Xerces2 release to
include XML Schema validation support. Please note that the XML
Schema validation code was completely rewritten for Xerces2 and
1.1 xml-xerces/java/docs/faq-pcfp.xml
Index: faq-pcfp.xml
===================================================================
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE faqs SYSTEM 'dtd/faqs.dtd'>
<faqs title='Parser Configuration, Features and Properties FAQs'>
<faq title='Validation Components'>
<q>What's the result of having a DTD validator or XML Schema validator in the pipeline?</q>
<a>
<p>
If a validator is included in the pipeline, assessment is
done, whether the validation feature is set to true or false.
Currently, validation only enables the reporting of error
messages. This behaviour may be revisited/changed in the future.
</p>
</a>
</faq>
<faq title='Default Parser Configuration'>
<q>What vaidation behavior do I expect from the default parser configuration?</q>
<a>
<p>
The default configuration includes both DTD validator and XML
schema validator, so it's capable of validating an instance
against both kinds of grammars. But this could bring some
performance hit for those applications that only process XML
documents with DTD. If you cares about performance, and only
use DTD, please use DTD configuration instead.
</p>
</a>
</faq>
<faq title='Validation Features'>
<q>What happens if I set both validation and schema validation features on?</q>
<a>
<p>
If only one of DTD validation and XML Schema validator
is present in the pipeline, then we only consider the
feature corresponding to this validator, and ignore the
other one.
</p>
<p>
If both validators are present in the pipeline, then
</p>
<ul>
<li>if the instance document has only a DTD grammar
(DOCTYPE before the root element), then only DTD
validation errors are reported;</li>
<li>if the instance document has only XML Schema grammars,
then only XML Schema validation errors are reported
(we consider an instance document to have a XML Schema
grammar if either xsi:schemaLocation or
xsi:noNamespaceSchemaLocation attribute is present
on the root element. This might change after we
support grammar caching);</li>
<li>if the instance document has both DTD and XML Schema
grammars, validation errors for both DTD and XML
Schema are reported;</li>
<li>if no grammar can be found for the instance document,
then XML Schema validation errors are reported.</li>
</ul>
<p>
NOTE: The above is the current interpretation of the
validation features. It may change in future
Xerces releases.
</p>
</a>
</faq>
<faq title='External Schema Location Properties'>
<q>Where are the two schema location properties introduced in Xerces 1?</q>
<a>
<p>
External schema location properties are not currently
supported in Xerces 2. We're examining how to support
this for the next Schema release.
</p>
</a>
</faq>
</faqs>
1.1 xml-xerces/java/docs/limitations-schema.xml
Index: limitations-schema.xml
===================================================================
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE s1 SYSTEM 'dtd/document.dtd'>
<s1 title="Schema Implementation Limitations">
<s2 title="Introduction">
<p>This package contains an implementation of the W3C XML
Schema Language, a recommendation of the Worldwide Web Consortium
available in three parts:
<jump href="http://www.w3.org/TR/XMLSchema-0">XML Schema: Primer</jump> and
<jump href="http://www.w3.org/TR/XMLSchema-1">XML Schema: Structures</jump> and
<jump href="http://www.w3.org/TR/XMLSchema-2">XML Schema: Datatypes</jump>.
We consider this implementation to be complete except for the
limitations cited below. The implementation has been
extensively tested and known problem areas are set out below.
In this document we also discuss our interpretation of the
specifications where it seems to us particularly likely that
others might arrive at a different interpretation.
Please read this document before using this package.
</p>
</s2>
<s2 title="Limitations">
<ul>
<li>No interface is provided for exposing the post-schema
validation infoset , beyond
that provided by DOM or SAX;</li>
<li>There are certain constraints that we don't check in
this release, namely:
<br/> - Unique Particle Attribution;
<br/> - Particle Valid (Restriction);
<br/> - Element Declarations Consistent.
</li>
<li> Length, minLength, and maxLength facets are limited to the value
2147483647. Items larger than this limit will not be validated
correctly.</li>
<li> Year and seconds values in date/time datatypes are limited to the
value 2147483647. Items larger than this limit will not be validated
correctly. </li>
</ul>
</s2>
<s2 title='Problem Areas/Known Bugs'>
<ul>
<li> Due to changes in the specification for Decimals in
JDK1.3, not all decimals that should be invalid according
to the Schema specs may be found by the parser;</li>
<li> When the same schema document is both imported and
included by the same schema document, only the first one
takes effect;</li>
<li> If an imported/inluded/redefined schema document is
specified via a relative path, sometimes the parser fails
to locate such document.</li>
</ul>
</s2>
<s2 title='Interpretation of Areas that are Unclear or
Implementation-Dependent'>
<ul>
<li> QName: the specification does not define the unit of length. We
chose to implement the length facet as being in units of XML characters
in the value space ( # of chars in namespace URI + ":" +
local part );</li>
<li> We have interpreted the specs as requiring
<keyref> Identity Constraints to refer to
<key> or <unique> identity constraints within
the scope of the elements to which the <keyref> is
attached. This interpretation is at variance with the
Schema Primer, which contains an example with a
<keyref> declared on an element used inside the
element of its corresponding <key>;</li>
</ul>
</s2>
<s2 title="Other Notes">
<p> The parsers contained in this package are able to read and
validate XML documents with the grammar specified in either
DTD or XML Schema format.
The schema is specified by the xsi:schemaLocation or
xsi:noNamespaceSchemaLocation attribute on the root
element of the document. The xsi prefix must be bound to the
Schema document instance namespace, as specified by the
Recommendation. See the sample provided in the
Usage section.</p>
</s2>
<s2 title="Usage">
<p>In this release, schema validation has been integrated with the
regular SAXParser and DOMParser classes. No special classes are
required to parse documents that use a schema.</p>
<p>Each document that uses XML Schema grammars must specify the location of the
grammars it uses by using an xsi:schemaLocation attribute if they use
namespaces, and an xsi:noNamespaceSchemaLocation attribute
otherwise. These are usually placed on the root / top-level element
in the document, though they may occur on any element; for more details see XML
Schema Part 1 section 4.3.2.
Here is an example with no target namespace: </p>
<source><document
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xsi:noNamespaceSchemaLocation='document.xsd'>
...
</document></source>
<p>Here is an example with a target namespace. Note that it is an
error to specify a different namespace than the target namespace
defined in the Schema.</p>
<source><document
xmlns='http://my.com'
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xsi:schemaLocation='http://my.com document.xsd'>
...
</document></source>
<p>Review the sample file, 'data/personal.xsd' for an example of an XML
Schema grammar.</p>
</s2>
</s1>
---------------------------------------------------------------------
To unsubscribe, e-mail: xerces-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xerces-cvs-help@xml.apache.org