ucar.nc2.iosp.bufr
Class Message

java.lang.Object
  ucar.nc2.iosp.bufr.Message

public class Message
extends java.lang.Object

Encapsolates a complete BUFR message. A message has a DataDescriptor and one or more "datasets" aka "data subsets" aka "observations" aka "obs".

Since:

May 9, 2008

Author:

caron

Field Summary

BufrDataSection	dataSection
BufrDataDescriptionSection	dds
BufrIdentificationSection	ids
BufrIndicatorSection	is

Constructor Summary

Message(RandomAccessFile raf, BufrIndicatorSection is, BufrIdentificationSection ids, BufrDataDescriptionSection dds, BufrDataSection dataSection)

Method Summary

int	calcTotalBits(java.util.Formatter out)
void	close()
void	dump(java.util.Formatter out)
void	dumpHeader(java.util.Formatter out)
void	dumpHeaderShort(java.util.Formatter out)
boolean	equals(java.lang.Object obj) BufrMessage is equal if they have the same dds.
java.lang.String	extractWMO()
BitCounterUncompressed	getBitCounterUncompressed(int obsOffsetInMessage) Get the offset of this obs from the start of the message data.
java.lang.String	getCategoryFullName()
java.lang.String	getCategoryName()
java.lang.String	getCategoryNo()
java.lang.String	getCenterName()
java.lang.String	getCenterNo()
int	getCountedDataBytes()
BitCounterCompressed[]	getCounterFlds()
java.lang.String	getHeader()
long	getMessageSize() Get the byte length of the entire BUFR record.
int	getNumberDatasets() Get number of datasets in this message.
byte[]	getRawBytes()
DataDescriptor	getRootDataDescriptor() Get the root of the DataDescriptor tree.
long	getStartPos()
java.lang.String	getTableName()
int	getTotalBits() This is the total number of bits taken by the data in the data section of the message.
int	hashCode() Override hashcode to be consistent with equals.
boolean	isBitCountOk()
boolean	isTablesComplete() Check if all descriptors were found in the tables.
java.lang.Object[][]	readValues(java.util.List<java.lang.Integer> indexFlds) Get values of selected fields.
void	setHeader(java.lang.String header)
void	setRawBytes(byte[] raw)
void	setStartPos(long startPos)
void	showMissingFields(java.util.Formatter out)
boolean	usesLocalTable()

Methods inherited from class java.lang.Object

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

Field Detail

is

public BufrIndicatorSection is

ids

public BufrIdentificationSection ids

dds

public BufrDataDescriptionSection dds

dataSection

public BufrDataSection dataSection

Constructor Detail

Message

public Message(RandomAccessFile raf,
               BufrIndicatorSection is,
               BufrIdentificationSection ids,
               BufrDataDescriptionSection dds,
               BufrDataSection dataSection)
        throws java.io.IOException

Throws:

java.io.IOException

Method Detail

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

getNumberDatasets

public int getNumberDatasets()

Get number of datasets in this message.

Returns:

number of datasets in this message

getCategoryName

public java.lang.String getCategoryName()
                                 throws java.io.IOException

Throws:

java.io.IOException

getCategoryNo

public java.lang.String getCategoryNo()
                               throws java.io.IOException

Throws:

java.io.IOException

getCenterName

public java.lang.String getCenterName()

getCenterNo

public java.lang.String getCenterNo()

getTableName

public java.lang.String getTableName()

setHeader

public void setHeader(java.lang.String header)

getHeader

public java.lang.String getHeader()

setStartPos

public void setStartPos(long startPos)

getStartPos

public long getStartPos()

setRawBytes

public void setRawBytes(byte[] raw)

getRawBytes

public byte[] getRawBytes()

extractWMO

public java.lang.String extractWMO()

getMessageSize

public long getMessageSize()

Get the byte length of the entire BUFR record.

Returns:

length in bytes of BUFR record

getRootDataDescriptor

public DataDescriptor getRootDataDescriptor()
                                     throws java.io.IOException

Get the root of the DataDescriptor tree.

Returns:

root DataDescriptor

Throws:

java.io.IOException - on read error

usesLocalTable

public boolean usesLocalTable()
                       throws java.io.IOException

Throws:

java.io.IOException

isTablesComplete

public boolean isTablesComplete()
                         throws java.io.IOException

Check if all descriptors were found in the tables.

Returns:

true if all dds were found.

Throws:

java.io.IOException - on read error

showMissingFields

public void showMissingFields(java.util.Formatter out)
                       throws java.io.IOException

Throws:

java.io.IOException

isBitCountOk

public boolean isBitCountOk()
                     throws java.io.IOException

Throws:

java.io.IOException

getCountedDataBytes

public int getCountedDataBytes()

getBitCounterUncompressed

public BitCounterUncompressed getBitCounterUncompressed(int obsOffsetInMessage)

Get the offset of this obs from the start of the message data. Use only for non compressed data

Parameters:

obsOffsetInMessage - index of obs in the message

Returns:

offset in bits

public int getBitOffset(int obsOffsetInMessage) { if (dds.isCompressed()) throw new IllegalArgumentException("cant call BufrMessage.getBitOffset() on compressed message");

if (!root.isVarLength) return root.total_nbits * obsOffsetInMessage;

getTotalBits(); // make sure its been set return nestedTableCounter[obsOffsetInMessage].getStartBit(); }

getTotalBits

public int getTotalBits()

This is the total number of bits taken by the data in the data section of the message. This is the counted number.

Returns:

total number of bits

calcTotalBits

public int calcTotalBits(java.util.Formatter out)

getCounterFlds

public BitCounterCompressed[] getCounterFlds()
                                      throws java.io.IOException

Throws:

java.io.IOException

readValues

public java.lang.Object[][] readValues(java.util.List<java.lang.Integer> indexFlds)
                                throws java.io.IOException

Get values of selected fields. Must be in the top row (not nested).

Parameters:

indexFlds - index of desired field in the dds

Returns:

field values as Object[nobs][nfields]

Throws:

java.io.IOException - on read error

hashCode

public int hashCode()

Override hashcode to be consistent with equals.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code of dds.getDescriptors()

equals

public boolean equals(java.lang.Object obj)

BufrMessage is equal if they have the same dds.

Overrides:

equals in class java.lang.Object

Parameters:

obj - other BufrMessage

Returns:

true if equals

dump

public void dump(java.util.Formatter out)
          throws java.io.IOException

Throws:

java.io.IOException

getCategoryFullName

public java.lang.String getCategoryFullName()
                                     throws java.io.IOException

Throws:

java.io.IOException

dumpHeader

public void dumpHeader(java.util.Formatter out)
                throws java.io.IOException

Throws:

java.io.IOException

dumpHeaderShort

public void dumpHeaderShort(java.util.Formatter out)
                     throws java.io.IOException

Throws:

java.io.IOException