1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
<!--
- DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
-
- Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
-
- The contents of this file are subject to the terms of either the GNU
- General Public License Version 2 only ("GPL") or the Common
- Development and Distribution License("CDDL") (collectively, the
- "License"). You may not use this file except in compliance with the
- License. You can obtain a copy of the License at
- http://www.netbeans.org/cddl-gplv2.html
- or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
- specific language governing permissions and limitations under the
- License. When distributing the software, include this License Header
- Notice in each file and include the License file at
- nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
- particular file as subject to the "Classpath" exception as provided
- by Sun in the GPL Version 2 section of the License file that
- accompanied this code. If applicable, add the following below the
- License Header, with the fields enclosed by brackets [] replaced by
- your own identifying information:
- "Portions Copyrighted [year] [name of copyright owner]"
-
- Contributor(s):
-
- The Original Software is NetBeans. The Initial Developer of the Original
- Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
- Microsystems, Inc. All Rights Reserved.
-
- If you wish your version of this file to be governed by only the CDDL
- or only the GPL Version 2, indicate your decision by adding
- "[Contributor] elects to include this software in this distribution
- under the [CDDL or GPL Version 2] license." If you do not indicate a
- single choice of license, a recipient has the option to distribute
- your version of this file under either the CDDL, the GPL Version 2 or
- to extend the choice of license to its licensees as provided above.
- However, if you add GPL Version 2 code and therefore, elected the GPL
- Version 2 license, then the option applies only if the new code is
- made subject to such option by the copyright holder.
-->
<HTML>
<BODY>
XML Tools API overview.
<h2>Status</h2>
Under development.
See also <a href="apichanges.html">API changes</a> document.
<h2>Purpose</h2>
XML tools API simplifies writing inter-operable modules handling user's XML
resources. It also improves consistency of user experience as it introduces
minimum standard behavior support for all XML domains.
<h2>Supported Use Cases</h2>
<h3>Actions</h3>
XML is general document format that allows to define document structure
and semantics. It influences behavior of common user's actions. Particular
behavior of such action depends on specifics of defined semantics. This
can be modeled in OpenIDE APIs using cookies. XML tools API defines set of
common cookies {@link org.netbeans.api.xml.cookies} and support for their providers
{@link org.netbeans.spi.xml.cookies}.
<p>A user can take a cookie action from the action pool and put it on a data
object serving particular cookie. The action is performed via served cookie
that is aware of actual behavioural enhancement for given data object.
<h3>User's XML Document Parsing</h3>
All standard XML processors APIs define call-back interfaces that must be provided
by clients. Further evaluation identifies one type of application wide
call-back interface - entity resolution (e.g. in SAX called
{@link org.xml.sax.EntityResolver}). XML tools API introduces notion of context
user's entity catalog service {@link org.netbeans.api.xml.services.UserCatalog}
back-ended by plugged in providers.
<p>A user has all their entity registrations at one place for given context and
these are shared by all processors handling user's documents in the context.
<h3>Unification&Integration</h3>
Standard XML APIs (DOM, TrAX, SAX, OpenIDE) define a API for the same purpose
several times to avoid dependencies.
{@link org.netbeans.api.xml.parsers} provides classes bridging between them.
It also contains utility classes such as DTD parser.
<h3>Model</h3>
Looking for model and 2-way editing support? We are looking for ideas
how to define it!
<!-- Contributors & Reviewers:
Libor Kramolis
Svatopluk Dedic
Jaroslav Tulach
Petr Kuzel
-->
</BODY></HTML>
|
