ds.granules.results

Class ResultPayload

java.lang.Object

ds.granules.results.ResultPayload

public class ResultPayload
extends java.lang.Object

This is a utility class which can be used for marshalling and unmarshalling some of the most commonly used result primitives.

Author:

Shrideep Pallickara

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOUBLE
static int	DOUBLE_2D_ARRAY
static int	DOUBLE_ARRAY
static int	FLOAT
static int	FLOAT_2D_ARRAY
static int	FLOAT_ARRAY
static int	HASHMAP
static int	HASHTABLE
static int	INT
static int	INT_2D_ARRAY
static int	INT_ARRAY
static int	LONG
static int	LONG_2D_ARRAY
static int	LONG_ARRAY
static int	OBJECT
static int	OBJECT_2D_ARRAY
static int	OBJECT_ARRAY
static int	SHORT
static int	SHORT_2D_ARRAY
static int	SHORT_ARRAY
static int	STRING
static int	STRING_2D_ARRAY
static int	STRING_ARRAY

Constructor Summary

Constructors

Constructor and Description
ResultPayload()

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes(double value) This method converts a double into a byte[].
byte[]	getBytes(double[] sequence) This method converts a double[] into a byte[].
byte[]	getBytes(double[][] matrix) This method converts a double[][] into a byte[] .
byte[]	getBytes(float value) This method converts a float into a byte[].
byte[]	getBytes(float[] sequence) This method converts a float[] into a byte[].
byte[]	getBytes(float[][] matrix) This method converts a float[][] into a byte[].
byte[]	getBytes(java.util.HashMap<?,?> sequence) This method converts a HashMap into a byte[].
byte[]	getBytes(java.util.Hashtable<?,?> sequence) This method converts a Hashtable into a byte[].
byte[]	getBytes(int value) This method converts an int into a byte[].
byte[]	getBytes(int[] sequence) This method converts an int[] into a byte[].
byte[]	getBytes(int[][] matrix) This method converts a int[][] into a byte[].
byte[]	getBytes(long value) This method converts a long into a byte[].
byte[]	getBytes(long[] sequence) This method converts a long[] into a byte[].
byte[]	getBytes(long[][] matrix) This method converts a long[][] into a byte[].
byte[]	getBytes(java.lang.Object[] sequence) This method converts an Object[] into a byte[].
byte[]	getBytes(short value) This method converts a short into a byte[].
byte[]	getBytes(short[] sequence) This method converts a short[] into a byte[].
byte[]	getBytes(short[][] matrix) This method converts a short[][] into a byte[].
byte[]	getBytes(java.lang.String value) This method converts a String into a byte[].
byte[]	getBytes(java.lang.String[] sequence) This method converts a String[] into a byte[].
double	getDouble(byte[] marshalledBytes) This method converts a byte[] into a double.
double[][]	getDouble2DArray(byte[] marshalledBytes) This method converts a byte[] into a double[][] .
double[]	getDoubleArray(byte[] marshalledBytes) This method converts a byte[] into a double[].
float	getFloat(byte[] marshalledBytes) This method converts a byte[] into a float.
float[][]	getFloat2DArray(byte[] marshalledBytes) This method converts a byte[] into a float[][].
float[]	getFloatArray(byte[] marshalledBytes) This method converts a byte[] into a float[].
java.util.HashMap<?,?>	getHashMap(byte[] marshalledBytes) This method converts a byte[] into a HashMap.
java.util.Hashtable<?,?>	getHashtable(byte[] marshalledBytes) This method converts a byte[] into a Hashtable.
static ResultPayload	getInstance() Deprecated.
int	getInt(byte[] marshalledBytes) This method converts a byte[] into an int.
int[][]	getInt2DArray(byte[] marshalledBytes) This method converts a byte[] into a int[][].
int[]	getIntArray(byte[] marshalledBytes) This method converts a byte[] into an int[].
long	getLong(byte[] marshalledBytes) This method converts a byte[] into a long.
long[][]	getLong2DArray(byte[] marshalledBytes) This method converts a byte[] into a long[][].
long[]	getLongArray(byte[] marshalledBytes) This method converts a byte[] into a long[].
java.lang.Object[]	getObjectArray(byte[] marshalledBytes) This method converts a byte[] into an Object[].
short	getShort(byte[] marshalledBytes) This method converts a byte[] into a short.
short[][]	getShort2DArray(byte[] marshalledBytes) This method converts a byte[] into a short[][].
short[]	getShortArray(byte[] marshalledBytes) This method converts a byte[] into a short[].
java.lang.String	getString(byte[] marshalledBytes) This method converts a byte[] into a String.
java.lang.String[]	getStringArray(byte[] marshalledBytes) This method converts a byte[] into a String[].

Methods inherited from class java.lang.Object

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

Field Detail

INT

public static final int INT

See Also:

Constant Field Values

SHORT

public static final int SHORT

See Also:

Constant Field Values

LONG

public static final int LONG

See Also:

Constant Field Values

DOUBLE

public static final int DOUBLE

See Also:

Constant Field Values

FLOAT

public static final int FLOAT

See Also:

Constant Field Values

STRING

public static final int STRING

See Also:

Constant Field Values

OBJECT

public static final int OBJECT

See Also:

Constant Field Values

HASHTABLE

public static final int HASHTABLE

See Also:

Constant Field Values

HASHMAP

public static final int HASHMAP

See Also:

Constant Field Values

INT_ARRAY

public static final int INT_ARRAY

See Also:

Constant Field Values

SHORT_ARRAY

public static final int SHORT_ARRAY

See Also:

Constant Field Values

LONG_ARRAY

public static final int LONG_ARRAY

See Also:

Constant Field Values

DOUBLE_ARRAY

public static final int DOUBLE_ARRAY

See Also:

Constant Field Values

FLOAT_ARRAY

public static final int FLOAT_ARRAY

See Also:

Constant Field Values

STRING_ARRAY

public static final int STRING_ARRAY

See Also:

Constant Field Values

OBJECT_ARRAY

public static final int OBJECT_ARRAY

See Also:

Constant Field Values

INT_2D_ARRAY

public static final int INT_2D_ARRAY

See Also:

Constant Field Values

SHORT_2D_ARRAY

public static final int SHORT_2D_ARRAY

See Also:

Constant Field Values

LONG_2D_ARRAY

public static final int LONG_2D_ARRAY

See Also:

Constant Field Values

DOUBLE_2D_ARRAY

public static final int DOUBLE_2D_ARRAY

See Also:

Constant Field Values

FLOAT_2D_ARRAY

public static final int FLOAT_2D_ARRAY

See Also:

Constant Field Values

STRING_2D_ARRAY

public static final int STRING_2D_ARRAY

See Also:

Constant Field Values

OBJECT_2D_ARRAY

public static final int OBJECT_2D_ARRAY

See Also:

Constant Field Values

Constructor Detail

ResultPayload

public ResultPayload()

Method Detail

getInstance

@Deprecated
public static ResultPayload getInstance()

Deprecated.

Retrieve the payload instance

Returns:

singleton instance of the ResultPayload.

getBytes

public byte[] getBytes(int value)
                throws MarshallingException

This method converts an int into a byte[].

Parameters:

value - The int to be marshalled into a byte[].

Returns:

byte[] representation of the int.

Throws:

MarshallingException - If there are problems Marshalling the int.

getInt

public int getInt(byte[] marshalledBytes)
           throws MarshallingException

This method converts a byte[] into an int.

Parameters:

marshalledBytes - The byte[] representation of the int

Returns:

The int representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems Unmarshalling the int.

getBytes

public byte[] getBytes(short value)
                throws MarshallingException

This method converts a short into a byte[].

Parameters:

value - The short to be marshalled into a byte[].

Returns:

byte[] representation of the short.

Throws:

MarshallingException - If there are problems Marshalling the short.

getShort

public short getShort(byte[] marshalledBytes)
               throws MarshallingException

This method converts a byte[] into a short.

Parameters:

marshalledBytes - The byte[] representation of the short.

Returns:

The short representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems Unmarshalling the short.

getBytes

public byte[] getBytes(long value)
                throws MarshallingException

This method converts a long into a byte[].

Parameters:

value - The long to be marshalled into a byte[].

Returns:

byte[] representation of the long.

Throws:

MarshallingException - If there are problems Marshalling the long.

getLong

public long getLong(byte[] marshalledBytes)
             throws MarshallingException

This method converts a byte[] into a long.

Parameters:

marshalledBytes - The byte[] representation of the long.

Returns:

The long representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems Unmarshalling the long.

getBytes

public byte[] getBytes(double value)
                throws MarshallingException

This method converts a double into a byte[].

Parameters:

value - The double to be marshalled into a byte[].

Returns:

byte[] representation of the double.

Throws:

MarshallingException - If there are problems Marshalling the double.

getDouble

public double getDouble(byte[] marshalledBytes)
                 throws MarshallingException

This method converts a byte[] into a double.

Parameters:

marshalledBytes - The byte[] representation of the double.

Returns:

The double representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems Unmarshalling the double.

getBytes

public byte[] getBytes(float value)
                throws MarshallingException

This method converts a float into a byte[].

Parameters:

value - The float to be marshalled into a byte[].

Returns:

byte[] representation of the float.

Throws:

MarshallingException - If there are problems Marshalling the float.

getFloat

public float getFloat(byte[] marshalledBytes)
               throws MarshallingException

This method converts a byte[] into a float.

Parameters:

marshalledBytes - The byte[] representation of the float.

Returns:

The float representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems Unmarshalling the float.

getBytes

public byte[] getBytes(java.lang.String value)
                throws MarshallingException

This method converts a String into a byte[].

Parameters:

value - The String to be marshalled into a byte[].

Returns:

byte[] representation of the String.

Throws:

java.lang.NullPointerException - If the specified String is NULL.

MarshallingException - If there are problems Marshalling the String.

getString

public java.lang.String getString(byte[] marshalledBytes)
                           throws MarshallingException

This method converts a byte[] into a String.

Parameters:

marshalledBytes - The byte[] representation of the String.

Returns:

The String representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems unmarshalling the String.

getBytes

public byte[] getBytes(int[] sequence)
                throws MarshallingException

This method converts an int[] into a byte[].

Parameters:

sequence - The int[] to be marshalled into byte[].

Returns:

byte[] representation of the int[]

Throws:

java.lang.NullPointerException - If the specified int[] is NULL.

MarshallingException - If there are problems Marshalling the int[].

getIntArray

public int[] getIntArray(byte[] marshalledBytes)
                  throws MarshallingException

This method converts a byte[] into an int[].

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into an int[].

Returns:

The int[] representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems Unmarshalling the int[].

getBytes

public byte[] getBytes(short[] sequence)
                throws MarshallingException

This method converts a short[] into a byte[].

Parameters:

sequence - The short[] to be marshalled into a byte[].

Returns:

byte[] representation of the short[]

Throws:

java.lang.NullPointerException - If the specified short[] is NULL.

MarshallingException - If there are problems Marshalling the short[].

getShortArray

public short[] getShortArray(byte[] marshalledBytes)
                      throws MarshallingException

This method converts a byte[] into a short[].

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into a short[].

Returns:

The short[] representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems Unmarshalling the short[].

getBytes

public byte[] getBytes(long[] sequence)
                throws MarshallingException

This method converts a long[] into a byte[].

Parameters:

sequence - The long[] to be marshalled into a byte[].

Returns:

byte[] representation of the long[]

Throws:

java.lang.NullPointerException - If the specified long[] is NULL.

MarshallingException - If there are problems Marshalling the long[].

getLongArray

public long[] getLongArray(byte[] marshalledBytes)
                    throws MarshallingException

This method converts a byte[] into a long[].

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into a long[].

Returns:

The long[] representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems Unmarshalling the long[].

getBytes

public byte[] getBytes(double[] sequence)
                throws MarshallingException

This method converts a double[] into a byte[].

Parameters:

sequence - The double[] to be marshalled into a byte[].

Returns:

byte[] representation of the double[]

Throws:

java.lang.NullPointerException - If the specified double[] is NULL.

MarshallingException - If there are problems Marshalling the double[].

getDoubleArray

public double[] getDoubleArray(byte[] marshalledBytes)
                        throws MarshallingException

This method converts a byte[] into a double[].

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into a double[].

Returns:

The double[] representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems Unmarshalling the double[].

getBytes

public byte[] getBytes(float[] sequence)
                throws MarshallingException

This method converts a float[] into a byte[].

Parameters:

sequence - The float[] to be marshalled into a byte[].

Returns:

byte[] representation of the float[]

Throws:

java.lang.NullPointerException - If the specified long[] is NULL.

MarshallingException - If there are problems Marshalling the float[].

getFloatArray

public float[] getFloatArray(byte[] marshalledBytes)
                      throws MarshallingException

This method converts a byte[] into a float[].

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into a float[].

Returns:

The float[] representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems Unmarshalling the float[].

getBytes

public byte[] getBytes(java.lang.String[] sequence)
                throws MarshallingException

This method converts a String[] into a byte[].

Parameters:

sequence - The String[] to be marshalled into a byte[].

Returns:

byte[] representation of the String[]

Throws:

java.lang.NullPointerException - If the specified long[] is NULL.

MarshallingException - If there are problems Marshalling the String[].

getStringArray

public java.lang.String[] getStringArray(byte[] marshalledBytes)
                                  throws MarshallingException

This method converts a byte[] into a String[].

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into a String[].

Returns:

The String[] representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems Unarshalling the String[].

getBytes

public byte[] getBytes(java.util.Hashtable<?,?> sequence)
                throws MarshallingException

This method converts a Hashtable into a byte[].

Parameters:

sequence - The Hashtable to be marshalled into a byte[].

Returns:

byte[] representation of the Hashtable

Throws:

java.lang.NullPointerException - If the specified hashtable is NULL.

MarshallingException - If there are problems Marshalling the hashtable.

getHashtable

public java.util.Hashtable<?,?> getHashtable(byte[] marshalledBytes)
                                      throws MarshallingException

This method converts a byte[] into a Hashtable.

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into a Hashtable.

Returns:

The Hashtable representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems unmarshalling the Hashtable.

getBytes

public byte[] getBytes(java.util.HashMap<?,?> sequence)
                throws MarshallingException

This method converts a HashMap into a byte[].

Parameters:

sequence - The HashMap to be marshalled into a byte[].

Returns:

byte[] representation of the HashMap

Throws:

java.lang.NullPointerException - If the specified hashmap is NULL.

MarshallingException - If there are problems Marshalling the hashmap

getHashMap

public java.util.HashMap<?,?> getHashMap(byte[] marshalledBytes)
                                  throws MarshallingException

This method converts a byte[] into a HashMap.

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into a HashMap.

Returns:

The HashMap representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems unmarshalling the HashMap.

getBytes

public byte[] getBytes(int[][] matrix)
                throws MarshallingException

This method converts a int[][] into a byte[].

Parameters:

matrix - The int[][] to be marshalled into a byte[].

Returns:

byte[] representation of the int[][]

Throws:

java.lang.NullPointerException - If the specified int[][] is NULL.

MarshallingException - If there are problems marshalling the int[][].

getInt2DArray

public int[][] getInt2DArray(byte[] marshalledBytes)
                      throws MarshallingException

This method converts a byte[] into a int[][].

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into a int[][].

Returns:

The int[][] representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems unmarshalling the int[][].

getBytes

public byte[] getBytes(short[][] matrix)
                throws MarshallingException

This method converts a short[][] into a byte[].

Parameters:

matrix - The short[][] to be marshalled into a byte[].

Returns:

byte[] representation of the short[][]

Throws:

java.lang.NullPointerException - If the specified short[][] is NULL.

MarshallingException - If there are problems marshalling the short[][].

getShort2DArray

public short[][] getShort2DArray(byte[] marshalledBytes)
                          throws MarshallingException

This method converts a byte[] into a short[][].

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into a short[][].

Returns:

The short[][] representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems unmarshalling the short[][].

getBytes

public byte[] getBytes(long[][] matrix)
                throws MarshallingException

This method converts a long[][] into a byte[].

Parameters:

matrix - The long[][] to be marshalled into a byte[].

Returns:

byte[] representation of the long[][]

Throws:

java.lang.NullPointerException - If the specified long[][] is NULL.

MarshallingException - If there are problems marshalling the long[][].

getLong2DArray

public long[][] getLong2DArray(byte[] marshalledBytes)
                        throws MarshallingException

This method converts a byte[] into a long[][].

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into a long[][].

Returns:

The long[][] representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems unmarshalling the long[][] .

getBytes

public byte[] getBytes(double[][] matrix)
                throws MarshallingException

This method converts a double[][] into a byte[] .

Parameters:

matrix - The double[][] to be marshalled into a byte[].

Returns:

byte[] representation of the double[][]

Throws:

java.lang.NullPointerException - If the specified double[][] is NULL.

MarshallingException - If there are problems marshalling the double[][] .

getDouble2DArray

public double[][] getDouble2DArray(byte[] marshalledBytes)
                            throws MarshallingException

This method converts a byte[] into a double[][] .

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into a double[][].

Returns:

The double[][] representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems unmarshalling the double[][].

getBytes

public byte[] getBytes(float[][] matrix)
                throws MarshallingException

This method converts a float[][] into a byte[].

Parameters:

matrix - The float[][] to be marshalled into a byte[].

Returns:

byte[] representation of the float[][]

Throws:

java.lang.NullPointerException - If the specified float[][] is NULL.

MarshallingException - If there are problems marshalling the float[][].

getFloat2DArray

public float[][] getFloat2DArray(byte[] marshalledBytes)
                          throws MarshallingException

This method converts a byte[] into a float[][].

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into a float[][].

Returns:

The float[][] representation of the byte[]

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems unmarshalling the float[][].

getBytes

public byte[] getBytes(java.lang.Object[] sequence)
                throws MarshallingException,
                       java.io.IOException

This method converts an Object[] into a byte[].

Parameters:

sequence - The Object[] to be marshalled into a byte[].

Returns:

byte[] representation of the Object[].

Throws:

java.lang.NullPointerException - If the specified Object[] is NULL.

MarshallingException - If there are problems Marshalling the Object[].

java.io.IOException

getObjectArray

public java.lang.Object[] getObjectArray(byte[] marshalledBytes)
                                  throws MarshallingException

This method converts a byte[] into an Object[].

Parameters:

marshalledBytes - The byte[] that needs to be unmarshalled into a Object[].

Returns:

The Object[] representation of the byte[].

Throws:

java.lang.NullPointerException - If the specified byte[] is NULL.

MarshallingException - If there are problems Unmarshalling the Object[].