Package com.tailf.navu

Class NavuParser

Object

com.tailf.navu.NavuParser

public class NavuParser
extends Object

XML parser capable of producing a ConfXMLParam[] from an xml snippet.

The XML input can be provided in two forms:

• A complete fragment rooted at the start node, e.g. <server xmlns="..."><name>s1</name></server>
• A fragment of the children only, e.g. <name>s1</name>

In both cases, the start node identifies the root schema node. The parser normalizes the input internally so that both forms produce the same result.

Normally this class should not be used directly, instead NavuNode.getValues(String), NavuNode.setValues(String) and PreparedXMLStatement will give necessary support for xml snippets.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MODE_GET	parse xml as preparation for a getValues call
static final int	MODE_SET	parse xml as preparation for a setValues call
static final int	MODE_SET_ACTION_PARAM	parse xml as preparation for a setValues() call for action's or rpc's parameters
static final int	MODE_SET_ACTION_RESULT	parse xml as preparation for a setValues() call for action's or rpc's result
static final int	MODE_SET_PREPARE	parse xml with "?" arguments as preparation for a setValues call

Constructor Summary

Constructors

Constructor	Description
NavuParser(String xml, MaapiSchemas.CSNode node, ConfPath path, int mode)	Constructor for the XML parser.

Method Summary

Modifier and Type	Method	Description
Map<Integer,Object[]>	getParamIndexes()	Helper array for parser mode MODE_SET_PREPARE needed to superpose "?" arguments.
ConfXMLParam[]	parse()	Parses the xml and produces ConfXMLParam[]

Methods inherited from class java.lang.Object

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

Field Details

MODE_GET

public static final int MODE_GET

parse xml as preparation for a getValues call

See Also:

• Constant Field Values

MODE_SET

public static final int MODE_SET

parse xml as preparation for a setValues call

See Also:

• Constant Field Values

MODE_SET_PREPARE

public static final int MODE_SET_PREPARE

parse xml with "?" arguments as preparation for a setValues call

See Also:

• Constant Field Values

MODE_SET_ACTION_PARAM

public static final int MODE_SET_ACTION_PARAM

parse xml as preparation for a setValues() call for action's or rpc's parameters

See Also:

• Constant Field Values

MODE_SET_ACTION_RESULT

public static final int MODE_SET_ACTION_RESULT

parse xml as preparation for a setValues() call for action's or rpc's result

See Also:

• Constant Field Values

Constructor Details

NavuParser

public NavuParser(String xml,
 MaapiSchemas.CSNode node,
 ConfPath path,
 int mode)
           throws NavuException

Constructor for the XML parser.

The xml snippet may optionally include a root tag corresponding to the start CSNode. If present, it is treated as a wrapper and stripped. If absent, the snippet is assumed to contain the children of the start node directly.

Exception: if the start node has a child with the same name (e.g. container parent { container parent {...} }), the element is only stripped as a wrapper when its XML children belong to the start node's schema. Otherwise it is kept as content for the same-name child. The parser works in one of five modes:

• MODE_GET

  Parsing the xml as preparation for a NavuNode.getValues(ConfXMLParam[]) request.

• MODE_SET

  Parsing the xml as preparation for a NavuNode.setValues(ConfXMLParam[]) request.

• MODE_SET_PREPARE

  Parsing the xml as preparation for a NavuNode.setValues(ConfXMLParam[]) request. In this mode the xml snippet is expected to contain "?" as leaf values to be superposed before using the output. This superposing is handled by the PreparedXMLStatement class which should be used in this case

• MODE_SET_ACTION_PARAM

  Parsing the xml as preparation for a NavuNode.setValues(ConfXMLParam[]) request. In this mode the xml is an action's or rpc's parameters

• MODE_SET_ACTION_RESULT

  Parsing the xml as preparation for a NavuNode.setValues(ConfXMLParam[]) request. In this mode the xml is an action's or rpc's result

Parameters:

xml - the xml snippet

node - the root node start parsing from

mode - one of MODE_GET, MODE_SET, MODE_SET_PREPARE, MODE_SET_ACTION_PARAM or MODE_SET_ACTION_RESULT

Throws:

NavuException

Method Details

parse

public ConfXMLParam[] parse()
                     throws NavuException

Parses the xml and produces ConfXMLParam[]

Returns:

ConfXMLParam[] array corresponding to the xml snippet.

Throws:

NavuException

getParamIndexes

public Map<Integer,Object[]> getParamIndexes()

Helper array for parser mode MODE_SET_PREPARE needed to superpose "?" arguments.