com.isti.quakewatch.message
Class QWDelProductMsgRecord

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.QWDelProductMsgRecord
All Implemented Interfaces:
QWMsgNumTimeRec, Archivable

public class QWDelProductMsgRecord
extends QWIdentDataMsgRecord

QWDelProductMsgRecord defines a record of data for one event-product that is to be deleted.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.isti.util.Archivable
Archivable.Marker
 
Field Summary
 java.lang.String msgTypeCode
          Message type code string received from feeder module.
 java.lang.String prodTypeCode
          Product type code string received from feeder module.
 org.jdom.Element productElement
          Handle to 'Element' object used to construct this object.
 java.lang.String type
          Message type string set by QWServer.
 java.lang.String value
          Value string for product, or null if none.
 
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
QWDelProductMsgRecord(org.jdom.Element qwMsgElement, org.jdom.Element dataMsgElement, org.jdom.Element eventElement, org.jdom.Element productElement, boolean anssEQMsgFormatFlag, boolean commentElemFlag)
          Deprecated. Use version with 'messageFormatSpec' parameter.
QWDelProductMsgRecord(org.jdom.Element qwMsgElement, org.jdom.Element dataMsgElement, org.jdom.Element eventElement, org.jdom.Element productElement, int messageFormatSpec, boolean commentElemFlag)
          Creates a data record for one event product that is to be deleted, built from an XML "Product" message element.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Indicates whether some other object is "equal to" this one.
 boolean equals(QWDelProductMsgRecord obj)
          Indicates whether some other object is "equal to" this one.
 boolean isSameProductType(QWProductMsgRecord recObj)
          Indicates if the product type of the given record is equal to the product type for this record.
 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

productElement

public final org.jdom.Element productElement
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.


prodTypeCode

public final java.lang.String prodTypeCode
Product type code string received from feeder module.


value

public final java.lang.String value
Value string for product, or null if none.

Constructor Detail

QWDelProductMsgRecord

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

Parameters:
qwMsgElement - the XML "QWmessage" element object.
dataMsgElement - the XML "DataMessage" element object.
eventElement - the XML "Event" element object if ANSS-EQ-XML message format, or null if QuakeWatch message format.
productElement - the "ProductLink" message element if ANSS-EQ-XML message format, or the "Product" message element (containing the "Identifier") if QuakeWatch message format.
messageFormatSpec - specifier for message-format type (one of the 'QWIdentDataMsgRecord.MFMT_...' values).
commentElemFlag - true if Comment element in use in ANSS-EQ-XML message; false if ProductLink element in use in ANSS-EQ-XML message (or if QuakeWatch message).
Throws:
QWRecordException - if an error occurs while creating the data record.

QWDelProductMsgRecord

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

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

Parameters:
qwMsgElement - the XML "QWmessage" element object.
dataMsgElement - the XML "DataMessage" element object.
eventElement - the XML "Event" element object if ANSS-EQ-XML message format, or null if QuakeWatch message format.
productElement - the "ProductLink" message element if ANSS-EQ-XML message format, or the "Product" message element (containing the "Identifier") if QuakeWatch message format.
anssEQMsgFormatFlag - true for ANSS-EQ-XML message format; false for QuakeWatch message format.
commentElemFlag - true if Comment element in use in ANSS-EQ-XML message; false if ProductLink element in use in ANSS-EQ-XML message (or if QuakeWatch message).
Throws:
QWRecordException - if an error occurs while creating the data record.
Method Detail

equals

public boolean equals(QWDelProductMsgRecord 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.

isSameProductType

public boolean isSameProductType(QWProductMsgRecord recObj)
Indicates if the product type of the given record is equal to the product type for this record. The 'prodTypeCode' values are also compared.

Parameters:
recObj - QWProductMsgRecord given record to compare.
Returns:
true if the product type of the given record is equal to the product type for this record; false if not.

toString

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

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