com.isti.quakewatch.message
Class QWDelEventMsgRecord

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.QWIdentDataMsgRecord
                  extended by com.isti.quakewatch.message.QWDelEventMsgRecord
All Implemented Interfaces:
QWMsgNumTimeRec, Archivable

public class QWDelEventMsgRecord
extends QWIdentDataMsgRecord

QWDelEventMsgRecord defines a record of data for one event that is to be deleted.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.isti.util.Archivable
Archivable.Marker
 
Field Summary
 org.jdom.Element eventElement
          Handle to 'Element' object used to construct this object.
 java.lang.String msgTypeCode
          Message type code string received from feeder module.
protected  FifoHashtable productRecTable
          Table of 'QWProductMsgRecord' objects for event (or null).
 java.lang.String type
          Message type string set by QWServer.
 
Fields inherited from class com.isti.quakewatch.message.QWIdentDataMsgRecord
dataSource, eventID, eventIDKey, lcEventIDKeyStr, messageFormatSpec, MFMT_ANSSEQXML, MFMT_QUAKEML, MFMT_QWMESSAGE, version
 
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
 
Constructor Summary
QWDelEventMsgRecord(org.jdom.Element qwMsgElement, org.jdom.Element dataMsgElement, org.jdom.Element eventElement)
          Creates a data record for one event that is to be deleted, built from a QuakeWatch format XML "Event" message element.
QWDelEventMsgRecord(org.jdom.Element qwMsgElement, org.jdom.Element dataMsgElement, org.jdom.Element eventElement, boolean anssEQMsgFormatFlag)
          Deprecated. Use version with 'messageFormatSpec' parameter.
QWDelEventMsgRecord(org.jdom.Element qwMsgElement, org.jdom.Element dataMsgElement, org.jdom.Element eventElement, int messageFormatSpec)
          Creates a data record for one event that is to be deleted, built from an XML "Event" message element.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Indicates whether some other object is "equal to" this one.
 boolean equals(QWDelEventMsgRecord obj)
          Indicates whether some other object is "equal to" this one.
 java.lang.String getCommentStr()
          Returns the comment text from this message.
 int getProductCount()
          Returns the number of products associated with the event to be deleted.
 QWProductMsgRecord getProductMsgRecord(java.lang.String typeStr)
          Returns a 'QWProductMsgRecord' object for the event to be deleted.
 FifoHashtable getProductRecTable()
          Returns the table of 'QWProductMsgRecord' objects for products associated with the event to be deleted.
 void setProductRecTable(FifoHashtable tableObj)
          Enters a new table of 'QWProductMsgRecord' objects for products associated with the event to be deleted.
 java.lang.String toString()
          Returns a string representation of this class.
 
Methods inherited from class com.isti.quakewatch.message.QWIdentDataMsgRecord
equals, getDataSource, getEventID, getEventIDKey, getLCEventIDKey, getVersion, isShakeMapProduct
 
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
 

Field Detail

eventElement

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


type

public final java.lang.String type
Message type string set by QWServer.


msgTypeCode

public final java.lang.String msgTypeCode
Message type code string received from feeder module.


productRecTable

protected FifoHashtable productRecTable
Table of 'QWProductMsgRecord' objects for event (or null).

Constructor Detail

QWDelEventMsgRecord

public QWDelEventMsgRecord(org.jdom.Element qwMsgElement,
                           org.jdom.Element dataMsgElement,
                           org.jdom.Element eventElement,
                           int messageFormatSpec)
                    throws QWRecordException
Creates a data record for one event that is to be deleted, built from an XML "Event" message element.

Parameters:
qwMsgElement - the XML "QWmessage" element object.
dataMsgElement - the XML "DataMessage" element object.
eventElement - the XML "Event" message element.
messageFormatSpec - specifier for message-format type (one of the 'QWIdentDataMsgRecord.MFMT_...' values).
Throws:
QWRecordException - if an error occurs while creating the data record.

QWDelEventMsgRecord

public QWDelEventMsgRecord(org.jdom.Element qwMsgElement,
                           org.jdom.Element dataMsgElement,
                           org.jdom.Element eventElement,
                           boolean anssEQMsgFormatFlag)
                    throws QWRecordException
Deprecated. Use version with 'messageFormatSpec' parameter.

Creates a data record for one event that is to be deleted, built from an XML "Event" message element.

Parameters:
qwMsgElement - the XML "QWmessage" element object.
dataMsgElement - the XML "DataMessage" element object.
eventElement - the XML "Event" message element.
anssEQMsgFormatFlag - true for ANSS-EQ-XML message format; false for QuakeWatch message format.
Throws:
QWRecordException - if an error occurs while creating the data record.

QWDelEventMsgRecord

public QWDelEventMsgRecord(org.jdom.Element qwMsgElement,
                           org.jdom.Element dataMsgElement,
                           org.jdom.Element eventElement)
                    throws QWRecordException
Creates a data record for one event that is to be deleted, built from a QuakeWatch format XML "Event" message element.

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

equals

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

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.

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

toString

public java.lang.String toString()
Returns a string representation of this class.

Overrides:
toString in class java.lang.Object
Returns:
String object.

setProductRecTable

public void setProductRecTable(FifoHashtable tableObj)
Enters a new table of 'QWProductMsgRecord' objects for products associated with the event to be deleted.

Parameters:
tableObj - the new table to use.

getProductRecTable

public FifoHashtable getProductRecTable()
Returns the table of 'QWProductMsgRecord' objects for products associated with the event to be deleted.

Returns:
A FifoHashtable of 'QWProductMsgRecord' objects, or null if none are available.

getProductMsgRecord

public QWProductMsgRecord getProductMsgRecord(java.lang.String typeStr)
Returns a 'QWProductMsgRecord' object for the event to be deleted.

Parameters:
typeStr - the 'type' value of the 'QWProductMsgRecord' object to be returned.
Returns:
A 'QWProductMsgRecord' object, or null if a matching object is not found.

getProductCount

public int getProductCount()
Returns the number of products associated with the event to be deleted.

Returns:
The number of products associated with the event to be deleted.

getCommentStr

public java.lang.String getCommentStr()
Returns the comment text from this message.

Returns:
The comment text string from this message, or null if none available.