Package gov.usgs.earthquake.shakemap
Class ShakeMap
java.lang.Object
gov.usgs.earthquake.product.Product
gov.usgs.earthquake.shakemap.ShakeMap
ShakeMap object to add additional Product properties based on contents.
This subclass of Product provides access to additional ShakeMap-specific
attributes and loads these attributes, as well as additional Product
attributes from ShakeMap source XML files.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringMap type - actualstatic final StringProperty for event descriptionstatic final StringProperty for event typestatic final StringReferences to file content in the Productstatic final StringReferences to file content in the Productstatic final StringInvisible attachmentstatic final StringProperty for map statusstatic final StringProperty for max latitudestatic final StringProperty for max longitudestatic final Stringkey in info.xml for maximum mmistatic final StringProperty for max MMIstatic final StringProperty for min latitudestatic final StringProperty for min longitudestatic final StringProperty for process timestampstatic final StringMap type - scenariostatic final StringA suffix added to all event codes for scenariosstatic final StringMap type - testFields inherited from class gov.usgs.earthquake.product.Product
DEPTH_PROPERTY, EVENTSOURCE_PROPERTY, EVENTSOURCECODE_PROPERTY, EVENTTIME_PROPERTY, LATITUDE_PROPERTY, LONGITUDE_PROPERTY, MAGNITUDE_PROPERTY, STATUS_DELETE, STATUS_UPDATE, VERSION_PROPERTY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected BigDecimalgetBigDecimal(String value) Returns String value as BigDecimalprotected StringgetString(BigDecimal value) Returns BigDecimal value as StringvoidsetEventDescription(String eventDescription) voidsetEventType(String eventType) voidsetGridXMLProperties(HashMap<String, String> gridXML) voidsetInfoXMLProperties(HashMap<String, String> infoXML) voidsetMapStatus(String mapStatus) voidsetMaximumLatitude(BigDecimal maximumLatitude) voidsetMaximumLongitude(BigDecimal maximumLongitude) voidsetMinimumLatitude(BigDecimal minimumLatitude) voidsetMinimumLongitude(BigDecimal minimumLongitude) voidsetProcessTimestamp(Date processTimestamp) booleanvalueIsEmpty(String productValue, String xmlValue) Methods inherited from class gov.usgs.earthquake.product.Product
addLink, addToSignatureHistory, getContents, getDepth, getEventId, getEventSource, getEventSourceCode, getEventTime, getId, getLatitude, getLinks, getLongitude, getMagnitude, getProperties, getSignature, getSignatureHistory, getSignatureVersion, getStatus, getVersion, isDeleted, setContents, setDepth, setEventId, setEventSource, setEventSourceCode, setEventTime, setId, setLatitude, setLinks, setLongitude, setMagnitude, setProperties, setSignature, setSignatureHistory, setSignatureVersion, setStatus, setVersion, sign, verifySignature, verifySignature, verifySignatureKey, verifySignatureKey
-
Field Details
-
EVENT_DESCRIPTION_PROPERTY
Property for event description- See Also:
-
EVENT_TYPE_PROPERTY
Property for event type- See Also:
-
MAP_STATUS_PROPERTY
Property for map status- See Also:
-
MAXIMUM_LATITUDE_PROPERTY
Property for max latitude- See Also:
-
MAXIMUM_LONGITUDE_PROPERTY
Property for max longitude- See Also:
-
MINIMUM_LATITUDE_PROPERTY
Property for min latitude- See Also:
-
MINIMUM_LONGITUDE_PROPERTY
Property for min longitude- See Also:
-
PROCESS_TIMESTAMP_PROPERTY
Property for process timestamp- See Also:
-
GRID_XML_ATTACHMENT
References to file content in the Product- See Also:
-
INFO_XML_ATTACHMENT
References to file content in the Product- See Also:
-
INVISIBLE_ATTACHMENT
Invisible attachment- See Also:
-
SCENARIO_ID_SUFFIX
A suffix added to all event codes for scenarios- See Also:
-
ACTUAL
Map type - actual- See Also:
-
SCENARIO
Map type - scenario- See Also:
-
TEST
Map type - test- See Also:
-
MAXIMUM_MMI_INFO_KEY
key in info.xml for maximum mmi- See Also:
-
MAXIMUM_MMI_PROPERTY
Property for max MMI- See Also:
-
-
Constructor Details
-
ShakeMap
- Parameters:
product- the base product to be converted to a ShakeMap product
-
-
Method Details
-
setGridXMLProperties
- Parameters:
gridXML- shakemap properties hash keyed by grid.xml attribute name
-
setInfoXMLProperties
- Parameters:
infoXML- shakemap properties hash keyed by info.xml attribute name
-
valueIsEmpty
- Parameters:
productValue- the value from the PDL objectxmlValue- the value from the XML document- Returns:
- if the shakemap property is already set
-
setMapStatus
- Parameters:
mapStatus- the map status to set
-
getMapStatus
- Returns:
- the status of this map
-
setEventType
- Parameters:
eventType- the event type to set
-
getEventType
- Returns:
- the event type of this product as defined in ShakeMap
-
setProcessTimestamp
- Parameters:
processTimestamp- the process timestamp to set
-
getProcessTimestamp
- Returns:
- the process timestamp of this ShakeMap
-
getEventDescription
- Returns:
- the event description text for this ShakeMap
-
setEventDescription
- Parameters:
eventDescription- the event description to set
-
getMinimumLongitude
- Returns:
- the minimum longitude boundary of this ShakeMap
-
setMinimumLongitude
- Parameters:
minimumLongitude- the minimum longitude to set
-
getMaximumLongitude
- Returns:
- the maximum longitude boundary of this ShakeMap
-
setMaximumLongitude
- Parameters:
maximumLongitude- the maximum longitude to set
-
getMinimumLatitude
- Returns:
- the minimum latitude boundary of this ShakeMap
-
setMinimumLatitude
- Parameters:
minimumLatitude- the minimum latitude to set
-
getMaximumLatitude
- Returns:
- the maximum latitude boundary of this ShakeMap
-
setMaximumLatitude
- Parameters:
maximumLatitude- the maximum latitude to set
-
getBigDecimal
Returns String value as BigDecimal- Parameters:
value- to return as BigDecimal- Returns:
- a BigDecimal
-
getString
Returns BigDecimal value as String- Parameters:
value- a BigDecimal- Returns:
- a string
-