com.isti.quakewatch.message
Class QWStationAmpMsgRecord

java.lang.Object
  extended by com.isti.quakewatch.message.QWRecord
      extended by com.isti.quakewatch.message.QWMsgRecord
          extended by com.isti.quakewatch.message.QWDataMsgRecord
              extended by com.isti.quakewatch.message.QWStationAmpMsgRecord
All Implemented Interfaces:
QWEventMsgRecord, QWMsgNumTimeRec, Archivable, ExtendedComparable, java.lang.Comparable

public class QWStationAmpMsgRecord
extends QWDataMsgRecord
implements java.lang.Comparable, QWEventMsgRecord, ExtendedComparable

QWStationAmpMsgRecord defines a record of amplitude data. A selector is used to determine whether the acceleration or velocity amplitude is represented. In each case, the component with the largest amplitude value is used.


Nested Class Summary
static class QWStationAmpMsgRecord.AmplitudeRecord
          Class AmplitudeRecord contains a record of amplitude information.
 
Nested classes/interfaces inherited from interface com.isti.util.Archivable
Archivable.Marker
 
Field Summary
 QWStationAmpMsgRecord.AmplitudeRecord accAmplitudeRecObj
          Acceleration record object.
 java.lang.String accSCNLString
          "Station, channel, network, location" string for acceleration amp.
static int AMP_ACC_TYPE
          Selection value for "acceleration" (for 'selectAmplitudeType()').
static int AMP_DEFAULT_TYPE
          Default amplitude selection value ("velocity").
static int AMP_VEL_TYPE
          Selection value for "velocity" (for 'selectAmplitudeType()').
 java.lang.String commType
          Communications interface type, or null if none specified.
 java.lang.Double elev
          Station elevation, or null if none specified.
 java.lang.String instType
          Instrument type, or null if none specified.
protected  java.lang.String keyNscltValsString
          "Station, channel, network, location, time, acc, vel" string.
 double lat
          Latitude value for event.
 double lon
          Longitude value for event.
 java.lang.String net
          Network ID code for station.
static java.lang.String NO_VALUE_STR
          Text to display when there is no value.
protected  java.util.Date playbackTimeDateObj
          Playback time for amplitude record, or null for none.
protected  java.lang.Object playbackTimeSyncObj
          Thread-synchronization object for 'playbackTimeDateObj'.
protected  long selectedTimeVal
          Last time that message record was selected.
 java.lang.String source
          Description of data source, or null if none specified.
 java.lang.String sta
          Station ID code.
 org.jdom.Element stationAmpElement
          Handle to 'Element' object used to construct this object.
 java.lang.String stationName
          Verbose station name, or null if none specified.
protected  QWEventMsgRecord supersededRecordObj
          Handle to record that this record superseded, or null for none.
 java.util.Date time
          Date object specifying date/time for message.
 QWStationAmpMsgRecord.AmplitudeRecord velAmplitudeRecObj
          Velocity record object.
 java.lang.String velSCNLString
          "Station, channel, network, location" string for velocity amp.
 
Fields inherited from class com.isti.quakewatch.message.QWDataMsgRecord
action, alarmTriggeredFlag, dataMsgElement, displayObject, locationNote, relayTimeGen, requestedFlag, showMapSymbolFlag, timeReceived, updateFlag, utilityObject
 
Fields inherited from class com.isti.quakewatch.message.QWMsgRecord
archiveFormStr, msgNumber, origTimeGenerated, qwMsgElement, timeGenerated
 
Fields inherited from class com.isti.quakewatch.message.QWRecord
currentElement
 
Fields inherited from interface com.isti.quakewatch.message.QWEventMsgRecord
DATE_SORT_TYPE, DEF_SORT_TYPE, MAX_SORT_TYPE, PROD_SORT_TYPE, VALUE_SORT_TYPE
 
Fields inherited from interface com.isti.util.ExtendedComparable
NO_SORT_TYPE
 
Constructor Summary
QWStationAmpMsgRecord(org.jdom.Element qwMsgElement, org.jdom.Element dataMsgElement, org.jdom.Element stationAmpElement)
          Creates a data record for one event, built from an XML "Event" message element.
 
Method Summary
 int compareTo(java.lang.Object obj)
          Compares the given 'QWEventMsgRecord' object to this one.
 int compareTo(java.lang.Object obj, int sortType)
          Compares this object with the specified object and index for order.
 boolean containsShakeMapProduct()
          Returns a flag indicating whether or not this event contains a ShakeMap product.
 boolean containsTsunamiProduct()
          Returns a flag indicating whether or not this event contains a Tsunami product.
protected  QWStationAmpMsgRecord.AmplitudeRecord createAmplitudeRecordObj(java.lang.Double ampValueObj, org.jdom.Element compElemObj, org.jdom.Element ampElemObj)
          Creates an amplitude record based on the given parameters.
 boolean equals(java.lang.Object obj)
          Indicates whether some other object is "equal to" this one.
 boolean equals(QWEventMsgRecord obj)
          Indicates whether some other object is "equal to" this one.
 java.lang.String getAccAmpValueString()
          Returns a display string representation of the amplitude acceleration value.
static int getAmplitudeTypeValue()
          Returns the selection value set via the 'selectAmplitudeType()' method.
 double getAmpValue()
          Returns the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).
 java.lang.Double getAmpValueObj()
          Returns a 'Double' object containing the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).
 java.lang.String getAmpValueString()
          Returns a display string representation of the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).
 java.lang.String getCompLoc()
          Returns the component location for the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).
 java.lang.String getCompName()
          Returns the component name for the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).
 java.lang.String getDataSource()
          Returns the data source description string.
 java.lang.String getDateString()
          Returns a display string representation of the date (not including the time) associated with the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).
 java.lang.String getDateTimeString()
          Returns a display string representation of the date/time associated with the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).
 java.lang.Double getDepthObj()
          Returns the event depth value.
 java.lang.String getDepthString()
          Returns a display string representation of the depth.
 java.lang.String getDepthString(boolean milesFlag)
          Returns a display string representation of the depth.
 java.lang.String getDisplayString()
          Returns a display string representation of this object.
 java.lang.String getEventIDKey()
          Returns a string containing the network, station, channel, location and time codes for the record along with the acceleration and velocity amplitude values.
 double getLatitude()
          Returns the latitude.
 java.lang.String getLatitudeString()
          Returns a display string representation of the latitude.
 java.lang.String getLatitudeString(boolean nsFormatFlag)
          Returns a display string representation of the latitude.
 java.lang.String getLatitudeString(boolean nsFormatFlag, boolean degMinFlag)
          Returns a display string representation of the latitude.
 java.lang.String getLCEventIDKey()
          Returns a lower-cased string containing the network, station, channel, location and time codes for the record along with the acceleration and velocity amplitude values.
 double getLongitude()
          Returns the longitude.
 java.lang.String getLongitudeString()
          Returns a display string representation of the longitude.
 java.lang.String getLongitudeString(boolean ewFormatFlag)
          Returns a display string representation of the longitude.
 java.lang.String getLongitudeString(boolean ewFormatFlag, boolean degMinFlag)
          Returns a display string representation of the longitude.
 double getMagnitude()
          Returns the event magnitude.
 java.lang.Double getMagnitudeObj()
          Returns a 'Double' object containing the event magnitude.
 java.lang.String getMagnitudeType()
          Returns a string representing the type code for the primary magnitude.
 java.lang.String getMagnitudeValueString()
          Returns a display string representation of the magnitude.
 java.util.Date getMessageTime()
          Returns the time value for the "StationAmp" message.
 org.jdom.Element getMsgRecChildElement()
          Returns the child "StationAmp" element used to build this message record.
 java.lang.String getNetID()
          Returns the network ID.
 java.util.Date getPlaybackTimeDateObj()
          Returns the "playback time" for this amplitude record.
 int getProductCount()
          Returns the number of products associated with this record.
 QWProductMsgRecord getProductMsgRecord(java.lang.String typeStr)
          Returns a 'QWProductMsgRecord' object for this record.
 FifoHashtable getProductRecTable()
          Returns the table of 'QWProductMsgRecord' objects for products associated with this record.
 java.lang.String getSCNLString()
          Returns a string containing the station, channel, network, and location codes for the record.
 long getSelectedTimeVal()
          Returns the time that this message record was last selected.
 java.lang.String getShakeMapInfo()
          Returns the ShakeMap information.
 QWEventMsgRecord getSupersededRecordObj()
          Returns the handle to the record that this record superseded.
 java.util.Date getTime()
          Returns the time value associated with the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).
 java.lang.String getTimeString()
          Returns a display string representation of the time (not including the date) associated with the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).
 java.lang.String getToolTipString()
          Returns a string representation of this record to be used for its tooltip text.
 int getValueSortRankSpecifier()
          Returns the value-sort rank specifier.
 java.lang.String getVelAmpValueString()
          Returns a display string representation of the velocity acceleration value.
 java.lang.String getVersion()
          Returns the version code string.
 boolean isQuarry()
          Returns true if the "quarry" flag is set.
 boolean isVerified()
          Returns true if the message is verified.
static void selectAmplitudeType(int selVal)
          Selects which type of amplitude values ("acceleration" or "velocity") will be returned by "getAmp...()" and several other methods.
 void setPlaybackTimeDateObj(java.util.Date dateObj)
          Sets the "playback time" for this amplitude record.
 void setSelectedTimeVal(long timeVal)
          Sets the time that this message record was last selected.
 void setSupersededRecordObj(QWEventMsgRecord recObj)
          Sets the handle to the record that this record superseded.
static void setValueSortRankSpecifier(int specVal)
          Sets the value-sort rank specifier.
 boolean timeEquals(java.lang.Object obj)
          Returns true if the given object is a 'QWEventMsgRecord' object whose message date/time equals the one for this record; otherwise returns false.
 boolean timeEquals(QWEventMsgRecord obj)
          Returns true if the given object is a 'QWEventMsgRecord' object whose message date/time equals the one for this record; otherwise returns false.
 java.lang.String toString()
          Returns a string representation of this record.
static void updateDateTimeZones(java.util.TimeZone zone)
          Updates time zone used for date/time values for all event-message-record objects.
 
Methods inherited from class com.isti.quakewatch.message.QWDataMsgRecord
equals, getAlarmTriggeredFlag, getDisplayObject, getIdentifierElement, getLocationNote, getRequestedFlag, getShowMapSymbolFlag, getUpdateFlag, getUtilityObject, setAlarmTriggeredFlag, setDisplayObject, setLocationNote, setRequestedFlag, setShowMapSymbolFlag, setUpdateFlag, setUtilityObject
 
Methods inherited from class com.isti.quakewatch.message.QWMsgRecord
checkQWMsgRecordName, elemToStr, equals, getArchiveDate, getMsgNum, getServerAddress, getServerIDName, getServerRevStr, getTimeGenerated, toArchivedForm
 
Methods inherited from class com.isti.quakewatch.message.QWRecord
getAttribDouble, getAttribInteger, getAttribLong, getAttribStr, getAttribTime, getChildElementDouble, getChildElementDouble, getChildElementInteger, getChildElementInteger, getChildElementStr, getChildElementStr, getCurrentElement, getDefAttribBoolean, getDefElementBoolean, getElementDouble, getElementInteger, getElementLong, getElementStr, getElementTime, getElementValueDouble, getElementValueStr, getElementValueTime, getNonNullOptAttribStr, getNonNullOptElementStr, getOptAttribBoolean, getOptAttribDouble, getOptAttribInteger, getOptAttribStr, getOptAttribTime, getOptElementBoolean, getOptElementDouble, getOptElementInteger, getOptElementStr, getOptElementTime, getOptElementValueDouble, getOptTextDouble, parseDataBoolean, parseDataDouble, parseDataInteger, parseDataLong, parseDataTime
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.isti.quakewatch.message.QWEventMsgRecord
getAlarmTriggeredFlag, getDisplayObject, getLocationNote, getRequestedFlag, getShowMapSymbolFlag, getUpdateFlag, getUtilityObject, setAlarmTriggeredFlag, setDisplayObject, setLocationNote, setRequestedFlag, setShowMapSymbolFlag, setUpdateFlag, setUtilityObject
 
Methods inherited from interface com.isti.quakewatch.message.QWMsgNumTimeRec
getMsgNum, getTimeGenerated
 

Field Detail

AMP_ACC_TYPE

public static final int AMP_ACC_TYPE
Selection value for "acceleration" (for 'selectAmplitudeType()').

See Also:
Constant Field Values

AMP_VEL_TYPE

public static final int AMP_VEL_TYPE
Selection value for "velocity" (for 'selectAmplitudeType()').

See Also:
Constant Field Values

AMP_DEFAULT_TYPE

public static final int AMP_DEFAULT_TYPE
Default amplitude selection value ("velocity").

See Also:
Constant Field Values

stationAmpElement

public final org.jdom.Element stationAmpElement
Handle to 'Element' object used to construct this object.


sta

public final java.lang.String sta
Station ID code.


net

public final java.lang.String net
Network ID code for station.


lat

public final double lat
Latitude value for event.


lon

public final double lon
Longitude value for event.


time

public final java.util.Date time
Date object specifying date/time for message.


stationName

public final java.lang.String stationName
Verbose station name, or null if none specified.


elev

public final java.lang.Double elev
Station elevation, or null if none specified.


instType

public final java.lang.String instType
Instrument type, or null if none specified.


source

public final java.lang.String source
Description of data source, or null if none specified.


commType

public final java.lang.String commType
Communications interface type, or null if none specified.


accAmplitudeRecObj

public final QWStationAmpMsgRecord.AmplitudeRecord accAmplitudeRecObj
Acceleration record object.


velAmplitudeRecObj

public final QWStationAmpMsgRecord.AmplitudeRecord velAmplitudeRecObj
Velocity record object.


accSCNLString

public final java.lang.String accSCNLString
"Station, channel, network, location" string for acceleration amp.


velSCNLString

public final java.lang.String velSCNLString
"Station, channel, network, location" string for velocity amp.


keyNscltValsString

protected final java.lang.String keyNscltValsString
"Station, channel, network, location, time, acc, vel" string.


supersededRecordObj

protected QWEventMsgRecord supersededRecordObj
Handle to record that this record superseded, or null for none.


selectedTimeVal

protected long selectedTimeVal
Last time that message record was selected.


playbackTimeDateObj

protected java.util.Date playbackTimeDateObj
Playback time for amplitude record, or null for none.


playbackTimeSyncObj

protected final java.lang.Object playbackTimeSyncObj
Thread-synchronization object for 'playbackTimeDateObj'.


NO_VALUE_STR

public static final java.lang.String NO_VALUE_STR
Text to display when there is no value.

See Also:
Constant Field Values
Constructor Detail

QWStationAmpMsgRecord

public QWStationAmpMsgRecord(org.jdom.Element qwMsgElement,
                             org.jdom.Element dataMsgElement,
                             org.jdom.Element stationAmpElement)
                      throws QWRecordException
Creates a data record for one event, built from an XML "Event" message element.

Parameters:
qwMsgElement - the XML "QWmessage" element object.
dataMsgElement - the XML "DataMessage" element object.
stationAmpElement - the XML "StationAmp" message element.
Throws:
QWRecordException - if an error occurs while creating the data record.
Method Detail

createAmplitudeRecordObj

protected final QWStationAmpMsgRecord.AmplitudeRecord createAmplitudeRecordObj(java.lang.Double ampValueObj,
                                                                               org.jdom.Element compElemObj,
                                                                               org.jdom.Element ampElemObj)
Creates an amplitude record based on the given parameters.

Parameters:
ampValueObj - amplitude value.
compElemObj - component Element for amplitude.
ampElemObj - amplitude Element for amplitude.
Returns:
A new 'AmplitudeRecord' object.

selectAmplitudeType

public static void selectAmplitudeType(int selVal)
Selects which type of amplitude values ("acceleration" or "velocity") will be returned by "getAmp...()" and several other methods. This static method affects all 'QWStationAmpMsgRecord' instances. If this method is not called then the default "acceleration" will be used.

Parameters:
selVal - the selector value 'AMP_ACC_TYPE' or 'AMP_VEL_TYPE'.

getAmplitudeTypeValue

public static int getAmplitudeTypeValue()
Returns the selection value set via the 'selectAmplitudeType()' method.


setValueSortRankSpecifier

public static void setValueSortRankSpecifier(int specVal)
Sets the value-sort rank specifier. This is used by the 'compareTo(obj,int)' method to determine the result when two different types of objects that implement 'QWEventMsgRecord' are compared (using 'VALUE_SORT_TYPE').

Parameters:
specVal - numeric specifier to use.

getValueSortRankSpecifier

public int getValueSortRankSpecifier()
Returns the value-sort rank specifier. This is used by the 'compareTo(obj,int)' method to determine the result when two different types of objects that implement 'QWEventMsgRecord' are compared (using 'VALUE_SORT_TYPE').

Specified by:
getValueSortRankSpecifier in interface QWEventMsgRecord
Returns:
The numeric value-sort rank specifier.

getMsgRecChildElement

public org.jdom.Element getMsgRecChildElement()
Returns the child "StationAmp" element used to build this message record.

Specified by:
getMsgRecChildElement in interface QWEventMsgRecord
Returns:
The child "StationAmp" element used to build this message record.

getAmpValue

public double getAmpValue()
Returns the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).

Returns:
The acceleration or velocity amplitude value, or 0.0 if not available.

getAmpValueObj

public java.lang.Double getAmpValueObj()
Returns a 'Double' object containing the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).

Returns:
A 'Double' object containing the acceleration or velocity amplitude value, or 'null' if not available.

getAmpValueString

public java.lang.String getAmpValueString()
Returns a display string representation of the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).

Returns:
A display string representation of the acceleration or velocity amplitude value, or "??" if not available.

getCompName

public java.lang.String getCompName()
Returns the component name for the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method). The component with the maximum value is used.

Returns:
The component name for the acceleration or velocity amplitude value, or 'null' if none is available.

getCompLoc

public java.lang.String getCompLoc()
Returns the component location for the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method). The component with the maximum value is used.

Returns:
The component location for the acceleration or velocity amplitude value, or 'null' if none is available.

equals

public boolean equals(QWEventMsgRecord obj)
Indicates whether some other object is "equal to" this one.

Specified by:
equals in interface QWEventMsgRecord
Parameters:
obj - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.

equals

public boolean equals(java.lang.Object obj)
Indicates whether some other object is "equal to" this one.

Specified by:
equals in interface QWEventMsgRecord
Overrides:
equals in class QWDataMsgRecord
Parameters:
obj - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.

timeEquals

public boolean timeEquals(QWEventMsgRecord obj)
Returns true if the given object is a 'QWEventMsgRecord' object whose message date/time equals the one for this record; otherwise returns false. The time values used are associated with the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).

Specified by:
timeEquals in interface QWEventMsgRecord
Parameters:
obj - the 'QWEventMsgRecord' object to use.
Returns:
true if the message date/times are equal.

timeEquals

public boolean timeEquals(java.lang.Object obj)
Returns true if the given object is a 'QWEventMsgRecord' object whose message date/time equals the one for this record; otherwise returns false. The time values used are associated with the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).

Specified by:
timeEquals in interface QWEventMsgRecord
Parameters:
obj - the 'QWEventMsgRecord' object to use.
Returns:
true if the message date/times are equal.

compareTo

public int compareTo(java.lang.Object obj,
                     int sortType)
              throws java.lang.ClassCastException
Compares this object with the specified object and index for order. This method implements the ExtendedComparable interface.

Specified by:
compareTo in interface ExtendedComparable
Parameters:
obj - the Object to be compared.
sortType - the sort type.
Returns:
a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
Throws:
java.lang.ClassCastException - if the specified object's type prevents it from being compared to this Object.

compareTo

public int compareTo(java.lang.Object obj)
              throws java.lang.ClassCastException
Compares the given 'QWEventMsgRecord' object to this one. The event date/time is used as the sorting key. The time values used are associated with the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).

Specified by:
compareTo in interface QWEventMsgRecord
Specified by:
compareTo in interface java.lang.Comparable
Parameters:
obj - the 'QWEventMsgRecord' object to use.
Returns:
A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
Throws:
java.lang.ClassCastException - if the specified object's type prevents it from being compared to this Object.

toString

public java.lang.String toString()
Returns a string representation of this record. The acceleration or velocity amplitude is used (determined via the 'selectAmplitudeType()' method).

Specified by:
toString in interface QWEventMsgRecord
Overrides:
toString in class java.lang.Object
Returns:
A string representation of date, time and amplitude for this record, with 2-space separators surrounding each item.

getToolTipString

public java.lang.String getToolTipString()
Returns a string representation of this record to be used for its tooltip text.

Specified by:
getToolTipString in interface QWEventMsgRecord
Returns:
A string representation of the SCNL, date, time and amplitude for this record.

getDisplayString

public java.lang.String getDisplayString()
Returns a display string representation of this object.

Specified by:
getDisplayString in interface QWEventMsgRecord
Returns:
A new String object.

getSCNLString

public java.lang.String getSCNLString()
Returns a string containing the station, channel, network, and location codes for the record.

Returns:
A String in the form: "sta,cha,net,loc".

getEventIDKey

public java.lang.String getEventIDKey()
Returns a string containing the network, station, channel, location and time codes for the record along with the acceleration and velocity amplitude values. This string may be used as a unique "key" for the amplitude record.

Specified by:
getEventIDKey in interface QWEventMsgRecord
Returns:
A String in the form: sta,cha,net,loc,time,acc,vel.

getLCEventIDKey

public java.lang.String getLCEventIDKey()
Returns a lower-cased string containing the network, station, channel, location and time codes for the record along with the acceleration and velocity amplitude values. This string may be used as a unique "key" for the amplitude record.

Specified by:
getLCEventIDKey in interface QWEventMsgRecord
Returns:
A String in the form: sta,cha,net,loc,time,acc,vel.

getDataSource

public java.lang.String getDataSource()
Returns the data source description string.

Specified by:
getDataSource in interface QWEventMsgRecord
Returns:
The data source description string.

getNetID

public java.lang.String getNetID()
Returns the network ID.

Specified by:
getNetID in interface QWEventMsgRecord
Returns:
the network ID.

getDateString

public java.lang.String getDateString()
Returns a display string representation of the date (not including the time) associated with the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).

Specified by:
getDateString in interface QWEventMsgRecord
Returns:
A display string representation of the date (not including the time) associated with the acceleration or velocity amplitude value.

getDateTimeString

public java.lang.String getDateTimeString()
Returns a display string representation of the date/time associated with the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).

Specified by:
getDateTimeString in interface QWEventMsgRecord
Returns:
A display string representation of the date/time associated with the acceleration or velocity amplitude value.

getTimeString

public java.lang.String getTimeString()
Returns a display string representation of the time (not including the date) associated with the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).

Specified by:
getTimeString in interface QWEventMsgRecord
Returns:
A display string representation of the time (not including the date) associated with the acceleration or velocity amplitude value.

getTime

public java.util.Date getTime()
Returns the time value associated with the acceleration or velocity amplitude value (determined via the 'selectAmplitudeType()' method).

Specified by:
getTime in interface QWEventMsgRecord
Returns:
A 'Date' object containing the time value associated with the acceleration or velocity amplitude value.

getMessageTime

public java.util.Date getMessageTime()
Returns the time value for the "StationAmp" message.

Returns:
A 'Date' object containing the time value for the "StationAmp" message.

getLatitude

public double getLatitude()
Returns the latitude.

Specified by:
getLatitude in interface QWEventMsgRecord
Returns:
the latitude.

getLongitude

public double getLongitude()
Returns the longitude.

Specified by:
getLongitude in interface QWEventMsgRecord
Returns:
the longitude.

getLatitudeString

public java.lang.String getLatitudeString(boolean nsFormatFlag,
                                          boolean degMinFlag)
Returns a display string representation of the latitude.

Specified by:
getLatitudeString in interface QWEventMsgRecord
Parameters:
nsFormatFlag - true for N/S format; false for +/- format.
degMinFlag - true for degrees/minutes format; false for decimal format.
Returns:
A display string.

getLatitudeString

public java.lang.String getLatitudeString(boolean nsFormatFlag)
Returns a display string representation of the latitude. The decimal format is used.

Specified by:
getLatitudeString in interface QWEventMsgRecord
Parameters:
nsFormatFlag - true for N/S format; false for +/- format.
Returns:
A display string.

getLatitudeString

public java.lang.String getLatitudeString()
Returns a display string representation of the latitude. The decimal +/- format is used.

Specified by:
getLatitudeString in interface QWEventMsgRecord
Returns:
A display string.

getLongitudeString

public java.lang.String getLongitudeString(boolean ewFormatFlag,
                                           boolean degMinFlag)
Returns a display string representation of the longitude.

Specified by:
getLongitudeString in interface QWEventMsgRecord
Parameters:
ewFormatFlag - true for E/W format; false for +/- format.
degMinFlag - true for degrees/minutes format; false for decimal format.
Returns:
A display string.

getLongitudeString

public java.lang.String getLongitudeString(boolean ewFormatFlag)
Returns a display string representation of the longitude. The decimal format is used.

Specified by:
getLongitudeString in interface QWEventMsgRecord
Parameters:
ewFormatFlag - true for E/W format; false for +/- format.
Returns:
A display string.

getLongitudeString

public java.lang.String getLongitudeString()
Returns a display string representation of the longitude. The decimal +/- format is used.

Specified by:
getLongitudeString in interface QWEventMsgRecord
Returns:
A display string.

getAccAmpValueString

public java.lang.String getAccAmpValueString()
Returns a display string representation of the amplitude acceleration value.

Returns:
A display string representation of the amplitude acceleration value, or "??" if not available.

getVelAmpValueString

public java.lang.String getVelAmpValueString()
Returns a display string representation of the velocity acceleration value.

Returns:
A display string representation of the amplitude velocity value, or "??" if not available.

setSupersededRecordObj

public void setSupersededRecordObj(QWEventMsgRecord recObj)
Sets the handle to the record that this record superseded.

Specified by:
setSupersededRecordObj in interface QWEventMsgRecord
Parameters:
recObj - handle to record that this record superseded, or null for none.

getSupersededRecordObj

public QWEventMsgRecord getSupersededRecordObj()
Returns the handle to the record that this record superseded.

Specified by:
getSupersededRecordObj in interface QWEventMsgRecord
Returns:
The handle to the record that this record superseded, or null for none.

setSelectedTimeVal

public void setSelectedTimeVal(long timeVal)
Sets the time that this message record was last selected.

Specified by:
setSelectedTimeVal in interface QWEventMsgRecord
Parameters:
timeVal - time value, in milliseconds since 1/1/1970.

getSelectedTimeVal

public long getSelectedTimeVal()
Returns the time that this message record was last selected.

Specified by:
getSelectedTimeVal in interface QWEventMsgRecord
Returns:
The time that this message record was last selected (in milliseconds since 1/1/1970), or 0 if this record was never selected or if this method is not implemented.

setPlaybackTimeDateObj

public void setPlaybackTimeDateObj(java.util.Date dateObj)
Sets the "playback time" for this amplitude record.

Parameters:
dateObj - time/date object to use.

getPlaybackTimeDateObj

public java.util.Date getPlaybackTimeDateObj()
Returns the "playback time" for this amplitude record.

Returns:
The "playback time" for this amplitude record.

getVersion

public java.lang.String getVersion()
Returns the version code string. For 'QWStationAmpMsgRecord' the value 'null' is always returned.

Specified by:
getVersion in interface QWEventMsgRecord
Returns:
null.

getProductMsgRecord

public QWProductMsgRecord getProductMsgRecord(java.lang.String typeStr)
Returns a 'QWProductMsgRecord' object for this record. For 'QWStationAmpMsgRecord' the value 'null' is always returned.

Specified by:
getProductMsgRecord in interface QWEventMsgRecord
Parameters:
typeStr - the 'type' value of the 'QWProductMsgRecord' object to be returned.
Returns:
null.

getProductRecTable

public FifoHashtable getProductRecTable()
Returns the table of 'QWProductMsgRecord' objects for products associated with this record. For 'QWStationAmpMsgRecord' the value 'null' is always returned.

Specified by:
getProductRecTable in interface QWEventMsgRecord
Returns:
null.

getProductCount

public int getProductCount()
Returns the number of products associated with this record. For 'QWStationAmpMsgRecord' the value 0 is always returned.

Specified by:
getProductCount in interface QWEventMsgRecord
Returns:
0.

getShakeMapInfo

public java.lang.String getShakeMapInfo()
Returns the ShakeMap information. For 'QWStationAmpMsgRecord' the value 'null' is always returned.

Specified by:
getShakeMapInfo in interface QWEventMsgRecord
Returns:
null.

containsShakeMapProduct

public boolean containsShakeMapProduct()
Returns a flag indicating whether or not this event contains a ShakeMap product. For 'QWStationAmpMsgRecord' the value 'false' is always returned.

Specified by:
containsShakeMapProduct in interface QWEventMsgRecord
Returns:
false.

containsTsunamiProduct

public boolean containsTsunamiProduct()
Returns a flag indicating whether or not this event contains a Tsunami product. For 'QWStationAmpMsgRecord' the value 'false' is always returned.

Specified by:
containsTsunamiProduct in interface QWEventMsgRecord
Returns:
false.

getMagnitude

public double getMagnitude()
Returns the event magnitude. For 'QWStationAmpMsgRecord' the value 0.0 is always returned.

Specified by:
getMagnitude in interface QWEventMsgRecord
Returns:
0.0.

getMagnitudeObj

public java.lang.Double getMagnitudeObj()
Returns a 'Double' object containing the event magnitude. For 'QWStationAmpMsgRecord' the value 'null' is always returned.

Specified by:
getMagnitudeObj in interface QWEventMsgRecord
Returns:
null.

getMagnitudeValueString

public java.lang.String getMagnitudeValueString()
Returns a display string representation of the magnitude. For 'QWStationAmpMsgRecord' the value "??" is always returned.

Specified by:
getMagnitudeValueString in interface QWEventMsgRecord
Returns:
"??".

getMagnitudeType

public java.lang.String getMagnitudeType()
Returns a string representing the type code for the primary magnitude. For 'QWStationAmpMsgRecord' the value 'null' is always returned.

Specified by:
getMagnitudeType in interface QWEventMsgRecord
Returns:
null.

getDepthObj

public java.lang.Double getDepthObj()
Returns the event depth value. For 'QWStationAmpMsgRecord' the value 'null' is always returned.

Specified by:
getDepthObj in interface QWEventMsgRecord
Returns:
null.

getDepthString

public java.lang.String getDepthString(boolean milesFlag)
Returns a display string representation of the depth. For 'QWStationAmpMsgRecord' the value "??" is always returned.

Specified by:
getDepthString in interface QWEventMsgRecord
Parameters:
milesFlag - true to convert the depth value from kilometers to miles; false to leave the depth value unchanged.
Returns:
"??".

getDepthString

public java.lang.String getDepthString()
Returns a display string representation of the depth. For 'QWStationAmpMsgRecord' the value "??" is always returned.

Specified by:
getDepthString in interface QWEventMsgRecord
Returns:
"??".

isVerified

public boolean isVerified()
Returns true if the message is verified. For 'QWStationAmpMsgRecord' the value 'false' is always returned.

Specified by:
isVerified in interface QWEventMsgRecord
Returns:
false.

isQuarry

public boolean isQuarry()
Returns true if the "quarry" flag is set. For 'QWStationAmpMsgRecord' the value 'false' is always returned.

Specified by:
isQuarry in interface QWEventMsgRecord
Returns:
false.

updateDateTimeZones

public static void updateDateTimeZones(java.util.TimeZone zone)
Updates time zone used for date/time values for all event-message-record objects.

Parameters:
zone - time zone.