Package gov.nasa.worldwind.util.xml

Interface XMLEventParser

All Known Implementing Classes:

AbstractXMLEventParser, AngleXMLEventParser, AtomAbstractObject, AtomLink, AtomPerson, AttributesOnlyXMLEventParser, BooleanIntegerXMLEventParser, BooleanXMLEventParser, ColladaAbstractGeometry, ColladaAbstractInstance, ColladaAbstractObject, ColladaAbstractParamContainer, ColladaAbstractShader, ColladaAccessor, ColladaAsset, ColladaBind, ColladaBindMaterial, ColladaBindVertexInput, ColladaColor, ColladaContributor, ColladaEffect, ColladaExtra, ColladaFloatArray, ColladaFloatOrParam, ColladaFormat, ColladaGeometry, ColladaImage, ColladaInput, ColladaInstanceEffect, ColladaInstanceGeometry, ColladaInstanceMaterial, ColladaInstanceNode, ColladaInstanceVisualScene, ColladaLambert, ColladaLibrary, ColladaLines, ColladaMaterial, ColladaMatrix, ColladaMesh, ColladaNewParam, ColladaNode, ColladaP, ColladaParam, ColladaPhong, ColladaProfileCommon, ColladaRoot, ColladaSampler2D, ColladaScene, ColladaSource, ColladaSurface, ColladaTechnique, ColladaTechniqueCommon, ColladaTexture, ColladaTextureOrColor, ColladaTriangles, ColladaUnit, ColladaUnsupported, ColladaVertices, ColladaVisualScene, DoubleXMLEventParser, GMLEnvelope, GMLEnvelopeWithTimePeriod, GMLGrid, GMLGridEnvelope, GMLLimits, GMLOrigin, GMLPos, GMLRectifiedGrid, GXAbstractTourPrimitive, GXAnimatedUpdate, GXFlyTo, GXLatLongQuad, GXPlaylist, GXSoundCue, GXTour, GXTourControl, GXWait, IntegerXMLEventParser, KMLAbstractColorStyle, KMLAbstractContainer, KMLAbstractEventParser, KMLAbstractFeature, KMLAbstractGeometry, KMLAbstractLatLonBoxType, KMLAbstractObject, KMLAbstractOverlay, KMLAbstractStyleSelector, KMLAbstractSubStyle, KMLAbstractTimePrimitive, KMLAbstractView, KMLAlias, KMLBalloonStyle, KMLBoundary, KMLCamera, KMLChange, KMLCoordinatesParser, KMLCreate, KMLData, KMLDelete, KMLDocument, KMLExtendedData, KMLFolder, KMLGroundOverlay, KMLIcon, KMLIconStyle, KMLImagePyramid, KMLItemIcon, KMLLabelStyle, KMLLatLonAltBox, KMLLatLonBox, KMLLinearRing, KMLLineString, KMLLineStyle, KMLLink, KMLListStyle, KMLLocation, KMLLod, KMLLookAt, KMLModel, KMLMultiGeometry, KMLNetworkLink, KMLNetworkLinkControl, KMLOrientation, KMLPair, KMLPhotoOverlay, KMLPlacemark, KMLPoint, KMLPolygon, KMLPolyStyle, KMLRegion, KMLResourceMap, KMLRoot, KMLScale, KMLSchema, KMLSchemaData, KMLScreenOverlay, KMLSimpleData, KMLSimpleField, KMLSnippet, KMLStyle, KMLStyleMap, KMLStyleUrl, KMLTimeSpan, KMLTimeStamp, KMLUpdate, KMLVec2, KMLViewVolume, OGCAddress, OGCBoundingBox, OGCCapabilities, OGCCapabilityInformation, OGCContactInformation, OGCDCType, OGCOnlineResource, OGCRequestDescription, OGCServiceInformation, OWSAddress, OWSAllowedValues, OWSCapabilities, OWSConstraint, OWSContactInfo, OWSDCP, OWSHTTP, OWSOperation, OWSOperationsMetadata, OWSParameter, OWSPhone, OWSServiceContact, OWSServiceIdentification, OWSServiceProvider, OWSWGS84BoundingBox, RasterServerConfiguration, RasterServerConfiguration.Corner, RasterServerConfiguration.Property, RasterServerConfiguration.RasterSector, RasterServerConfiguration.Source, RasterServerConfiguration.Sources, StringListXMLEventParser, StringSetXMLEventParser, StringXMLEventParser, UnrecognizedXMLEventParser, WCS100AxisDescription, WCS100AxisDescriptionHolder, WCS100Capabilities, WCS100Capability, WCS100ContentMetadata, WCS100CoverageOffering, WCS100CoverageOfferingBrief, WCS100DCPType, WCS100DescribeCoverage, WCS100DomainSet, WCS100Exception, WCS100HTTP, WCS100Interval, WCS100LonLatEnvelope, WCS100Max, WCS100MetadataLink, WCS100Min, WCS100RangeSet, WCS100RangeSetHolder, WCS100Request, WCS100RequestDescription, WCS100ResponsibleParty, WCS100Service, WCS100SingleValue, WCS100SpatialDomain, WCS100SupportedCRSs, WCS100SupportedFormats, WCS100SupportedInterpolations, WCS100Values, WCSCapabilities, WCSContents, WCSCoverageSummary, WMSAuthorityURL, WMSCapabilities, WMSCapabilityInformation, WMSLayerAttribution, WMSLayerCapabilities, WMSLayerDimension, WMSLayerExtent, WMSLayerIdentifier, WMSLayerInfoURL, WMSLayerStyle, WMSLogoURL, WMSServiceInformation, XALAbstractObject, XALAddress, XALAddressDetails, XALAddressLine, XALAddressLines, XALAdministrativeArea, XALCountry, XALCountryName, XALCountryNameCode, XALLocality, XALPostalServiceElements, XALThoroughfare

public interface XMLEventParser

Defines the interface for XML event parsers.

Method Summary

Modifier and Type	Method	Description
void	freeResources()	Release large resources used by the parser, but does not dispose of the parser itself.
XMLEventParser	getParent()	Returns this parser's parent parser.
XMLEventParser	newInstance()	Creates a new empty parser instance of the same type.
java.lang.Object	parse(XMLEventParserContext context, javax.xml.stream.events.XMLEvent event, java.lang.Object... args)	Parse the event and initialize the parser's values to those found in the event.
void	setParent(XMLEventParser parent)	Specifies the parent parser of this parser.

Method Detail

parse

java.lang.Object parse(XMLEventParserContext context,
                       javax.xml.stream.events.XMLEvent event,
                       java.lang.Object... args)
                throws javax.xml.stream.XMLStreamException

Parse the event and initialize the parser's values to those found in the event.

Parameters:

context - a current parser context.

event - the event to parse.

args - an optional list of arguments that may by used by subclasses.

Returns:

if parsing is successful, returns this, otherwise returns null.

Throws:

javax.xml.stream.XMLStreamException - if an exception occurs during event-stream reading.

newInstance

XMLEventParser newInstance()
                    throws java.lang.Exception

Creates a new empty parser instance of the same type. This is used by XMLEventParserContext when creating parsers associated with specific event types. The returned parser has the same namespace as the instance creating it, but has empty fields for all other values.

Returns:

a new parser instance. The namespace URI is the same as the creating parser, but all other fields are empty.

Throws:

java.lang.Exception - if an error or exception occurs while attempting to create the parser.

setParent

void setParent(XMLEventParser parent)

Specifies the parent parser of this parser.

Parameters:

parent - this parser's parent parser.

getParent

XMLEventParser getParent()

Returns this parser's parent parser.

Returns:

this parser's parent parser.

freeResources

void freeResources()

Release large resources used by the parser, but does not dispose of the parser itself. Call this method once its data is no longer needed, such as after mappings and related representations are created. For example, if a parser holds a large number of positions, and those positions are no longer needed after the positions are converted to points or copied to other storage, this method releases the memory associated with the original positions.