org.jlab.coda.hipo

Class Record

java.lang.Object

org.jlab.coda.hipo.Record

Deprecated.

@Deprecated
public class Record
extends java.lang.Object

 RECORD HEADER STRUCTURE ( 48 bytes, 12 integers (32 bit) )

 
 +----------------------------------+
 |       ID word (0x43455248)       |
 +----------------------------------+
 +         Record Length            |
 +----------------------------------+
 +    Data Length Uncompressed      |
 +------+---------------------------+
 +  CT  | Data Length Compressed    | // CT = compression type (8 bits)
 +------+---------------------------+
 +  Number of events in the record  |
 +----------------------------------+
 +      Record Header length        |
 +----------------------------------+
 +  Index Description Length        |
 +----------------------------------+
 +           Reserved               |
 +----------------------------------+
 +        UID FIRST LOW             |
 +----------------------------------+
 +        UID FIRST HIGH            |
 +----------------------------------+
 +        UID SECOND LOW            |
 +----------------------------------+
 +        UID SECOND HIGH           |
 +----------------------------------+

 

NOTE: THIS CLASS IS NOT USED IN EVIO!

HIPO Record Class that creates records of data buffers (agnostic to what the data represents).

Since:

08/10/2017

Author:

gavalian

Constructor Summary

Constructors

Constructor and Description
Record() Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	addEvent(byte[] buffer) Deprecated. add new byte[] array into the record.
java.nio.ByteBuffer	build() Deprecated. Builds a byte[] array of the record.
void	build(java.nio.ByteBuffer userHeader) Deprecated.
static int	decodeCompressionLength(int word) Deprecated.
static int	decodeCompressionType(int word) Deprecated.
static int	encodeCompressionWord(int compression, int length) Deprecated.
CompressionType	getCompressionType() Deprecated. Gets the compression type for the record.
int	getEntries() Deprecated. returns number of arrays in the record.
byte[]	getEvent(int index) Deprecated. returns a copy of the event with index = index.
byte[]	getEventNoCopy(int index) Deprecated. Returns a reference to the byte[] array stored at position index.
static Record	initBinary(byte[] buffer) Deprecated.
void	reset() Deprecated. Resets the content of the record.
Record	setCompressionType(CompressionType compression) Deprecated. Sets compression type for the record.
Record	setCompressionType(int compression) Deprecated. Sets compression type for the record.
void	setMaximumCapacity(int max_capacity) Deprecated. Sets the maximum capacity of the record.
void	show() Deprecated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Record

public Record()

Deprecated.

Method Detail

setCompressionType

public Record setCompressionType(CompressionType compression)

Deprecated.

Sets compression type for the record. It will be used when the build() method is called.

Parameters:

compression - compression type as enum.

Returns:

this object.

setCompressionType

public Record setCompressionType(int compression)

Deprecated.

Sets compression type for the record. It will be used when the build() method is called.

Parameters:

compression - compression type as int.

Returns:

this object.

getCompressionType

public CompressionType getCompressionType()

Deprecated.

Gets the compression type for the record.

Returns:

compression type for the record.

setMaximumCapacity

public void setMaximumCapacity(int max_capacity)

Deprecated.

Sets the maximum capacity of the record. No data will be added if the this limit is reached.

Parameters:

max_capacity - maximum capacity of the record.

addEvent

public boolean addEvent(byte[] buffer)

Deprecated.

add new byte[] array into the record. if the array added to the record will exceed the maximum capacity array will not be added and function returns false.

Parameters:

buffer - array to add to the record

Returns:

true is array is added, false otherwise

getEventNoCopy

public byte[] getEventNoCopy(int index)

Deprecated.

Returns a reference to the byte[] array stored at position index.

Parameters:

index - array position

Returns:

byte array

getEvent

public byte[] getEvent(int index)

Deprecated.

returns a copy of the event with index = index.

Parameters:

index - order in the array

Returns:

byte array

build

public void build(java.nio.ByteBuffer userHeader)

Deprecated.

build

public java.nio.ByteBuffer build()

Deprecated.

Builds a byte[] array of the record. The record header, index array and compressed data are written out. NOTE ! the buffer is LITTLE_ENDIAN independent of the platform.

Returns:

array representation of the record.

reset

public void reset()

Deprecated.

Resets the content of the record. sets bytes writing counter to zero.

getEntries

public int getEntries()

Deprecated.

returns number of arrays in the record.

Returns:

number of arrays in the record.

encodeCompressionWord

public static int encodeCompressionWord(int compression,
                                        int length)

Deprecated.

decodeCompressionType

public static int decodeCompressionType(int word)

Deprecated.

decodeCompressionLength

public static int decodeCompressionLength(int word)

Deprecated.

initBinary

public static Record initBinary(byte[] buffer)

Deprecated.

show

public void show()

Deprecated.