Package gov.usgs.earthquake.shakemap

Class GridXMLHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

gov.usgs.earthquake.shakemap.GridXMLHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class GridXMLHandler
extends DefaultHandler

Parser for ShakeMap grid.xml metadata. Accepts a ShakeMap object and updates the properties of that product based on the product's grid.xml file.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EVENT_DEPTH	Event depth
static final String	EVENT_DEPTH_XML	XML for EVENT_DEPTH
static final String	EVENT_DESCRIPTION	Event description
static final String	EVENT_DESCRIPTION_XML	XML for EVENT_DESCRIPTION
static final String	EVENT_ELEMENT	Element for event
static final String	EVENT_ELEMENT_XML	XML for EVENT_ELEMENT
static final String	EVENT_ID	GSM Parameter when using a different network as a backup
static final String	EVENT_ID_XML	XML for EVENT_ID
static final String	EVENT_LATITUDE	Event latitude
static final String	EVENT_LATITUDE_XML	XML for EVENT_LATITUDE
static final String	EVENT_LONGITUDE	Event longitude
static final String	EVENT_LONGITUDE_XML	XML for EVENT_LONGITUDE
static final String	EVENT_MAGNITUDE	Event magnitude
static final String	EVENT_MAGNITUDE_XML	XML for EVENT_MAGNITUDE
static final String	EVENT_NETWORK	GSM Parameter when using a different network as a backup
static final String	EVENT_NETWORK_XML	XML for EVENT_NETWORK
static final String	EVENT_TIMESTAMP	Event timestamp
static final String	EVENT_TIMESTAMP_XML	XML for EVENT_TIMESTAMP
static final String	GRIDDATA_ELEMENT	Element for Shakemap griddata
static final String	GRIDSPEC_ELEMENT	Element for grid specification
static final String	GRIDSPEC_ELEMENT_XML	XML for GRIDSPEC_ELEMENT
static final String	GRIDSPEC_LATMAX	gridspec latitude max
static final String	GRIDSPEC_LATMAX_XML	XML for GRIDSPEC_LATMAX
static final String	GRIDSPEC_LATMIN	gridspec latitude min
static final String	GRIDSPEC_LATMIN_XML	XML for GRIDSPEC_LATMIN
static final String	GRIDSPEC_LONMAX	gridspec longitude max
static final String	GRIDSPEC_LONMAX_XML	XML for GRIDSPEC_LONMAX
static final String	GRIDSPEC_LONMIN	gridspec longitude min
static final String	GRIDSPEC_LONMIN_XML	XML for GRIDSPEC_LONMIN
static final String	SHAKEMAPGRID_ELEMENT	Element for shakemap grid
static final String	SHAKEMAPGRID_ELEMENT_XML	XML for SHAKEMAPGRID_ELEMENT
static final String	SHAKEMAPGRID_EVENT_STATUS	Shakemap grid event/map status
static final String	SHAKEMAPGRID_EVENT_STATUS_XML	XML for SHAKEMAPGRID_EVENT_STATUS
static final String	SHAKEMAPGRID_EVENT_TYPE	Shakemap grid event type
static final String	SHAKEMAPGRID_EVENT_TYPE_XML	XML for SHAKEMAPGRID_EVENT_TYPE
static final String	SHAKEMAPGRID_ID	Shakemap grid id
static final String	SHAKEMAPGRID_ID_XML	XML for SHAKEMAPGRID_ID
static final String	SHAKEMAPGRID_ORIGINATOR	Shakemap grid originator
static final String	SHAKEMAPGRID_ORIGINATOR_XML	XML for SHAKEMAPGRID_ORIGINATOR
static final String	SHAKEMAPGRID_TIMESTAMP	Shakemap grid process timestamp
static final String	SHAKEMAPGRID_TIMESTAMP_XML	XML for SHAKEMAPGRID_TIMESTAMP
static final String	SHAKEMAPGRID_VERSION	Shakemap grid version
static final String	SHAKEMAPGRID_VERSION_XML	XML for SHAKEMAPGRID_VERSION
static final String	STOP_PARSING_BEFORE_GRIDDATA	Shakemap griddata parameter to stop parsing before

Constructor Summary

Constructors

Constructor	Description
GridXMLHandler()	Construct a new SAX Handler for an grid.xml document.

Method Summary

Modifier and Type	Method	Description
HashMap<String,String>	getInfo()
HashMap<String,String>	parse(Object in)
final void	startElement(String uri, String localName, String qName, Attributes attributes)	Read grid, event, and gridspec element attributes.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

characters, endDocument, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Field Details

SHAKEMAPGRID_ELEMENT

public static final String SHAKEMAPGRID_ELEMENT

Element for shakemap grid

See Also:

• Constant Field Values

SHAKEMAPGRID_ID

public static final String SHAKEMAPGRID_ID

Shakemap grid id

See Also:

• Constant Field Values

SHAKEMAPGRID_ORIGINATOR

public static final String SHAKEMAPGRID_ORIGINATOR

Shakemap grid originator

See Also:

• Constant Field Values

SHAKEMAPGRID_TIMESTAMP

public static final String SHAKEMAPGRID_TIMESTAMP

Shakemap grid process timestamp

See Also:

• Constant Field Values

SHAKEMAPGRID_VERSION

public static final String SHAKEMAPGRID_VERSION

Shakemap grid version

See Also:

• Constant Field Values

SHAKEMAPGRID_EVENT_TYPE

public static final String SHAKEMAPGRID_EVENT_TYPE

Shakemap grid event type

See Also:

• Constant Field Values

SHAKEMAPGRID_EVENT_STATUS

public static final String SHAKEMAPGRID_EVENT_STATUS

Shakemap grid event/map status

See Also:

• Constant Field Values

EVENT_ELEMENT

public static final String EVENT_ELEMENT

Element for event

See Also:

• Constant Field Values

EVENT_LATITUDE

public static final String EVENT_LATITUDE

Event latitude

See Also:

• Constant Field Values

EVENT_LONGITUDE

public static final String EVENT_LONGITUDE

Event longitude

See Also:

• Constant Field Values

EVENT_MAGNITUDE

public static final String EVENT_MAGNITUDE

Event magnitude

See Also:

• Constant Field Values

EVENT_TIMESTAMP

public static final String EVENT_TIMESTAMP

Event timestamp

See Also:

• Constant Field Values

EVENT_DESCRIPTION

public static final String EVENT_DESCRIPTION

Event description

See Also:

• Constant Field Values

EVENT_DEPTH

public static final String EVENT_DEPTH

Event depth

See Also:

• Constant Field Values

EVENT_NETWORK

public static final String EVENT_NETWORK

GSM Parameter when using a different network as a backup

See Also:

• Constant Field Values

EVENT_ID

public static final String EVENT_ID

GSM Parameter when using a different network as a backup

See Also:

• Constant Field Values

GRIDSPEC_ELEMENT

public static final String GRIDSPEC_ELEMENT

Element for grid specification

See Also:

• Constant Field Values

GRIDSPEC_LONMIN

public static final String GRIDSPEC_LONMIN

gridspec longitude min

See Also:

• Constant Field Values

GRIDSPEC_LONMAX

public static final String GRIDSPEC_LONMAX

gridspec longitude max

See Also:

• Constant Field Values

GRIDSPEC_LATMIN

public static final String GRIDSPEC_LATMIN

gridspec latitude min

See Also:

• Constant Field Values

GRIDSPEC_LATMAX

public static final String GRIDSPEC_LATMAX

gridspec latitude max

See Also:

• Constant Field Values

SHAKEMAPGRID_ELEMENT_XML

public static final String SHAKEMAPGRID_ELEMENT_XML

XML for SHAKEMAPGRID_ELEMENT

See Also:

• Constant Field Values

SHAKEMAPGRID_ID_XML

public static final String SHAKEMAPGRID_ID_XML

XML for SHAKEMAPGRID_ID

See Also:

• Constant Field Values

SHAKEMAPGRID_ORIGINATOR_XML

public static final String SHAKEMAPGRID_ORIGINATOR_XML

XML for SHAKEMAPGRID_ORIGINATOR

See Also:

• Constant Field Values

SHAKEMAPGRID_TIMESTAMP_XML

public static final String SHAKEMAPGRID_TIMESTAMP_XML

XML for SHAKEMAPGRID_TIMESTAMP

See Also:

• Constant Field Values

SHAKEMAPGRID_VERSION_XML

public static final String SHAKEMAPGRID_VERSION_XML

XML for SHAKEMAPGRID_VERSION

See Also:

• Constant Field Values

SHAKEMAPGRID_EVENT_TYPE_XML

public static final String SHAKEMAPGRID_EVENT_TYPE_XML

XML for SHAKEMAPGRID_EVENT_TYPE

See Also:

• Constant Field Values

SHAKEMAPGRID_EVENT_STATUS_XML

public static final String SHAKEMAPGRID_EVENT_STATUS_XML

XML for SHAKEMAPGRID_EVENT_STATUS

See Also:

• Constant Field Values

EVENT_ELEMENT_XML

public static final String EVENT_ELEMENT_XML

XML for EVENT_ELEMENT

See Also:

• Constant Field Values

EVENT_LATITUDE_XML

public static final String EVENT_LATITUDE_XML

XML for EVENT_LATITUDE

See Also:

• Constant Field Values

EVENT_LONGITUDE_XML

public static final String EVENT_LONGITUDE_XML

XML for EVENT_LONGITUDE

See Also:

• Constant Field Values

EVENT_MAGNITUDE_XML

public static final String EVENT_MAGNITUDE_XML

XML for EVENT_MAGNITUDE

See Also:

• Constant Field Values

EVENT_TIMESTAMP_XML

public static final String EVENT_TIMESTAMP_XML

XML for EVENT_TIMESTAMP

See Also:

• Constant Field Values

EVENT_DESCRIPTION_XML

public static final String EVENT_DESCRIPTION_XML

XML for EVENT_DESCRIPTION

See Also:

• Constant Field Values

EVENT_DEPTH_XML

public static final String EVENT_DEPTH_XML

XML for EVENT_DEPTH

See Also:

• Constant Field Values

EVENT_NETWORK_XML

public static final String EVENT_NETWORK_XML

XML for EVENT_NETWORK

See Also:

• Constant Field Values

EVENT_ID_XML

public static final String EVENT_ID_XML

XML for EVENT_ID

See Also:

• Constant Field Values

GRIDSPEC_ELEMENT_XML

public static final String GRIDSPEC_ELEMENT_XML

XML for GRIDSPEC_ELEMENT

See Also:

• Constant Field Values

GRIDSPEC_LONMIN_XML

public static final String GRIDSPEC_LONMIN_XML

XML for GRIDSPEC_LONMIN

See Also:

• Constant Field Values

GRIDSPEC_LONMAX_XML

public static final String GRIDSPEC_LONMAX_XML

XML for GRIDSPEC_LONMAX

See Also:

• Constant Field Values

GRIDSPEC_LATMIN_XML

public static final String GRIDSPEC_LATMIN_XML

XML for GRIDSPEC_LATMIN

See Also:

• Constant Field Values

GRIDSPEC_LATMAX_XML

public static final String GRIDSPEC_LATMAX_XML

XML for GRIDSPEC_LATMAX

See Also:

• Constant Field Values

GRIDDATA_ELEMENT

public static final String GRIDDATA_ELEMENT

Element for Shakemap griddata

See Also:

• Constant Field Values

STOP_PARSING_BEFORE_GRIDDATA

public static final String STOP_PARSING_BEFORE_GRIDDATA

Shakemap griddata parameter to stop parsing before

See Also:

• Constant Field Values

Constructor Details

GridXMLHandler

public GridXMLHandler()

Construct a new SAX Handler for an grid.xml document.

Method Details

parse

public HashMap<String,String> parse(Object in)
                             throws Exception

Parameters:

in - - the file or stream to parse

Returns:

the ShakeMap associated with this XML handler

Throws:

Exception - if error occurs

getInfo

public HashMap<String,String> getInfo()

Returns:

the parsed info.

startElement

public final void startElement(String uri,
 String localName,
 String qName,
 Attributes attributes)
                        throws SAXException

Read grid, event, and gridspec element attributes.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Parameters:

uri - namespace of element.

localName - name of element.

qName - qualified name of element.

attributes - element attributes.

Throws:

SAXException - when griddata element is reached, to stop parsing.