Skip to content

Commit 8ade9fd

Browse files
committed
Merge pull request geotools#418 from bradh/faqdocs
Trivial documentation fixes.
2 parents 5c9e3f3 + 154489e commit 8ade9fd

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/user/library/xml/faq.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ XML FAQ
44
Q: What parser does GeoTools use?
55
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
66

7-
We have a range of tools to help you with parsing and encoding xml. As a
7+
We have a range of tools to help you with parsing and encoding XML. As a
88
general purpose library GeoTools does not have the luxury of choosing a
99
parser to work with.
1010

@@ -20,36 +20,36 @@ use GeoTools in.
2020
| | | | | SLD | |
2121
+------------+-----+-----+--------+---------+------------------------------+
2222
| DOM | | dom | | Filter | Forgiving and easy to trace |
23-
| | | | | GLM | through and debug, memory |
23+
| | | | | GML | through and debug, memory |
2424
| | | | | SLD | limitation for GIS data |
2525
+------------+-----+-----+--------+---------+------------------------------+
26-
| Transform | | | xml | Filter | Easy to trace through and |
26+
| Transform | | | XML | Filter | Easy to trace through and |
2727
| | | | | GML2 | debug, difficult to |
2828
| | | | | SLD | configure for specific data |
2929
+------------+-----+-----+--------+---------+------------------------------+
30-
| JABX | sax | dom | xml | n/a | Fast but not suitable for |
30+
| JABX | sax | dom | XML | n/a | Fast but not suitable for |
3131
| | | | | | dynamic data, precomplied |
3232
+------------+-----+-----+--------+---------+------------------------------+
3333
| Pull | sax | dom | | n/a | Should combine the ease of |
3434
| | | | | | DOM with the streaming |
3535
| | | | | | performance of XDO and GTXML |
3636
+------------+-----+-----+--------+---------+------------------------------+
37-
| XDO | sax | dom | xml | Filter | Proof of concept of schema |
37+
| XDO | sax | dom | XML | Filter | Proof of concept of schema |
3838
| | | | | GML | assisted parsing allowing |
3939
| | | | | SLD | streaming into Java Objects. |
4040
| | | | | WMS | Code is fast and well tested |
4141
| | | | | WFS1.0 | but is hard to trace through |
4242
| | | | | XSD | |
4343
+------------+-----+-----+--------+---------+------------------------------+
44-
| GTXML | sax | dom | xml | Filter | Schema assisted parsing |
44+
| GTXML | sax | dom | XML | Filter | Schema assisted parsing |
4545
| | | | | GML | backed by Eclipse XSD |
4646
| | | | | SLD | to represent schema. |
4747
| | | | | WMS | |
4848
| | | | | WFS1.0 | Easier to trace through but |
4949
| | | | | WFS1.1 | still not straight forward |
5050
| | | | | WPS | |
5151
| | | | | XSD | Allows streaming for large |
52-
| | | | | | GIS data volumnes. |
52+
| | | | | | GIS data volumes. |
5353
+------------+-----+-----+--------+---------+------------------------------+
5454

5555
The XDO and GTXML solutions are configuration based. You set up a configuration
@@ -66,7 +66,7 @@ Q: What is SAX?
6666
SAX is a W3C technology from the early days of XML. SAX Parsers work using
6767
callbacks, they pass control between several hard coded implementations. For
6868
basic use you create your own SAX Parser (say responding to a new Geometry being
69-
parsed) and pass control off on of the geotools implementations and wait for it
69+
parsed) and pass control off to the GeoTools implementations and wait for it
7070
to call you.
7171

7272
* Allows streaming for large content.
@@ -107,7 +107,7 @@ Delegation is hard coded in much the same way as with the SAX parsers.
107107
Q: What is XML Transform?
108108
^^^^^^^^^^^^^^^^^^^^^^^^^
109109

110-
Traditional xml generation, traverse your data structure and call methods
110+
Traditional XML generation, traverse your data structure and call methods
111111
to generate as you go.
112112

113113
* very fast, so fast we use it for GeoServer even though it is hard to maintain
@@ -125,15 +125,15 @@ This idea of "Schema Assisted" parsers is a GeoTools specific piece of
125125
technology. Then general idea is to makes use of XML Schema information to
126126
minimise the amount of code you need to write.
127127

128-
A parser is supplied a configuration of bindings; each binding maps an xml
129-
elements or xml attributes to Java class.
128+
A parser is supplied a configuration of bindings; each binding maps an XML
129+
elements or XML attributes to Java class.
130130

131-
While this sounds similar to other xml parsing technologies we do have a
131+
While this sounds similar to other XML parsing technologies we do have a
132132
couple of key differences:
133133

134134
* taking special care to pay attention to the schema at runtime (so we can parse
135135
new documents using the "best" binding available rather than fail)
136-
* Ensure that data is not loaded into memory; allowing us to "stream" the xml
136+
* Ensure that data is not loaded into memory; allowing us to "stream" the XML
137137
document through an application.
138138
* We are on our third generation schema assisted parser.
139139

@@ -162,7 +162,7 @@ call. The XSD is used to hold our representation of the schema at runtime.
162162
* support for content generation
163163
* hard to debug and trace through the parsing or encoding process
164164
* code generator available to jump start the development of bindings
165-
* examples how how to use Eclipse Modelling Objects (EMF) based bindings to
165+
* examples how how to use Eclipse Modeling Objects (EMF) based bindings to
166166
work directly from the schema
167167

168168
Q: Why doesn't GeoTools use JAXB?
@@ -184,7 +184,7 @@ This shows up as the following error:
184184

185185

186186
To understand this error please remember that the GML returned by a WFS GetFeatures
187-
request is a normal XML file, with a reference to an XML schemaat the top.
187+
request is a normal XML file, with a reference to an XML schema at the top.
188188

189189
For a WFS GetFeature response the schema reference is usually a DescribeFeatureType call that returns
190190
an XML Schema.
@@ -226,7 +226,7 @@ to a copy of the GML schema included in the GeoTools jars; rather than force the
226226
the GML schema each time).
227227

228228
1. To customise how XML Schemas are located in a restricted environment (such as web portal for multiple
229-
WFS services that require authorization, or require the use of an http proxy for schema requests).
229+
WFS services that require authorization, or require the use of an HTTP proxy for schema requests).
230230

231231
2. Create custom SchemaLocator we start with configuration like so::
232232

0 commit comments

Comments
 (0)