Michael Thomas Flanagan's Java Scientific Library: Data type

Michael Thomas Flanagan's Java Scientific Library

DateType Class: Identification of Data Type

Last update of this class: 11 April 2012
Main Page of Michael Thomas Flanagan's Java Scientific Library

This class contains methods for:

returning the name of an Object, e.g. double[][] is returned for a two dimensional array of doubles
returning the dimension of an Object, e.g. 3 is returned for a three dimensional array of Floats
returning a code of an Object as described below.
if the entered Object is an ArrayList, an ArrayDeque, a LinkedList, an Object[] or a Vector:
- returning the names of all elements of the entered Object
- returning the dimensions of all elements of the entered Object
- returning the codes of all elements of the entered Object
- returning the name of the highest precision element of the entered Object
- returning the code of the highest precision element of the entered Object
- returning an array of all the elements of the entered Object converted to the type of highest precision present
- returning an array of all the elements of the entered Object converted to the type double
- returning an array of all the elements of the entered Object converted to the type BigDecimal
- returning an array of all the elements of the entered Object converted to the type String

import directive: import flanagan.math.DataType;

Summary table of methods
Listing of the source code (Last update: 11 April 2012)
Other classes, in this library, used by this class
Main Page of Michael Thomas Flanagan's Java Scientific Library

SUMMARY OF METHODS

Constructor		public DataType(Object obj)
Identify entered Object	Get the Object name	public String getTypeName()	public static String getTypeName(Object obj)
	Get the Object dimension	public int getTypeDimension()	public static int getTypeDimension(Object obj)
	Get the Object code	public int getTypeCode()	public static int getTypeCode(Object obj)
	Get all above data	public Object[] getTypeData()	public static Object[] getTypeData(Object obj)
Analysis of Object elements if entered Object is ArrayList ArrayDeque LinkedList Object[] or Vector	Get the element names	public String[] getArrayNames()	public static String[] getArrayNames(Object obj)
	Get the element dimensions	public int[] getArrayDimensions()	public static int[] getArrayDimensions(Object obj)
	Get the element codes	public int[] getArrayCodes()	public static int[] getArrayCodes(Object obj)
	Get all above array data	public ArrayList<Object> getArrayData()	public static ArrayList<Object> getArrayData(Object obj)
	Highest precision name present	public String highestPrecisionName()	public static String highestPrecisionName(Object obj)
	Highest precision code present	public int highestPrecisionCode()	public static int highestPrecisionCode(Object obj)
	Convert to highest precision present	public Object convert_to_highestPrecision()	public static Object convert_to_highestPrecision(Object obj)
	Convert to double	public double[] convert_to_double()	public static double[] convert_to_double(Object obj)
	Convert to BigDecimal	public BigDecimal[] convert_to_BigDecimal()	public static BigDecimal[] convert_to_BigDecimal(Object obj)
	Convert to String	public String[] convert_to_String()	public static String[] convert_to_String(Object obj)

CONSTRUCTOR

public DataType(Object obj)
Usage: DataType dt = new DataType(obj);
Creates an instance of dataType. The entered Object, obj, may be any Object.

IDENTIFICATION OF THE ENTERED Object

String 0	BigDecimal 1	BigInteger 2	Double 3	Float 4	Long 5	Integer 6	Character 7
Short 8	Byte 9	Boolean 10	Object 11	ArrayList 12	LinkedList 13	ArrayDeque 14	Vector 15
Complex 16	Phasor 17	ErrorProp 18	ComplexErrorProp 19	Matrix 20	ComplexMatrix 21	PhasorMatrix 22	Polynomial 23
ComplexPoly 24	ArrayMaths 25	VectorMaths 26	Point 27	BlackBox 28	OpenLoop 29	ClosedLoop 30	Prop 31
PropDeriv 32	PropInt 33	PropIntDeriv 34	FirstOrder 35	SecondOrder 36	Compensator 37	LowPassPassive 38	HighPassPassive 39
DelayLine 40	ZeroOrderHold 41	Transducer 42	AtoD 43	DtoA 44

If the entered Object is not one of those listed in the above table a code of -1 is returned.

Usage: code = DataType.getTypeCode(obj);
This method is the static equivalent of the above instance method, getTypeCode();.

Get all above data
public Object[] getTypeData()
public static Object[] getTypeData(Object obj)
Usage: data = DataType.getTypeData(obj);
This method returns all the data described in the above three methods as an Object array of three elements. In the above usage

data[0] contains the entered Object type name as a String cast as Object
data[1] contains the entered Object dimension as a Integer cast as Object
data21] contains the entered Object code as a Integer cast as Object

Usage: code = DataType.getTypeData(obj);
This method is the static equivalent of the above instance method, getTypeData();.

ANALYSIS OF Object ELEMENTS

These methods may be called if the entered Object is an ArrayList, an ArrayDeque, a LinkedList, an Object[] or a Vector.
They return null if the entered Object is not one of the above.

Get the element names
public String[] getArrayNames()
public static String[] getArrayNames(Object obj)
Usage:                      names = dt.getArrayNames();
Returns the names of the elements of the Object, entered via the constructor, as the elements of a String array in which each element type name appears in the order of the Object elements. Each element is a String in which the element name is folowed by the dimensions indicated by the [] symbol, e.g. double[][] would be returned if the element was a two dimensional array of doubles. No [] symbols are included if the array is not a dimensioned Object, e.g. ArrayList would be returned if the element was a single ArrayList. The entered Object must be an ArrayList, an ArrayDeque, a LinkedList, an Object[] or a Vector. If the entered Object is not one of the these Objects null is returned.

Usage:                      names = DataType.getArrayNames(obj);
This method is the static equivalent of the above instance method, getArrayNames();.

Get the element dimensions
public int[] getArrayDimensions()
public static int[] getArrayDimensions(Object obj)
Usage:                      names = dt.getArrayDimensions();
Returns the dimensions of the elements of the Object, entered via the constructor, as the elements of an int array in which each element dimension appears in the order of the Object elements. Each element of the returned array is an int, e.g. would contain the integer 3 if the relevant element the entered Object was a three dimensional array, e.g. Float[][][]. 0 is returned if the element is not a dimensioned Object e.g. a single ArrayList. The entered Object must be an ArrayList, an ArrayDeque, a LinkedList, an Object[] or a Vector. If the entered Object is not one of the these Objects null is returned.

Usage:                      names = DataType.getArrayDimensions(obj);
This method is the static equivalent of the above instance method, getArrayDimensions();.

Get the element codes
public int[] getArrayCodes()
public static int[] getArrayCodes(Object obj)
Usage:                      names = dt.getArrayCodes();
Returns the codes of the elements of the Object, entered via the constructor, as the elements of an int array in which each element code appears in the order of the Object elements. The code is described above under the method getArrayCodes(). The entered Object must be an ArrayList, an ArrayDeque, a LinkedList, an Object[] or a Vector. If the entered Object is not one of the these Objects null is returned.

Usage:                      names = DataType.getArrayCodes(obj);
This method is the static equivalent of the above instance method, getArrayCodes();.

Get all above array data
public ArrayList<Object> getArrayData()
public static ArrayList<Object> getArrayData(Object obj)
        data = DataType.getArrayData(obj);
This method returns all the data described in the above three methods as an ArrayList. In the above usage

first element of data is a String array of the element type names
second element of data is a int array of the element dimensions
third element of data is a int array of the element codes

The entered Object must be an ArrayList, an ArrayDeque, a LinkedList, an Object[] or a Vector. If the entered Object is not one of the these Objects the data elements will all be null.

Usage: code = DataType.getArrayData(obj);
This method is the static equivalent of the above instance method, getArrayData();.

Highest precision name present
public String highestPrecisionName()
public static String highestPrecisionName(Object obj)
Usage: hname = dt.highestPrecisionName();
This method returns the name of the highest precision element in the entered Object. The order of decreasing precision used is:

BigDecimal
BigInteger
Double
Float
Long
Integer
Short
Byte

Before checking the precision

String is converted to the highest precision type present in the String
Character is converted to the matching unicode Integer

OTHER CLASSES USED BY THIS CLASS

This class uses the following classes in this library:

none

This page was prepared by Dr Michael Thomas Flanagan