com.mathworks.mps.client.internal

Class JavaDataExtractor

java.lang.Object

com.mathworks.mps.client.internal.JavaDataExtractor

public class JavaDataExtractor
extends Object

Uses contents of MATLAB_Array protobuf message to create a Java output conforming to the type and dimension of the user specified target Java type. The protobuf message represents a MATLAB response and the goal of this class is to hide MATLAB specific information from the Java programmer and present the MATLAB response in the form of target Java type provided by the user. The target type and its dimension must be compatible to the MATLAB data type and dimension information contained in the protobuf message.

Constructor Summary

Constructors

Constructor and Description
JavaDataExtractor(MWAttributesContainer mwAttributesContainer)

Method Summary

Modifier and Type	Method and Description
Object	MATLABArrayToJavaCell(MATLABArray.MATLAB_Array mlArray, Class targetType, Map<MWStructInfo,MWStructToBeanFactory> structToBeanFactoryCache) Convert a MATLAB_Array protobuf message containing MATLAB cell array into target Java type.
static Object	MATLABArrayToJavaPrimitives(MATLABArray.MATLAB_Array mlArray, Class targetType, MATLABArray.MATLAB_Array.MWType mwType) The common routine that takes care of conversion of MATLAB primitive data into appropriate Java type.
Object	MATLABArrayToJavaStruct(MATLABArray.MATLAB_Array mlArray, Class targetType, Map<MWStructInfo,MWStructToBeanFactory> structToBeanFactoryCache) Convert a MATLAB_Array protobuf message containing a MATLAB struct into an appropriate user defined Java class with dimensions matching those of targetType
static Object	MATLABCharArrayToJava(MATLABArray.MATLAB_Array mlArr, int[] dimArr, Class targetType) Convert char MATLAB_Array protobuf message into Java char array or java.lang.String
static Object	MATLABDoubleArrayToJava(MATLABArray.MATLAB_Array mlArr, int[] dimArr, Class targetType, Class targetTypeScalar, MATLABArray.MATLAB_Array.MWType mwType) Convert double MATLAB_Array protobuf message into Java double array
static Object	MATLABInt16ArrayToJava(MATLABArray.MATLAB_Array mlArr, int[] dimArr, Class targetType, Class targetTypeScalar, MATLABArray.MATLAB_Array.MWType mwType) Convert int16 MATLAB_Array protobuf message into Java short array
static Object	MATLABInt32ArrayToJava(MATLABArray.MATLAB_Array mlArr, int[] dimArr, Class targetType, Class targetTypeScalar, MATLABArray.MATLAB_Array.MWType mwType) Convert int32 MATLAB_Array protobuf message into Java int array
static Object	MATLABInt64ArrayToJava(MATLABArray.MATLAB_Array mlArr, int[] dimArr, Class targetType, Class targetTypeScalar, MATLABArray.MATLAB_Array.MWType mwType) Convert int64 MATLAB_Array protobuf message into Java long array
static Object	MATLABInt8ArrayToJava(MATLABArray.MATLAB_Array mlArr, int[] dimArr, Class targetType, Class targetTypeScalar, MATLABArray.MATLAB_Array.MWType mwType) Convert int8 MATLAB_Array protobuf message into Java byte array
static Object	MATLABLogicalArrayToJava(MATLABArray.MATLAB_Array mlArr, int[] dimArr, Class targetType, Class targetTypeScalar, MATLABArray.MATLAB_Array.MWType mwType) Convert logical MATLAB_Array protobuf message into Java boolean array
static Object	MATLABSingleArrayToJava(MATLABArray.MATLAB_Array mlArr, int[] dimArr, Class targetType, Class targetTypeScalar, MATLABArray.MATLAB_Array.MWType mwType) Convert single MATLAB_Array protobuf message into Java float array
static Object	MATLABUint16ArrayToJava(MATLABArray.MATLAB_Array mlArr, int[] dimArr, Class targetType, Class targetTypeScalar, MATLABArray.MATLAB_Array.MWType mwType) Convert uint16 MATLAB_Array protobuf message into Java short array
static Object	MATLABUint32ArrayToJava(MATLABArray.MATLAB_Array mlArr, int[] dimArr, Class targetType, Class targetTypeScalar, MATLABArray.MATLAB_Array.MWType mwType) Convert uint32 MATLAB_Array protobuf message into Java int array
static Object	MATLABUint64ArrayToJava(MATLABArray.MATLAB_Array mlArr, int[] dimArr, Class targetType, Class targetTypeScalar, MATLABArray.MATLAB_Array.MWType mwType) Convert uint64 MATLAB_Array protobuf message into Java long array
static Object	MATLABUint8ArrayToJava(MATLABArray.MATLAB_Array mlArr, int[] dimArr, Class targetType, Class targetTypeScalar, MATLABArray.MATLAB_Array.MWType mwType) Convert uint8 MATLAB_Array protobuf message into Java byte array
Object	toJavaType(MATLABArray.MATLAB_Array mlArray, Class targetType) Convert MATLAB_Array protobuf message into user specified target Java type.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaDataExtractor

public JavaDataExtractor(MWAttributesContainer mwAttributesContainer)

Method Detail

toJavaType

public Object toJavaType(MATLABArray.MATLAB_Array mlArray,
                         Class targetType)

Convert MATLAB_Array protobuf message into user specified target Java type. The protobuf message contains MATLAB response and has information like MATLAB data type, data dimensions and actual data. MATLAB structure is a special data type and for converting it into a Java type more information is needed which is contained in the Map that's passed in as the last input to this method. Following are the MATLAB to JAVA conversion rules that this function follows: NOTE: For more information on the conversion of MATLAB struct into a user defined Java type, please refer the overview page of the javadoc. It also discusses other aspects of data conversion like dimension coercion, handling empty data received from MATLAB, limitations, etc.

What MATLAB returns	Dimension of data in MATLAB	Declared Java return type must be assignable from
int8, unit8	{1,1}	byte, java.lang.Byte
	{1,n}	byte[n], java.lang.Byte[n]
	{m,n,p,...}	byte[m][n][p]... , java.lang.Byte[m][n][p]...
int16, unit16	{1,1}	short, java.lang.Short
	{1,n}	short[n], java.lang.Short[n]
	{m,n,p,...}	short[m][n][p]... , java.lang.Short[m][n][p]...
int32, unit32	{1,1}	int, java.lang.Integer
	{1,n}	int[n], java.lang.Integer[n]
	{m,n,p,...}	int[m][n][p]... , java.lang.Integer[m][n][p]...
int64, unit64	{1,1}	long, java.lang.Long
	{1,n}	long[n], java.lang.Long[n]
	{m,n,p,...}	long[m][n][p]... , java.lang.Long[m][n][p]...
single	{1,1}	float, java.lang.Float
	{1,n}	float[n], java.lang.Float[n]
	{m,n,p,...}	float[m][n][p]... , java.lang.Float[m][n][p]...
double	{1,1}	double, java.lang.Double
	{1,n}	double[n], java.lang.Double[n]
	{m,n,p,...}	double[m][n][p]... , java.lang.Double[m][n][p]...
logical	{1,1}	boolean, java.lang.Boolean
	{1,n}	boolean[n], java.lang.Boolean[n]
	{m,n,p,...}	boolean[m][n][p]... , java.lang.Boolean[m][n][p]...
char	{1,1}	char, java.lang.Character
	{1,n}	java.lang.String
	{m,n,p,...}	char[m][n][p]... , java.lang.Character[m][n][p]...
cell (containing only strings)	{1,1}	java.lang.String
	{1,n}	java.lang.String[n]
	{m,n,p,...}	java.lang.String[m][n][p]...
cell (containing multiple types)	{1,1}	java.lang.Object
	{1,n}	java.lang.Object[n]
	{m,n,p,...}	java.lang.Object[m][n][p]...

Parameters:

mlArray - MATLABArray.MATLAB_Array protobuf message

targetType - Class of the target data type

Returns:

JAVA data contained in the protobuf message

MATLABArrayToJavaStruct

public Object MATLABArrayToJavaStruct(MATLABArray.MATLAB_Array mlArray,
                                      Class targetType,
                                      Map<MWStructInfo,MWStructToBeanFactory> structToBeanFactoryCache)

Convert a MATLAB_Array protobuf message containing a MATLAB struct into an appropriate user defined Java class with dimensions matching those of targetType

Parameters:

mlArray - MATLAB_Array protobuf message containing MATLAB structure

targetType - Java target for MATLAB structure

structToBeanFactoryCache - container of factory objects which can be used to convert a MATLAB structure into user defined class instance

Returns:

array of a user defined object that represents MATLAB structure

MATLABArrayToJavaCell

public Object MATLABArrayToJavaCell(MATLABArray.MATLAB_Array mlArray,
                                    Class targetType,
                                    Map<MWStructInfo,MWStructToBeanFactory> structToBeanFactoryCache)

Convert a MATLAB_Array protobuf message containing MATLAB cell array into target Java type. The cell array can be a generic cell array containing MATLAB data of varied types or it can be a cell array containing only strings. For a MATLAB cell array containing generic MATLAB data, the target type has to be an array of java.lang.Object. If it's a cell array containing only strings, the target type can be either an array of java.lang.Object or java.lang.String.

Parameters:

mlArray - MATLAB_Array protobuf message containing MATLAB cell array

targetType - target type in Java to hold cell array

structToBeanFactoryCache - container of factory objects which can be used to convert a MATLAB structure into user defined class instance

Returns:

array of either java.lang.Object or java.lang.String representing MATLAB cell array

MATLABArrayToJavaPrimitives

public static Object MATLABArrayToJavaPrimitives(MATLABArray.MATLAB_Array mlArray,
                                                 Class targetType,
                                                 MATLABArray.MATLAB_Array.MWType mwType)

The common routine that takes care of conversion of MATLAB primitive data into appropriate Java type. This routine uses reflection to check the type of MATLAB data and then delegates the work to the appropriate function specific to a given MATLAB type.

Parameters:

mlArray - MATLAB_Array protobuf messaage containing MATLAB primitive data

targetType - target Java type that the MATLAB data needs to be converted into

Returns:

Java primitive data corresponding the MATLAB response

MATLABUint8ArrayToJava

public static Object MATLABUint8ArrayToJava(MATLABArray.MATLAB_Array mlArr,
                                            int[] dimArr,
                                            Class targetType,
                                            Class targetTypeScalar,
                                            MATLABArray.MATLAB_Array.MWType mwType)

Convert uint8 MATLAB_Array protobuf message into Java byte array

Parameters:

mlArr - MATLAB_Array protobuf message representing uint8 MATLAB data

dimArr - dimensions of the target Java data

targetType - convertible target type corresponding to MATLAB uint8 data

Returns:

Java data corresponding to MATLAB uint8 data

MATLABInt8ArrayToJava

public static Object MATLABInt8ArrayToJava(MATLABArray.MATLAB_Array mlArr,
                                           int[] dimArr,
                                           Class targetType,
                                           Class targetTypeScalar,
                                           MATLABArray.MATLAB_Array.MWType mwType)

Convert int8 MATLAB_Array protobuf message into Java byte array

Parameters:

mlArr - MATLAB_Array protobuf message representing int8 MATLAB data

dimArr - dimensions of the target Java data

targetType - convertible target type corresponding to MATLAB int8 data

Returns:

Java data corresponding to MATLAB int8 data

MATLABUint16ArrayToJava

public static Object MATLABUint16ArrayToJava(MATLABArray.MATLAB_Array mlArr,
                                             int[] dimArr,
                                             Class targetType,
                                             Class targetTypeScalar,
                                             MATLABArray.MATLAB_Array.MWType mwType)

Convert uint16 MATLAB_Array protobuf message into Java short array

Parameters:

mlArr - MATLAB_Array protobuf message representing uint16 MATLAB data

dimArr - dimensions of the target Java data

targetType - convertible target type corresponding to MATLAB uint16 data

Returns:

Java data corresponding to MATLAB uint16 data

MATLABInt16ArrayToJava

public static Object MATLABInt16ArrayToJava(MATLABArray.MATLAB_Array mlArr,
                                            int[] dimArr,
                                            Class targetType,
                                            Class targetTypeScalar,
                                            MATLABArray.MATLAB_Array.MWType mwType)

Convert int16 MATLAB_Array protobuf message into Java short array

Parameters:

mlArr - MATLAB_Array protobuf message representing int16 MATLAB data

dimArr - dimensions of the target Java data

targetType - convertible target type corresponding to MATLAB int16 data

Returns:

Java data corresponding to MATLAB int16 data

MATLABUint32ArrayToJava

public static Object MATLABUint32ArrayToJava(MATLABArray.MATLAB_Array mlArr,
                                             int[] dimArr,
                                             Class targetType,
                                             Class targetTypeScalar,
                                             MATLABArray.MATLAB_Array.MWType mwType)

Convert uint32 MATLAB_Array protobuf message into Java int array

Parameters:

mlArr - MATLAB_Array protobuf message representing uint32 MATLAB data

dimArr - dimensions of the target Java data

targetType - convertible target type corresponding to MATLAB uint32 data

Returns:

Java data corresponding to MATLAB uint32 data

MATLABInt32ArrayToJava

public static Object MATLABInt32ArrayToJava(MATLABArray.MATLAB_Array mlArr,
                                            int[] dimArr,
                                            Class targetType,
                                            Class targetTypeScalar,
                                            MATLABArray.MATLAB_Array.MWType mwType)

Convert int32 MATLAB_Array protobuf message into Java int array

Parameters:

mlArr - MATLAB_Array protobuf message representing int32 MATLAB data

dimArr - dimensions of the target Java data

targetType - convertible target type corresponding to MATLAB int32 data

Returns:

Java data corresponding to MATLAB int32 data

MATLABUint64ArrayToJava

public static Object MATLABUint64ArrayToJava(MATLABArray.MATLAB_Array mlArr,
                                             int[] dimArr,
                                             Class targetType,
                                             Class targetTypeScalar,
                                             MATLABArray.MATLAB_Array.MWType mwType)

Convert uint64 MATLAB_Array protobuf message into Java long array

Parameters:

mlArr - MATLAB_Array protobuf message representing uint64 MATLAB data

dimArr - dimensions of the target Java data

targetType - convertible target type corresponding to MATLAB uint64 data

Returns:

Java data corresponding to MATLAB uint64 data

MATLABInt64ArrayToJava

public static Object MATLABInt64ArrayToJava(MATLABArray.MATLAB_Array mlArr,
                                            int[] dimArr,
                                            Class targetType,
                                            Class targetTypeScalar,
                                            MATLABArray.MATLAB_Array.MWType mwType)

Convert int64 MATLAB_Array protobuf message into Java long array

Parameters:

mlArr - MATLAB_Array protobuf message representing int64 MATLAB data

dimArr - dimensions of the target Java data

targetType - convertible target type corresponding to MATLAB int64 data

Returns:

Java data corresponding to MATLAB int64 data

MATLABSingleArrayToJava

public static Object MATLABSingleArrayToJava(MATLABArray.MATLAB_Array mlArr,
                                             int[] dimArr,
                                             Class targetType,
                                             Class targetTypeScalar,
                                             MATLABArray.MATLAB_Array.MWType mwType)

Convert single MATLAB_Array protobuf message into Java float array

Parameters:

mlArr - MATLAB_Array protobuf message representing single MATLAB data

dimArr - dimensions of the target Java data

targetType - convertible target type corresponding to MATLAB single data

Returns:

Java data corresponding to MATLAB single data

MATLABDoubleArrayToJava

public static Object MATLABDoubleArrayToJava(MATLABArray.MATLAB_Array mlArr,
                                             int[] dimArr,
                                             Class targetType,
                                             Class targetTypeScalar,
                                             MATLABArray.MATLAB_Array.MWType mwType)

Convert double MATLAB_Array protobuf message into Java double array

Parameters:

mlArr - MATLAB_Array protobuf message representing double MATLAB data

dimArr - dimensions of the target Java data

targetType - convertible target type corresponding to MATLAB double data

Returns:

Java data corresponding to MATLAB double data

MATLABLogicalArrayToJava

public static Object MATLABLogicalArrayToJava(MATLABArray.MATLAB_Array mlArr,
                                              int[] dimArr,
                                              Class targetType,
                                              Class targetTypeScalar,
                                              MATLABArray.MATLAB_Array.MWType mwType)

Convert logical MATLAB_Array protobuf message into Java boolean array

Parameters:

mlArr - MATLAB_Array protobuf message representing logical MATLAB data

dimArr - dimensions of the target Java data

targetType - convertible target type corresponding to MATLAB boolean data

Returns:

Java data corresponding to MATLAB boolean data

MATLABCharArrayToJava

public static Object MATLABCharArrayToJava(MATLABArray.MATLAB_Array mlArr,
                                           int[] dimArr,
                                           Class targetType)

Convert char MATLAB_Array protobuf message into Java char array or java.lang.String

Parameters:

mlArr - MATLAB_Array protobuf message representing char MATLAB data

dimArr - dimensions of the target Java data

targetType - convertible target type corresponding to MATLAB char data

Returns:

Java data corresponding to MATLAB char data