esa.opensf.osfi

Class Parameter

java.lang.Object

esa.opensf.osfi.Parameter

public final class Parameter
extends java.lang.Object

Parameter.
Represents a model's parameter described in a configuration file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parameter.ParamComplexType Represents the type of a structured parameter.
static class	Parameter.ParamType Represents the element type of a Parameter object.

Constructor Summary

Constructors

Constructor and Description
Parameter(java.lang.String name, java.lang.String description, Parameter.ParamType type, Parameter.ParamComplexType complexType, ArrayNode.Raw rootNode, java.lang.String units, java.lang.String min, java.lang.String max, java.util.List<java.lang.Integer> dims)
Parameter(java.lang.String name, java.lang.String description, Parameter.ParamType type, Parameter.ParamComplexType complexType, java.lang.String value, java.lang.String units, java.lang.String min, java.lang.String max, java.util.List<java.lang.Integer> dims)
Parameter(java.lang.String name, java.lang.String description, java.lang.String type, java.lang.String value)

Method Summary

Modifier and Type	Method and Description
void	addOtherAttribute(java.lang.String key, java.lang.String val) Set an the value of a non-standard parameter attribute.
boolean[][]	fileExist() Check the existence of the files specified within a FILE parameter
boolean	getBooleanValue() Gets the value of the parameter as a boolean.
java.lang.String	getComplexType() Gets the complex type of the parameter.
java.lang.String	getDescription() Gets a brief description of the parameters.
java.util.List<java.lang.Integer>	getDims() Gets a vector with the size of the dimensions.
double	getDoubleValue() Gets the value of the parameter as a floating point number.
Parameter.ParamType	getElementType() Returns the element data type of the parameter, as an enum key.
static java.lang.String	getFileFormattedValue(java.lang.String fileName) Gets the value of the parameter as an array of characters.
java.lang.String	getFileValue() Gets the value of the parameter as a file.
int	getIntValue() Gets the value of the parameter as an integer type.
java.lang.String	getLocalName() Gets the local name of the parameter.
boolean[][]	getMatrixBoolean() Gets the value of the parameter as a Java array-of-arrays of boolean values.
double[][]	getMatrixDouble() Gets the value of the parameter as a Java array-of-arrays of floating point values.
java.lang.String[][]	getMatrixFile() Gets the value of the parameter as a Java array-of-arrays of file values.
int[][]	getMatrixInt() Gets the value of the parameter as a Java array-of-arrays of integer values.
java.lang.String[][]	getMatrixString() Gets the value of the parameter as a Java array-of-arrays of string values.
TimeValue[][]	getMatrixTime() Gets the value of the parameter as a Java array-of-arrays of timecode values.
java.lang.String	getMax() Gets the maximum value of the parameters.
java.lang.String	getMin() Gets the minimum value of the parameters.
java.lang.String	getName() Deprecated. Ambiguous function, instead use getLocalName or getPath
int	getNdims() Gets the number of dimensions.
java.lang.String	getOtherAttribute(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>	getOtherAttributes()
java.lang.String	getPath() Gets the full path of the parameter.
java.lang.String	getRawValue() Gets the unparsed parameter value, as a string.
ArrayNode.Raw	getRootNode() Specific method for Array types.
java.lang.String	getStringValue() Gets the value of the parameter as a string.
TimeValue	getTimeValue() Gets the value of the parameter as a timecode.
java.lang.String	getType() Gets the element data type of the parameter, as a string.
java.lang.String	getUnits() Gets the units of the parameters.
java.lang.String	getValue() Deprecated. Ambiguously-named function to be removed, use getRawValue() instead.
boolean[]	getVectorBoolean() Gets the value of the parameter as a Java array of boolean values.
double[]	getVectorDouble() Gets the value of the parameter as a Java array of floating point values.
java.lang.String[]	getVectorFile() Gets the value of the parameter as a Java array of files.
int[]	getVectorInt() Gets the value of the parameter as a Java array of integer values.
java.lang.String[]	getVectorString() Gets the value of the parameter as a Java array of strings.
TimeValue[]	getVectorTime() Gets the value of the parameter as a Java array of timecode values.
boolean	isArray() Returns true if this parameter is of structured type ARRAY.
void	setValue(java.lang.String value) Sets the parameter value as a string.
void	write() Prints out to standard output a textual description of the parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter(java.lang.String name,
                 java.lang.String description,
                 java.lang.String type,
                 java.lang.String value)

Parameter

public Parameter(java.lang.String name,
                 java.lang.String description,
                 Parameter.ParamType type,
                 Parameter.ParamComplexType complexType,
                 java.lang.String value,
                 java.lang.String units,
                 java.lang.String min,
                 java.lang.String max,
                 java.util.List<java.lang.Integer> dims)

Parameter

public Parameter(java.lang.String name,
                 java.lang.String description,
                 Parameter.ParamType type,
                 Parameter.ParamComplexType complexType,
                 ArrayNode.Raw rootNode,
                 java.lang.String units,
                 java.lang.String min,
                 java.lang.String max,
                 java.util.List<java.lang.Integer> dims)

Method Detail

write

public void write()

Prints out to standard output a textual description of the parameter.

isArray

public boolean isArray()

Returns true if this parameter is of structured type ARRAY. Calling methods in the getVectorX family will "flatten" the array structure to 1D before parsing.

See Also:

getRootNode()

getValue

@Deprecated
public java.lang.String getValue()

Deprecated. Ambiguously-named function to be removed, use getRawValue() instead.

Gets the parameter value as a string.

Returns:

Parameter value.

getRawValue

public java.lang.String getRawValue()

Gets the unparsed parameter value, as a string.

Returns:

Parameter value, unparsed. If an ARRAY-type parameter, returns a structural description of the parameter with the unparsed values.

getIntValue

public int getIntValue()

Gets the value of the parameter as an integer type.

Valid when there is only one value.

Returns:

Parameter value as integer

getDoubleValue

public double getDoubleValue()

Gets the value of the parameter as a floating point number.

Valid when there is only one value.

Returns:

Parameter value as double

getBooleanValue

public boolean getBooleanValue()

Gets the value of the parameter as a boolean.

Valid when there is only one value.

Returns:

Parameter value as boolean

getTimeValue

public TimeValue getTimeValue()

Gets the value of the parameter as a timecode.

Valid when there is only one value.

Returns:

Parameter value as a timecode

getStringValue

public java.lang.String getStringValue()

Gets the value of the parameter as a string.

Valid when there is only one value.

Returns:

Parameter value as a string

getFileValue

public java.lang.String getFileValue()

Gets the value of the parameter as a file.

Valid when there is only one value.

Returns:

Parameter value as a file

getVectorInt

public int[] getVectorInt()

Gets the value of the parameter as a Java array of integer values.

Returns:

Parameter value parsed as a Java array of integers.

getVectorDouble

public double[] getVectorDouble()

Gets the value of the parameter as a Java array of floating point values.

Returns:

Parameter value parsed as a Java array of doubles.

getVectorBoolean

public boolean[] getVectorBoolean()

Gets the value of the parameter as a Java array of boolean values.

Returns:

Parameter value parsed as a Java array of booleans.

getVectorTime

public TimeValue[] getVectorTime()

Gets the value of the parameter as a Java array of timecode values.

Returns:

Parameter value parsed as a Java array of timecodes.

getVectorString

public java.lang.String[] getVectorString()

Gets the value of the parameter as a Java array of strings.

Returns:

Parameter value parsed as a Java array of strings.

getVectorFile

public java.lang.String[] getVectorFile()

Gets the value of the parameter as a Java array of files.

Returns:

Parameter value parsed as a Java array of files.

getMatrixInt

public int[][] getMatrixInt()

Gets the value of the parameter as a Java array-of-arrays of integer values.

Not valid for ARRAY type.

Returns:

Value as matrix of integers.

getMatrixDouble

public double[][] getMatrixDouble()

Gets the value of the parameter as a Java array-of-arrays of floating point values.

Not valid for ARRAY type.

Returns:

Value as matrix of doubles.

getMatrixBoolean

public boolean[][] getMatrixBoolean()

Gets the value of the parameter as a Java array-of-arrays of boolean values.

Not valid for ARRAY type.

Returns:

Value as matrix of booleans.

getMatrixTime

public TimeValue[][] getMatrixTime()

Gets the value of the parameter as a Java array-of-arrays of timecode values.

Not valid for ARRAY type.

Returns:

Value as matrix of timecodes.

getMatrixString

public java.lang.String[][] getMatrixString()

Gets the value of the parameter as a Java array-of-arrays of string values.

Not valid for ARRAY type.

Returns:

Value as matrix of strings.

getMatrixFile

public java.lang.String[][] getMatrixFile()

Gets the value of the parameter as a Java array-of-arrays of file values.

Not valid for ARRAY type.

Returns:

Value as matrix of files.

getRootNode

public ArrayNode.Raw getRootNode()

Specific method for Array types. Return the root node of the values tree. Each node consists of either some data elements or a list of subnodes. They can be parsed individually or in bulk (by depth-first flattening of the tree) into typed values.

See Also:

ArrayNode.Raw

fileExist

public boolean[][] fileExist()

Check the existence of the files specified within a FILE parameter

Note: When the parameter value is a single file name, the boolean is in the first pos [0][0] When the parameter value is a vector of file names, the array is a single row one in horizontal [0][0:vector.size] Not valid for ARRAY type.

Returns:

A matrix with a boolean for each file TRUE → file found, FALSE→file not found A file is considered found when it is correctly located and ready to be read.

getFileFormattedValue

public static java.lang.String getFileFormattedValue(java.lang.String fileName)

Gets the value of the parameter as an array of characters.

Checks the file validity

Parameters:

fileName - String where file path name is stored

Returns:

Parameter value as array of characters.

setValue

public void setValue(java.lang.String value)

Sets the parameter value as a string.

Parameters:

value - Parameter value.

getNdims

public int getNdims()

Gets the number of dimensions.

Returns:

Dimensions number.

getDims

public java.util.List<java.lang.Integer> getDims()

Gets a vector with the size of the dimensions.

Note that, as described in the E2E-ICD, matrix sizes are represented as [nCol, nRow].

Returns:

Vector with dimension sizes.

getName

@Deprecated
public java.lang.String getName()

Deprecated. Ambiguous function, instead use getLocalName or getPath

Gets the name of the parameter.

Returns:

string with the parameter name.

getLocalName

public java.lang.String getLocalName()

Gets the local name of the parameter.

Returns:

string with the local part of the name.

getPath

public java.lang.String getPath()

Gets the full path of the parameter.

Returns:

string with the parameter full path and name.

getDescription

public java.lang.String getDescription()

Gets a brief description of the parameters.

Returns:

string with the description.

getUnits

public java.lang.String getUnits()

Gets the units of the parameters.

Returns:

string with the minimum value.

getMax

public java.lang.String getMax()

Gets the maximum value of the parameters.

Returns:

string with the maximum value.

getMin

public java.lang.String getMin()

Gets the minimum value of the parameters.

Returns:

string with the minimum value.

getType

public java.lang.String getType()

Gets the element data type of the parameter, as a string.

Returns:

String with the type of the parameter.

See Also:

getElementType()

getElementType

public Parameter.ParamType getElementType()

Returns the element data type of the parameter, as an enum key.

getComplexType

public java.lang.String getComplexType()

Gets the complex type of the parameter.

Returns an empty string if complex type is not set.

Returns:

String with the complex type of the parameter.

addOtherAttribute

public void addOtherAttribute(java.lang.String key,
                              java.lang.String val)

Set an the value of a non-standard parameter attribute.

Parameters:

key - attribute name

val - attribute value

getOtherAttributes

public java.util.Map<java.lang.String,java.lang.String> getOtherAttributes()

Returns:

a copy of the map of non-standard attributes and their values.

getOtherAttribute

public java.lang.String getOtherAttribute(java.lang.String key)

Returns:

the value of the given non-standard attribute, or null if not present.