Package de.gsi.dataset.serializer.spi

Class FieldHeader

java.lang.Object

de.gsi.dataset.serializer.spi.FieldHeader

public class FieldHeader
extends java.lang.Object

Field header descriptor

Author:

rstein

Constructor Summary

Constructors

Constructor	Description
FieldHeader(FieldHeader parent, java.lang.String fieldName, DataType dataType, int[] dims, long positionBuffer, long expectedNumberOfBytes)	Constructs new serializer field header
FieldHeader(java.lang.String fieldName, DataType dataType, int[] dims, long positionBuffer, long expectedNumberOfBytes)	Constructs new serializer field header

Method Summary

Modifier and Type	Method	Description
static java.util.Optional<FieldHeader>	findHeaderFor(java.util.List<FieldHeader> fieldHeaderList, java.lang.String fieldName)
java.util.List<FieldHeader>	getChildren()
long	getDataBufferPosition()
int	getDataDimension()
int[]	getDataDimensions()
DataType	getDataType()
long	getExpectedNumberOfDataBytes()
java.lang.String	getFieldName()
java.util.Optional<FieldHeader>	getParent()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldHeader

public FieldHeader(FieldHeader parent,
                   java.lang.String fieldName,
                   DataType dataType,
                   int[] dims,
                   long positionBuffer,
                   long expectedNumberOfBytes)

Constructs new serializer field header

Parameters:

parent - the optional parent field header (for cascaded objects)

fieldName - the clear text field name description

dataType - the data type of that field

dims - array with length indicating the number-of-dimensions and indices the length of each dimension

positionBuffer - the position from which the actual data can be parsed onwards

expectedNumberOfBytes - the expected number of bytes to skip the data block

FieldHeader

public FieldHeader(java.lang.String fieldName,
                   DataType dataType,
                   int[] dims,
                   long positionBuffer,
                   long expectedNumberOfBytes)

Constructs new serializer field header

Parameters:

fieldName - the clear text field name description

dataType - the data type of that field

dims - array with length indicating the number-of-dimensions and indices the length of each dimension

positionBuffer - the position from which the actual data can be parsed onwards

expectedNumberOfBytes - the expected number of bytes to skip the data block

Method Detail

getChildren

public java.util.List<FieldHeader> getChildren()

getDataBufferPosition

public long getDataBufferPosition()

getDataDimension

public int getDataDimension()

getDataDimensions

public int[] getDataDimensions()

getDataType

public DataType getDataType()

getExpectedNumberOfDataBytes

public long getExpectedNumberOfDataBytes()

getFieldName

public java.lang.String getFieldName()

getParent

public java.util.Optional<FieldHeader> getParent()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

findHeaderFor

public static java.util.Optional<FieldHeader> findHeaderFor(java.util.List<FieldHeader> fieldHeaderList,
                                                            java.lang.String fieldName)