Package de.gsi.serializer.spi

Class CmwLightSerialiser

java.lang.Object

de.gsi.serializer.spi.CmwLightSerialiser

All Implemented Interfaces:

IoSerialiser

public class CmwLightSerialiser
extends java.lang.Object
implements IoSerialiser

Light-weight open-source implementation of a (de-)serialiser that is binary-compatible to the serialiser used by CMW, a proprietary closed-source middle-ware used in some accelerator laboratories. N.B. this implementation is intended only for performance/functionality comparison and to enable a backward compatible transition to the BinarySerialiser implementation which is a bit more flexible, has some additional (optional) features, and a better IO performance. See the corresponding benchmarks for details;

Author:

rstein

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NOT_IMPLEMENTED

Constructor Summary

Constructors

Constructor	Description
CmwLightSerialiser(IoBuffer buffer)

Method Summary

Modifier and Type	Method	Description
ProtocolInfo	checkHeaderInfo()	Reads and checks protocol header information.
int[]	getArraySizeDescriptor()
boolean	getBoolean()
boolean[]	getBooleanArray(boolean[] dst, int length)
IoBuffer	getBuffer()
int	getBufferIncrements()
byte	getByte()
byte[]	getByteArray(byte[] dst, int length)
char	getChar()
char[]	getCharArray(char[] dst, int length)
<E> java.util.Collection<E>	getCollection(java.util.Collection<E> collection)
<E> E	getCustomData(FieldSerialiser<E> serialiser)
static DataType	getDataType(byte byteValue)
static byte	getDataType(DataType dataType)
double	getDouble()
double[]	getDoubleArray(double[] dst, int length)
<E extends java.lang.Enum<E>> java.lang.Enum<E>	getEnum(java.lang.Enum<E> enumeration)
java.lang.String	getEnumTypeList()
WireDataFieldDescription	getFieldHeader()
float	getFloat()
float[]	getFloatArray(float[] dst, int length)
int	getInt()
int[]	getIntArray(int[] dst, int length)
<E> java.util.List<E>	getList(java.util.List<E> collection)
long	getLong()
long[]	getLongArray(long[] dst, int length)
<K,V,E> java.util.Map<K,V>	getMap(java.util.Map<K,V> map)
WireDataFieldDescription	getParent()
<E> java.util.Queue<E>	getQueue(java.util.Queue<E> collection)
java.util.function.BiFunction<java.lang.reflect.Type,java.lang.reflect.Type[],FieldSerialiser<java.lang.Object>>	getSerialiserLookupFunction()
<E> java.util.Set<E>	getSet(java.util.Set<E> collection)
short	getShort()
short[]	getShortArray(short[] dst, int length)
java.lang.String	getString()
java.lang.String[]	getStringArray(java.lang.String[] dst, int length)
java.lang.String	getStringISO8859()
boolean	isEnforceSimpleStringEncoding()
boolean	isPutFieldMetaData()
WireDataFieldDescription	parseIoStream(boolean readHeader)
void	parseIoStream(WireDataFieldDescription fieldRoot, int recursionDepth)
void	put(FieldDescription fieldDescription, boolean value)
void	put(FieldDescription fieldDescription, boolean[] values, int n)
void	put(FieldDescription fieldDescription, boolean[] values, int[] dims)
void	put(FieldDescription fieldDescription, byte value)
void	put(FieldDescription fieldDescription, byte[] values, int n)
void	put(FieldDescription fieldDescription, byte[] values, int[] dims)
void	put(FieldDescription fieldDescription, char value)
void	put(FieldDescription fieldDescription, char[] values, int n)
void	put(FieldDescription fieldDescription, char[] values, int[] dims)
void	put(FieldDescription fieldDescription, double value)
void	put(FieldDescription fieldDescription, double[] values, int n)
void	put(FieldDescription fieldDescription, double[] values, int[] dims)
void	put(FieldDescription fieldDescription, float value)
void	put(FieldDescription fieldDescription, float[] values, int n)
void	put(FieldDescription fieldDescription, float[] values, int[] dims)
void	put(FieldDescription fieldDescription, int value)
void	put(FieldDescription fieldDescription, int[] values, int n)
void	put(FieldDescription fieldDescription, int[] values, int[] dims)
void	put(FieldDescription fieldDescription, long value)
void	put(FieldDescription fieldDescription, long[] values, int n)
void	put(FieldDescription fieldDescription, long[] values, int[] dims)
void	put(FieldDescription fieldDescription, short value)
void	put(FieldDescription fieldDescription, short[] values, int n)
void	put(FieldDescription fieldDescription, short[] values, int[] dims)
void	put(FieldDescription fieldDescription, java.lang.Enum<?> enumeration)
void	put(FieldDescription fieldDescription, java.lang.String string)
void	put(FieldDescription fieldDescription, java.lang.String[] values, int n)
void	put(FieldDescription fieldDescription, java.lang.String[] values, int[] dims)
<E> void	put(FieldDescription fieldDescription, java.util.Collection<E> collection, java.lang.reflect.Type valueType)
<K,V,E> void	put(FieldDescription fieldDescription, java.util.Map<K,V> map, java.lang.reflect.Type keyType, java.lang.reflect.Type valueType)
void	put(java.lang.String fieldName, boolean value)
void	put(java.lang.String fieldName, boolean[] values, int n)
void	put(java.lang.String fieldName, boolean[] values, int[] dims)
void	put(java.lang.String fieldName, byte value)
void	put(java.lang.String fieldName, byte[] values, int n)
void	put(java.lang.String fieldName, byte[] values, int[] dims)
void	put(java.lang.String fieldName, char value)
void	put(java.lang.String fieldName, char[] values, int n)
void	put(java.lang.String fieldName, char[] values, int[] dims)
void	put(java.lang.String fieldName, double value)
void	put(java.lang.String fieldName, double[] values, int n)
void	put(java.lang.String fieldName, double[] values, int[] dims)
void	put(java.lang.String fieldName, float value)
void	put(java.lang.String fieldName, float[] values, int n)
void	put(java.lang.String fieldName, float[] values, int[] dims)
void	put(java.lang.String fieldName, int value)
void	put(java.lang.String fieldName, int[] values, int n)
void	put(java.lang.String fieldName, int[] values, int[] dims)
void	put(java.lang.String fieldName, long value)
void	put(java.lang.String fieldName, long[] values, int n)
void	put(java.lang.String fieldName, long[] values, int[] dims)
void	put(java.lang.String fieldName, short value)
void	put(java.lang.String fieldName, short[] values, int n)
void	put(java.lang.String fieldName, short[] values, int[] dims)
void	put(java.lang.String fieldName, java.lang.Enum<?> enumeration)
void	put(java.lang.String fieldName, java.lang.String string)
void	put(java.lang.String fieldName, java.lang.String[] values, int n)
void	put(java.lang.String fieldName, java.lang.String[] values, int[] dims)
<E> void	put(java.lang.String fieldName, java.util.Collection<E> collection, java.lang.reflect.Type valueType)
<K,V,E> void	put(java.lang.String fieldName, java.util.Map<K,V> map, java.lang.reflect.Type keyType, java.lang.reflect.Type valueType)
int	putArraySizeDescriptor(int n)
int	putArraySizeDescriptor(int[] dims)
<E> WireDataFieldDescription	putCustomData(FieldDescription fieldDescription, E rootObject, java.lang.Class<? extends E> type, FieldSerialiser<E> serialiser)
void	putEndMarker(FieldDescription fieldDescription)
WireDataFieldDescription	putFieldHeader(FieldDescription fieldDescription)
WireDataFieldDescription	putFieldHeader(FieldDescription fieldDescription, DataType customDataType)
WireDataFieldDescription	putFieldHeader(java.lang.String fieldName, DataType dataType)
void	putHeaderInfo(FieldDescription... field)	Adds header and version information
void	putStartMarker(FieldDescription fieldDescription)
void	setBuffer(IoBuffer buffer)
void	setEnforceSimpleStringEncoding(boolean state)
void	setFieldSerialiserLookupFunction(java.util.function.BiFunction<java.lang.reflect.Type,java.lang.reflect.Type[],FieldSerialiser<java.lang.Object>> serialiserLookupFunction)
void	setPutFieldMetaData(boolean putFieldMetaData)
void	setQueryFieldName(java.lang.String fieldName, int dataStartPosition)
void	updateDataEndMarker(WireDataFieldDescription fieldHeader)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.gsi.serializer.IoSerialiser

getBooleanArray, getBooleanArray, getByteArray, getByteArray, getCharArray, getCharArray, getDoubleArray, getDoubleArray, getFloatArray, getFloatArray, getIntArray, getIntArray, getLongArray, getLongArray, getShortArray, getShortArray, getStringArray, getStringArray, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put

Field Detail

NOT_IMPLEMENTED

public static final java.lang.String NOT_IMPLEMENTED

See Also:

Constant Field Values

Constructor Detail

CmwLightSerialiser

public CmwLightSerialiser(IoBuffer buffer)

Method Detail

checkHeaderInfo

public ProtocolInfo checkHeaderInfo()

Description copied from interface: IoSerialiser

Reads and checks protocol header information.

Specified by:

checkHeaderInfo in interface IoSerialiser

Returns:

ProtocolInfo info Object (extends FieldHeader)

getArraySizeDescriptor

public int[] getArraySizeDescriptor()

Specified by:

getArraySizeDescriptor in interface IoSerialiser

getBoolean

public boolean getBoolean()

Specified by:

getBoolean in interface IoSerialiser

getBooleanArray

public boolean[] getBooleanArray(boolean[] dst,
                                 int length)

Specified by:

getBooleanArray in interface IoSerialiser

getBuffer

public IoBuffer getBuffer()

Specified by:

getBuffer in interface IoSerialiser

setBuffer

public void setBuffer(IoBuffer buffer)

Specified by:

setBuffer in interface IoSerialiser

getBufferIncrements

public int getBufferIncrements()

getByte

public byte getByte()

Specified by:

getByte in interface IoSerialiser

getByteArray

public byte[] getByteArray(byte[] dst,
                           int length)

Specified by:

getByteArray in interface IoSerialiser

getChar

public char getChar()

Specified by:

getChar in interface IoSerialiser

getCharArray

public char[] getCharArray(char[] dst,
                           int length)

Specified by:

getCharArray in interface IoSerialiser

getCollection

public <E> java.util.Collection<E> getCollection(java.util.Collection<E> collection)

Specified by:

getCollection in interface IoSerialiser

getCustomData

public <E> E getCustomData(FieldSerialiser<E> serialiser)

Specified by:

getCustomData in interface IoSerialiser

getDouble

public double getDouble()

Specified by:

getDouble in interface IoSerialiser

getDoubleArray

public double[] getDoubleArray(double[] dst,
                               int length)

Specified by:

getDoubleArray in interface IoSerialiser

getEnum

public <E extends java.lang.Enum<E>> java.lang.Enum<E> getEnum(java.lang.Enum<E> enumeration)

Specified by:

getEnum in interface IoSerialiser

getEnumTypeList

public java.lang.String getEnumTypeList()

Specified by:

getEnumTypeList in interface IoSerialiser

getFieldHeader

public WireDataFieldDescription getFieldHeader()

Specified by:

getFieldHeader in interface IoSerialiser

getFloat

public float getFloat()

Specified by:

getFloat in interface IoSerialiser

getFloatArray

public float[] getFloatArray(float[] dst,
                             int length)

Specified by:

getFloatArray in interface IoSerialiser

getInt

public int getInt()

Specified by:

getInt in interface IoSerialiser

getIntArray

public int[] getIntArray(int[] dst,
                         int length)

Specified by:

getIntArray in interface IoSerialiser

getList

public <E> java.util.List<E> getList(java.util.List<E> collection)

Specified by:

getList in interface IoSerialiser

getLong

public long getLong()

Specified by:

getLong in interface IoSerialiser

getLongArray

public long[] getLongArray(long[] dst,
                           int length)

Specified by:

getLongArray in interface IoSerialiser

getMap

public <K,V,E> java.util.Map<K,V> getMap(java.util.Map<K,V> map)

Specified by:

getMap in interface IoSerialiser

getParent

public WireDataFieldDescription getParent()

getQueue

public <E> java.util.Queue<E> getQueue(java.util.Queue<E> collection)

Specified by:

getQueue in interface IoSerialiser

getSet

public <E> java.util.Set<E> getSet(java.util.Set<E> collection)

Specified by:

getSet in interface IoSerialiser

getShort

public short getShort()

Specified by:

getShort in interface IoSerialiser

getShortArray

public short[] getShortArray(short[] dst,
                             int length)

Specified by:

getShortArray in interface IoSerialiser

getString

public java.lang.String getString()

Specified by:

getString in interface IoSerialiser

getStringArray

public java.lang.String[] getStringArray(java.lang.String[] dst,
                                         int length)

Specified by:

getStringArray in interface IoSerialiser

getStringISO8859

public java.lang.String getStringISO8859()

Specified by:

getStringISO8859 in interface IoSerialiser

isEnforceSimpleStringEncoding

public boolean isEnforceSimpleStringEncoding()

Returns:

true the ISO-8859-1 character encoding is being enforced for data fields (better performance), otherwise UTF-8 is being used (more generic encoding)

setEnforceSimpleStringEncoding

public void setEnforceSimpleStringEncoding(boolean state)

Parameters:

state - true the ISO-8859-1 character encoding is being enforced for data fields (better performance), otherwise UTF-8 is being used (more generic encoding)

isPutFieldMetaData

public boolean isPutFieldMetaData()

Specified by:

isPutFieldMetaData in interface IoSerialiser

setPutFieldMetaData

public void setPutFieldMetaData(boolean putFieldMetaData)

Specified by:

setPutFieldMetaData in interface IoSerialiser

parseIoStream

public WireDataFieldDescription parseIoStream(boolean readHeader)

Specified by:

parseIoStream in interface IoSerialiser

parseIoStream

public void parseIoStream(WireDataFieldDescription fieldRoot,
                          int recursionDepth)

put

public <E> void put(FieldDescription fieldDescription,
                    java.util.Collection<E> collection,
                    java.lang.reflect.Type valueType)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                java.lang.Enum<?> enumeration)

Specified by:

put in interface IoSerialiser

put

public <K,V,E> void put(FieldDescription fieldDescription,
                                    java.util.Map<K,V> map,
                                    java.lang.reflect.Type keyType,
                                    java.lang.reflect.Type valueType)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                boolean value)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                boolean[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                boolean[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                byte value)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                byte[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                byte[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                char value)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                char[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                char[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                double value)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                double[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                double[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                float value)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                float[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                float[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                int value)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                int[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                int[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                long value)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                long[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                long[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                short value)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                short[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                short[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                java.lang.String string)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                java.lang.String[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(FieldDescription fieldDescription,
                java.lang.String[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                boolean value)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                boolean[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                boolean[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                byte value)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                byte[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                byte[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                char value)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                char[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                char[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                double value)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                double[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                double[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                float value)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                float[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                float[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                int value)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                int[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                int[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                long value)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                long[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                long[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                short value)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                short[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                short[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                java.lang.String string)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                java.lang.String[] values,
                int n)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                java.lang.String[] values,
                int[] dims)

Specified by:

put in interface IoSerialiser

put

public <E> void put(java.lang.String fieldName,
                    java.util.Collection<E> collection,
                    java.lang.reflect.Type valueType)

Specified by:

put in interface IoSerialiser

put

public void put(java.lang.String fieldName,
                java.lang.Enum<?> enumeration)

Specified by:

put in interface IoSerialiser

put

public <K,V,E> void put(java.lang.String fieldName,
                                    java.util.Map<K,V> map,
                                    java.lang.reflect.Type keyType,
                                    java.lang.reflect.Type valueType)

Specified by:

put in interface IoSerialiser

putArraySizeDescriptor

public int putArraySizeDescriptor(int n)

Specified by:

putArraySizeDescriptor in interface IoSerialiser

putArraySizeDescriptor

public int putArraySizeDescriptor(int[] dims)

Specified by:

putArraySizeDescriptor in interface IoSerialiser

putCustomData

public <E> WireDataFieldDescription putCustomData(FieldDescription fieldDescription,
                                                  E rootObject,
                                                  java.lang.Class<? extends E> type,
                                                  FieldSerialiser<E> serialiser)

Specified by:

putCustomData in interface IoSerialiser

putEndMarker

public void putEndMarker(FieldDescription fieldDescription)

Specified by:

putEndMarker in interface IoSerialiser

putFieldHeader

public WireDataFieldDescription putFieldHeader(FieldDescription fieldDescription)

Specified by:

putFieldHeader in interface IoSerialiser

putFieldHeader

public WireDataFieldDescription putFieldHeader(FieldDescription fieldDescription,
                                               DataType customDataType)

putFieldHeader

public WireDataFieldDescription putFieldHeader(java.lang.String fieldName,
                                               DataType dataType)

Specified by:

putFieldHeader in interface IoSerialiser

putHeaderInfo

public void putHeaderInfo(FieldDescription... field)

Description copied from interface: IoSerialiser

Adds header and version information

Specified by:

putHeaderInfo in interface IoSerialiser

Parameters:

field - optional FieldDescription (ie. to allow to attach MetaData to the start/stop marker)

putStartMarker

public void putStartMarker(FieldDescription fieldDescription)

Specified by:

putStartMarker in interface IoSerialiser

setQueryFieldName

public void setQueryFieldName(java.lang.String fieldName,
                              int dataStartPosition)

Specified by:

setQueryFieldName in interface IoSerialiser

updateDataEndMarker

public void updateDataEndMarker(WireDataFieldDescription fieldHeader)

Specified by:

updateDataEndMarker in interface IoSerialiser

getDataType

public static byte getDataType(DataType dataType)

getDataType

public static DataType getDataType(byte byteValue)

setFieldSerialiserLookupFunction

public void setFieldSerialiserLookupFunction(java.util.function.BiFunction<java.lang.reflect.Type,java.lang.reflect.Type[],FieldSerialiser<java.lang.Object>> serialiserLookupFunction)

Specified by:

setFieldSerialiserLookupFunction in interface IoSerialiser

getSerialiserLookupFunction

public java.util.function.BiFunction<java.lang.reflect.Type,java.lang.reflect.Type[],FieldSerialiser<java.lang.Object>> getSerialiserLookupFunction()

Specified by:

getSerialiserLookupFunction in interface IoSerialiser