| java.lang.Object
 org.geoserver.ows.XmlRequestReader
All known Subclasses: org.geoserver.ows.MessageXmlParser, org.geoserver.wfsv.xml.v1_1_0.WfsvXmlReader, org.geoserver.ows.adapters.XmlRequestReaderAdapter, org.geoserver.wfs.xml.v1_0_0.WfsXmlReader, org.geoserver.wfs.xml.v1_1_0.WfsXmlReader, org.geoserver.wfsv.xml.v1_1_0.WfsXmlReader, org.geoserver.wms.xml.SLDXmlRequestReader,
| XmlRequestReader | | abstract public class XmlRequestReader (Code) | | Creates a request bean from xml.
A request bean is an object which captures the parameters of an operation
being requested to a service.
An xml request reader must declare the root element of xml documents that it
is capable of reading. This is accomplished with
XmlRequestReader.getNamespace() and
XmlRequestReader.getElement() .
author:
Justin Deoliveira, The Open Planning Project, jdeolive@openplans.org |
| Method Summary | |
| public boolean | equals(Object obj)
Two XmlReaders considered equal if namespace,element, and version properties
are the same. | | public QName | getElement()
| | public String | getServiceId()
| | public Version | getVersion()
| | public int | hashCode()
Implementation of hashcode. | | abstract public Object | read(Object request, Reader reader, Map kvp)
Reads the xml and initializes the request object.
The request parameter may be null, so in this case
the request reader would be responsible for creating the request object,
or throwing an exception if this is not supported. |
| element | | final QName element(Code) | | the qualified name of the element this reader can read.
|
| version | | final Version version(Code) | | Appliction specific version number.
|
| XmlRequestReader | | public XmlRequestReader(QName element)(Code) | | Creates the xml reader for the specified element.
Parameters:
element - The qualified name of the element the reader reads. |
| XmlRequestReader | | public XmlRequestReader(String namespace, String local)(Code) | | Creates the xml reader for the specified element.
Parameters:
namespace - The namespace of the element
Parameters:
local - The local name of the element |
| XmlRequestReader | | public XmlRequestReader(QName element, Version version, String serviceId)(Code) | | Creates the xml reader for the specified element of a particular version.
Parameters:
element - The qualified name of the element the reader reads.
Parameters:
version - The version of the element in which the reader supports,may be null. |
| equals | | public boolean equals(Object obj)(Code) | | Two XmlReaders considered equal if namespace,element, and version properties
are the same.
|
| getElement | | public QName getElement()(Code) | | The qualified name of the element that this reader reads. |
| getVersion | | public Version getVersion()(Code) | | The version of hte element that this reader reads. |
| hashCode | | public int hashCode()(Code) | | Implementation of hashcode.
|
| read | | abstract public Object read(Object request, Reader reader, Map kvp) throws Exception(Code) | | Reads the xml and initializes the request object.
The request parameter may be null, so in this case
the request reader would be responsible for creating the request object,
or throwing an exception if this is not supported.
In the case of the request being non null, the
request reader may chose to modify and return request, or create
a new request object and return it.
The kvp is used to support mixed style reading of the request
object from xml and from a set of key value pairs. This map is often empty.
|
|
|