gov.nasa.worldwind.ogc.ows

Class OWSCapabilities

java.lang.Object

gov.nasa.worldwind.util.xml.AbstractXMLEventParser

gov.nasa.worldwind.ogc.ows.OWSCapabilities

All Implemented Interfaces:

XMLEventParser

Direct Known Subclasses:

WCSCapabilities

public abstract class OWSCapabilities
extends AbstractXMLEventParser

Parses OGC Capabilities documents and holds the parsed information.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.xml.stream.XMLEventReader	eventReader
protected java.lang.String	owsNamespaceURI
protected XMLEventParserContext	parserContext

Fields inherited from class gov.nasa.worldwind.util.xml.AbstractXMLEventParser

CHARACTERS_CONTENT, fields, namespaceURI, parent

Constructor Summary

Constructors

Constructor and Description
OWSCapabilities(java.lang.String namespaceURI, java.lang.Object docSource) Create a new capabilities parser.

Method Summary

Modifier and Type	Method and Description
protected XMLEventParserContext	createParserContext(javax.xml.stream.XMLEventReader reader)
protected javax.xml.stream.XMLEventReader	createReader(java.lang.Object docSource)
protected abstract void	determineNamespaces()
OWSOperationsMetadata	getOperationsMetadata()
java.lang.String	getOWSNamespaceURI()
XMLEventParserContext	getParserContext()
OWSServiceIdentification	getServiceIdentification()
OWSServiceProvider	getServiceProvider()
java.lang.String	getUpdateSequence() Returns the document's update sequence.
java.lang.String	getVersion() Returns the document's version number.
protected void	initialize()
OWSCapabilities	parse(java.lang.Object... args) Starts document parsing.
protected void	registerParsers(XMLEventParserContext ctx)
protected void	setOWSNamespaceURI(java.lang.String ns)

Methods inherited from class gov.nasa.worldwind.util.xml.AbstractXMLEventParser

allocate, doAddCharacters, doAddEventAttribute, doAddEventContent, doParseEventAttributes, doParseEventContent, freeResources, getAConstructor, getCharacters, getField, getField, getFields, getNamespaceURI, getParent, getRoot, hasField, hasField, hasFields, mergeFields, newInstance, overrideFields, parse, parseCharacterContent, removeField, setField, setField, setFields, setNamespaceURI, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

eventReader

protected javax.xml.stream.XMLEventReader eventReader

owsNamespaceURI

protected java.lang.String owsNamespaceURI

parserContext

protected XMLEventParserContext parserContext

Constructor Detail

OWSCapabilities

public OWSCapabilities(java.lang.String namespaceURI,
                       java.lang.Object docSource)

Create a new capabilities parser.

Parameters:

namespaceURI - the default namespace URI.

docSource - the XML source. May be a filename, file, stream or other type allowed by WWXML.openEventReader(Object).

Throws:

java.lang.IllegalArgumentException - if the document source is null.

Method Detail

createParserContext

protected XMLEventParserContext createParserContext(javax.xml.stream.XMLEventReader reader)

createReader

protected javax.xml.stream.XMLEventReader createReader(java.lang.Object docSource)

determineNamespaces

protected abstract void determineNamespaces()

getOperationsMetadata

public OWSOperationsMetadata getOperationsMetadata()

getOWSNamespaceURI

public java.lang.String getOWSNamespaceURI()

getParserContext

public XMLEventParserContext getParserContext()

getServiceIdentification

public OWSServiceIdentification getServiceIdentification()

getServiceProvider

public OWSServiceProvider getServiceProvider()

getUpdateSequence

public java.lang.String getUpdateSequence()

Returns the document's update sequence.

Returns:

the document's update sequence.

getVersion

public java.lang.String getVersion()

Returns the document's version number.

Returns:

the document's version number.

initialize

protected void initialize()

parse

public OWSCapabilities parse(java.lang.Object... args)
                      throws javax.xml.stream.XMLStreamException

Starts document parsing. This method initiates parsing of the XML document and returns when the full capabilities document has been parsed.

Parameters:

args - optional arguments to pass to parsers of sub-elements.

Returns:

this if parsing is successful, otherwise null.

Throws:

javax.xml.stream.XMLStreamException - if an exception occurs while attempting to read the event stream.

registerParsers

protected void registerParsers(XMLEventParserContext ctx)

setOWSNamespaceURI

protected void setOWSNamespaceURI(java.lang.String ns)