Public Member Functions
	ParamParserComplex (final Element paramNode, final String paramPath) throws ParamParsingException

ParamType	getType ()

String	getMatrixValue ()

ArrayNode.Raw	getRootNode ()

List< Integer >	getListDims ()

ParamComplexType	getComplexType ()

java.util.Map< String, String >	getExtraAttrs ()

Static Public Attributes
static final String	EXTATTR_PATHSEP = "!"

Detailed Description

Helper class used by ParamReader to process the values of structured parameters.

Constructor & Destructor Documentation

◆ ParamParserComplex()

esa.opensf.osfi.ParamParserComplex.ParamParserComplex	(	final Element	paramNode,
		final String	paramPath
	)		throws ParamParsingException

Parse the data in the given XML element, which represents a parameter with a structured type.

Parameters

paramNode	Must represent a parameter with type ParamComplexType#MATRIX or ParamComplexType#ARRAY.
paramPath	Non-null, dot-separated path of this element, including the param itself.

Exceptions

ParamParsingException If the parameter is malformed. This is the only exception that may be thrown by this method, other unchecked exceptions are wrapped in this.

Member Function Documentation

◆ getComplexType()

ParamComplexType esa.opensf.osfi.ParamParserComplex.getComplexType ( )

Returns: the type of structured parameter, ARRAY or MATRIX.

◆ getExtraAttrs()

java.util.Map<String, String> esa.opensf.osfi.ParamParserComplex.getExtraAttrs ( )

Returns: the map of extra attributes on the parameter and its subnodes

◆ getListDims()

List<Integer> esa.opensf.osfi.ParamParserComplex.getListDims ( )

Returns: the dimensions of the parameter (for ARRAY parameters, the rectangular envelope).

◆ getMatrixValue()

String esa.opensf.osfi.ParamParserComplex.getMatrixValue ( )

Returns: the parameter value, or null if this parameter is not of type MATRIX.

◆ getRootNode()

ArrayNode.Raw esa.opensf.osfi.ParamParserComplex.getRootNode ( )

Returns: the root node, or null if this parameter is not of type ARRAY.

◆ getType()

ParamType esa.opensf.osfi.ParamParserComplex.getType ( )

Returns: the parsed element type of the parameter. Never null.

Member Data Documentation

◆ EXTATTR_PATHSEP

final String esa.opensf.osfi.ParamParserComplex.EXTATTR_PATHSEP = "!"

static

Separator for the names of extra attributes which include the path of a sub-element. Not a valid XML name character.

The documentation for this class was generated from the following file:

src/Java/esa/opensf/osfi/ParamParserComplex.java

Public Member Functions

Static Public Attributes