NavuNode (CONF API Version 6.4)

Object
- com.tailf.navu.NavuNode

Direct Known Subclasses:

NavuAction, NavuContainer, NavuLeaf, NavuList
```
public abstract class NavuNode
extends Object
```
This class provides the base class for all navigation classes like NavuContainer, NavuList, NavuLeaf etc.
A NavuNode could explicitly be retrieved through getNavuNode(ConfPath).
```
   //attach to MAAPI context
   NavuContainer root = new NavuContainer(new Navu2Context(maapi,th));
   NavuNode node =
      root.getNavuNode(
        new ConfPath("/ncs:devices/device{device0}/config"));

  
```
Implementations of this interface represents YANG constructs that is either a containment element container,list, leaf that holds values or as tailf:action which represents an action in the data model.
The interface specifies minimum requirement that a NavuNode should implement. To extend the functionality of the NavuNode a explicit cast must be performed.
```
        NavuNode node = ...;
            if(node.getInfo().isAction())
               NavuAction theAction = (NavuAction)node;
               theAction.call();

       //or
            if(node instanceof NavuAction)
              NavuAction theAction = (NavuAction)node;
              theAction.call();
       
```
The methods in this interface is divided up in three types of categories.
- Navigational methods. Basic navigational methods container(String),leaf(String), list(String) each retrieves the adjacent NavuNode in the next level.
  getParent() retrieve the NavuNode for the previous level (parent node). To retrieve all the children elements in the next level for a given NavuNode children() returns a Collection of NavuNode's.
  For retrieving descendants for a (based on some regular expression) for a NavuNode select could be used.
- Informational methods. Provide information for a NavuNode. getInfo(),getKeyPath(),getName(), getRootNS().
- Context specific methods. This means that certain types of methods is used based on the current attached context. The current context is retrieved through context() method.
  if(node.context().isMaapi()) //node is in MAAPI context else if(node.context().isCdbSession()) //CDB context
  getChangeFlag()/getCdbSession()/getChanges() for MAAPI context. and getCdbSession() for CDB context.
- Data retrieving methods. Which extract/reads values with getValues().
There are also methods that does not fall into the above categories: encodeXML() that is helpful method in conjunction with getValues() to extract a sub-tree.
Context specific methods like startCdbSession()/startCdbSession() to start new CDBSession from a current NavuNode. set() which sets a value to a leaf element.

Constructor Summary

Constructors
Constructor and Description

NavuNode()

Constructors
Constructor and Description
`NavuNode()`

Method Summary

Methods
Modifier and Type	Method and Description
`Collection<NavuNode>`	`children()` Return the children of this NavuNode.
`NavuContainer`	`container(Integer key)` Returns a subordinate reference to a container according to the given hash value.
`NavuContainer`	`container(String key)` Returns a subordinate reference to `NavuNode` according to the given string `key`.
`NavuContainer`	`container(String prefix, String key)` Returns a subordinate reference to container according to the given `key` and `prefix`.
`NavuContext`	`context()` Returns the current `NavuContext` that this node is attached to.
`abstract List<ConfXMLParam>`	`encodeValues()` Encoding the sub-tree including the current `NavuNode` as the topmost `NavuNode` to a `ConfXMLParam` array.
`abstract List<ConfXMLParam>`	`encodeXML()` Encoding the sub-tree including the current `NavuNode` as the topmost `NavuNode` to a `ConfXMLParam` array.
`abstract boolean`	`equals(Object o)` Check the equality of this NavuNode against the targeted NavuNode.
`abstract boolean`	`exists()` Generic exists test for Navu navigational elements
`CdbSession`	`getCdbSession(CdbDBType dbType)` Deprecated.
`DiffIterateOperFlag`	`getChange()` Deprecated.
`DiffIterateOperFlag`	`getChangeFlag()` Returns the latest change that this `NavuNode` has been a subject to by a transaction.
`List<NavuNode>`	`getChanges()` Return the descendant `NavuNode`'s (including this element) that has been affected by changes to the `MAAPI` transaction.
`List<NavuNode>`	`getChanges(boolean emitSubTree)` Return the descendant `NavuNode` including this `NavuNode` that has been affected by the current MAAPI transaction.
`List<NavuNode>`	`getChanges(boolean emitSubTree, DiffIterateOperFlag... forOps)` Return the descendant `NavuNode` including this `NavuNode` that has been affected by the current MAAPI transaction.
`ConfPath`	`getConfPath()` Returns the corresponding ConfPath for the corresponding NavuNode.
`NavuNodeInfo`	`getInfo()` Returns the `NaveNodeInfo` regarding this node.
`String`	`getKeyPath()` Returns the absolute keypath of this node.
`String`	`getName()` Returns the name of this NavuNode.
`NavuNode`	`getNavuNode(ConfPath path)` Retrieve a NavuNode based on the given absolute or relative `path`.
`NavuNode`	`getParent()` Returns the parent of the node.
`ConfNamespace`	`getRootNS()` Returns the root namespace of the topmost ancestor.
`ConfXMLParam[]`	`getValues(ConfXMLParam[] params)` Read an arbitrary set of sub-elements from this `NavuNode`.
`ConfXMLParam[]`	`getValues(String xml)` Read an arbitrary set of sub-elements of a container element.
`ConfXMLParam[]`	`getXml(String xml)` Deprecated.
`abstract int`	`hashCode()` Return the hashCode of this NavuNode.
`NavuLeaf`	`leaf(Integer key)` Returns a subordinate reference to a leaf node according to the given hash value `key`.
`NavuLeaf`	`leaf(String key)` Returns a subordinate reference to a `NavuNode` according to the given string `key`.
`NavuLeaf`	`leaf(String prefix, String key)` Returns a subordinate reference to leaf according to the given `key` and `prefix`.
`NavuList`	`list(Integer key)` Returns a subordinate reference to list according to the given hash value `key`.
`NavuList`	`list(String key)` Returns a subordinate reference to `NavuNode` according to the given string `key`.
`NavuList`	`list(String prefix, String key)` Returns a subordinate reference to list according to the given `key` and `prefix`.
`PreparedXMLStatement`	`prepareXMLCall(String xml)` A Prepared xml setValues() that accepts parameterized values "?" instead of a string representation of the value when on invocation the value is not known.
`abstract void`	`reset()` When navigating through NAVU to a certain location.
`abstract Collection<NavuNode>`	`select(ConfObject[] query)`
`abstract Collection<NavuNode>`	`select(List<String> query)`
`abstract Collection<NavuNode>`	`select(String query)`
`void`	`setValues(ConfXMLParam[] params)` Set arbitrary sub-elements of a container or list entry.
`void`	`setValues(String xml)` Set arbitrary sub-elements of a container element.
`void`	`sharedSetValues(ConfXMLParam[] params)` Set arbitrary sub-elements of a container or list entry with FastMap support, creating backpointers and reference counter.
`void`	`sharedSetValues(String xml)` Set arbitrary sub-elements of a container or list entry with FastMap support, creating backpointers and reference counter.
`void`	`startCdbSession(CdbDBType dbtype, EnumSet<CdbLockType> lockflags)` Deprecated.
`void`	`stopCdbSession()` Closes all CdbSessions for the NavuContainer.
`List<NavuNode>`	`xPathSelect(String query)` Evaluates the XPath Path expression `query` returns resulting node set as list of `NavuNode`'s.
`void`	`xPathSelectIterate(String query, NavuNodeSetIterate iterate)` Iterate through a NodeSet based on a supplied XPath query.

Methods inherited from class Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NavuNode
```
public NavuNode()
```
- Method Detail
  - children
```
public Collection<NavuNode> children()
                              throws NavuException
```
    Return the children of this NavuNode.
    
    Returns:
    Set of children that this NavuNode is the parent
    
    Throws:
    
    NavuException
  - container
```
public NavuContainer container(Integer key)
                        throws NavuException
```
    Returns a subordinate reference to a container according to the given hash value. The container hashvalue could be obtained through ConfNamespace.stringToHash(String), MaapiSchemas.stringToHash(String) or use the overloaded method container(String)
    
    Parameters:
    key - hashed value of the container to return
    
    Returns:
    subordinate reference to a container
    
    Throws:
    
    NavuException - if the corresponding subordinate node is not a container or if subordinate node has no matching container with the hash value key
  - container
```
public NavuContainer container(String key)
                        throws NavuException
```
    Returns a subordinate reference to NavuNode according to the given string key.
    
    Parameters:
    key - the name of the subordinate container
    
    Returns:
    reference to a subordinate container node
    
    Throws:
    
    NavuException - if the corresponding subordinate node is not a container node or if subordinate node has no matching container with the name key
  - container
```
public NavuContainer container(String prefix,
                      String key)
                        throws NavuException
```
    Returns a subordinate reference to container according to the given key and prefix.
    
    Parameters:
    prefix - the prefix for the namespace
    key - the name of the subordinate container
    
    Returns:
    reference to a subordinate container node
    
    Throws:
    
    NavuException - if the corresponding subordinate node is not a container node or if subordinate node has no matching container with the name key and prefix
  - context
```
public NavuContext context()
```
    Returns the current NavuContext that this node is attached to.
    
    Returns:
    The current NavuContext.
  - encodeValues
```
public abstract List<ConfXMLParam> encodeValues()
                                         throws NavuException
```
    Encoding the sub-tree including the current NavuNode as the topmost NavuNode to a ConfXMLParam array.
    As opposed to encodeXML, the returning ConfXMLParam array does contain values in form of ConfXMLParamValue
    
    Returns:
    A list of ConfXMLParam of the sub-tree including values
    
    Throws:
    
    NavuException - If the operation could not be performed for some reasons
    See Also:
    ConfXMLParam, ConfXMLParamValue
  - encodeXML
```
public abstract List<ConfXMLParam> encodeXML()
                                      throws NavuException
```
    Encoding the sub-tree including the current NavuNode as the topmost NavuNode to a ConfXMLParam array.
    The returning ConfXMLParam array contains no values except for list keys. The leaf elements are encoded as ConfXMLParamLeaf therefore the returning array could be used as a input parameter to getValues(ConfXMLParam[]) on the current elements parent.
    NavuNode node = ...; //cxa contains structure that does not contains values except for //keys in list elements ConfXMLParam[] cxa = node.encodeXML().toArray(new ConfXMLParam[0]); NavuNode parent = node.getParent(); //contains sub-tree with all the values ConfXMLParam[] cxb = parent.getValues(cxa);
    Returns:
    An array of ConfXMLParam of the sub-tree (including key values) with key values.
    
    Throws:
    
    NavuException - If the operation could not be performed for some reasons
    See Also:
    ConfXMLParam, ConfXMLParamValue
  - equals
```
public abstract boolean equals(Object o)
```
    Check the equality of this NavuNode against the targeted NavuNode.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    true/false whether this NavuNode is equal the targeted NavuNode
  - exists
```
public abstract boolean exists()
                        throws NavuException
```
    Generic exists test for Navu navigational elements
    
    Returns:
    boolean
    
    Throws:
    
    NavuException
  - getCdbSession
```
@Deprecated
public CdbSession getCdbSession(CdbDBType dbType)
```
    Deprecated.
    
    This method is deprecated. Use one of NavuContextBase.getReadConfSession(), NavuContextBase.getReadConfSession() or NavuContextBase.getWriteOperSession() instead. Returns the current CdbSession.
    
    Returns:
    The current CdbSession or null if this node is attached to a Maapi context
  - getChange
```
@Deprecated
public DiffIterateOperFlag getChange()
```
    Deprecated.
    
    This method is deprecated, use getChangeFlag() instead.
  - getChangeFlag
```
public DiffIterateOperFlag getChangeFlag()
```
    Returns the latest change that this NavuNode has been a subject to by a transaction.
    
    Returns:
    Flag for the latest change
    See Also:
    DiffIterateOperFlag
  - getChanges
```
public List<NavuNode> getChanges()
                          throws NavuException
```
    Return the descendant NavuNode's (including this element) that has been affected by changes to the MAAPI transaction.
    The default behavior is to emit the affected descendant and include all the affected NavuNode's regardless of type of change.
    To filter out specific type of change use the methods getChanges(boolean, DiffIterateOperFlag...)
    
    Returns:
    A list of NavuNode's that has been affected by the changes to the current MAAPI transaction.
    
    Throws:
    
    NavuException - Is returned if we try to iterate on a transaction which is in the wrong state and not attached.
  - getChanges
```
public List<NavuNode> getChanges(boolean emitSubTree)
                          throws NavuException
```
    Return the descendant NavuNode including this NavuNode that has been affected by the current MAAPI transaction.
    The emitSubtree flag specified if the desired sub-tree should be included in the return set. If set to true then the behavior is to include the whole sub-tree of affected NavuNode's.
    If set to false the sibling changes to the current transaction is to only included.
    
    Returns:
    A list of NavuNode that has been affected by changes to the current MAAPI transaction.
    
    Throws:
    
    NavuException - Is returned if we try to iterate on changes on a transaction which is in the wrong state and not attached.
  - getChanges
```
public List<NavuNode> getChanges(boolean emitSubTree,
                        DiffIterateOperFlag... forOps)
                          throws NavuException
```
    Return the descendant NavuNode including this NavuNode that has been affected by the current MAAPI transaction.
    The emitSubtree flag specified if the desired sub-tree should be included in the return set. If set to true then the behavior is to include the whole sub-tree of affected NavuNode's.
    If set to false the sibling NavuNode that has been affected by changes to the current transaction is to be included.
    The forOps argument specifies those specific changes that the NavuNode previously NavuNode's to be included filter out the set that does not match the specified arguments.
    
    Returns:
    A list of NavuNode that has been affected by changes to the current MAAPI transaction.
    
    Throws:
    
    NavuException - Is returned if we try to iterate on a transaction which is in the wrong state and not attached.
  - getConfPath
```
public ConfPath getConfPath()
```
    Returns the corresponding ConfPath for the corresponding NavuNode. If the NavuNode is the root schema NavuNode i.e the root NavuContainer constructed from the schema hash, this node has no corresponding ConfPath and null is returned.
    
    Returns:
    ConfPath
  - getInfo
```
public NavuNodeInfo getInfo()
```
    Returns the NaveNodeInfo regarding this node.
    A NavuNodeInfo is an object which further information could be retrieved from the current node.
    
    Returns:
    A informational instance about this NavuNode
  - getKeyPath
```
public String getKeyPath()
```
    Returns the absolute keypath of this node.
    
    Returns:
    A String representing the absolute keypath that this NavuNode
    
    Throws:
    
    NavuException - If the keypath could not be determine
  - getName
```
public String getName()
```
    Returns the name of this NavuNode.
    
    Returns:
    - the node name.
  - getNavuNode
```
public NavuNode getNavuNode(ConfPath path)
                     throws NavuException
```
    Retrieve a NavuNode based on the given absolute or relative path.
    If the path is relative it is relative this NavuNode .
    
    Returns:
    NavuNode pointed by path if it is absolute or if relative the NavuNode pointed by path relative this NavuNode
    
    Throws:
    
    NavuException - if the path is invalid according the schema or does not lead to a instance node.
  - getParent
```
public NavuNode getParent()
```
    Returns the parent of the node.
    
    Returns:
    - this node parent or null if this NavuNode represents the root node.
  - getRootNS
```
public ConfNamespace getRootNS()
```
    Returns the root namespace of the topmost ancestor.
    
    Returns:
    topmost namespace.
  - getValues
```
public ConfXMLParam[] getValues(ConfXMLParam[] params)
                         throws NavuException
```
    Read an arbitrary set of sub-elements from this NavuNode.
    Input array of ConfXMLParam where desired values to be extracted should be replaced with ConfXMLParamLeaf in the ConfXMLParam array.
    The return value is a array of the type ConfXMLParam with ConfXMLParamLeaf is replaced with ConfXMLParamValue.
    
    Parameters:
    params - pre-populated array of ConfXMLParam
    
    Returns:
    Array of ConfXMLParam where ConfXMLParamLeaf is replaced with ConfXMLParamValue
    
    Throws:
    
    NavuException - If the input parameters does not confirm to the current data model or external error have occurred
  - getValues
```
public ConfXMLParam[] getValues(String xml)
                         throws NavuException
```
    Read an arbitrary set of sub-elements of a container element.
    The xml string must be pre-populated with tags and parameterized with values ("?") which indicates that the operation will read value of the corresponding tag.
    
    NOTE: The specified xml string should not contain the version tag (<?xml version="1.0" encoding="UTF-8"?>) and do not wrap xml string with current node tag.
    Example - Get tree in a service model:
```
 augment /ncs:services/ncs:service/ncs:type/ncs:service-type-choice {
 case buzz-case {
  container buzz
 container servers {
     list server {
      key "srv-name";
      max-elements "64";
      leaf srv-name {
        type string;
      }
      leaf ip {
        type inet:host;
        mandatory true;
      }
      leaf port {
        type inet:port-number;
        default "80";
      }
      container foo {
        leaf bar {
          type int64;
          default "42";
        }
        leaf baz {
          type int64;
          default "7";
        }
      }
      list interface {
        key "if-name";
        max-elements "8";
        leaf if-name {
          type string;
        }
        leaf mtu {
          type int64;
          default "1500";
        }
      }
    }
  }
 }
}

   NavuContainer type =
          ncsRoot.container(Ncs._ncs)
          .container(Ncs._sm_).list(Ncs._service_)
          .elem(new ConfKey(new ConfBuf("service1")))
         .container(Ncs._type_);

   ConfXMLParam[] param =
     type.getValues(
  "<buzz xmlns=\"http://org.baz.servicemapper/buzz\>"
     +  "<servers><server><srv-name>www1</srv-name>"
     +  "<ip>?</ip></server><server>"
     +  "<srv-name>www2</srv-name><ip>?</ip>"
     +  " </server></servers> </buzz>");
```
    Parameters:
    xml - - XML structure corresponding values that will be fetched.
    
    Throws:
    
    NavuException
  - getXml
```
@Deprecated
public ConfXMLParam[] getXml(String xml)
                      throws NavuException
```
    Deprecated.
    
    Same functionality as {link getValues(String) which should be used instead.
    
    Parameters:
    xml - Array which specifies what data should be retrieved
    
    Returns:
    Resulting data as array of ConfXMLParam
    
    Throws:
    
    NavuException - If the input parameters does not confirm to the current data model or external error have occurred
  - hashCode
```
public abstract int hashCode()
```
    Return the hashCode of this NavuNode.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    The hashCode
  - leaf
```
public NavuLeaf leaf(Integer key)
              throws NavuException
```
    Returns a subordinate reference to a leaf node according to the given hash value key.
    
    Parameters:
    key - hashed value of the subordinate leaf
    
    Returns:
    reference to a subordinate container node
    
    Throws:
    
    NavuException - if the corresponding subordinate node is not a leaf node or if subordinate node has no matching leaf with the hash value key
  - leaf
```
public NavuLeaf leaf(String key)
              throws NavuException
```
    Returns a subordinate reference to a NavuNode according to the given string key.
    
    Parameters:
    key - the name of the subordinate leaf
    
    Returns:
    reference to a subordinate leaf node
    
    Throws:
    
    NavuException - if the corresponding subordinate node is not a leaf node or if subordinate node has no matching leaf with the name key
  - leaf
```
public NavuLeaf leaf(String prefix,
            String key)
              throws NavuException
```
    Returns a subordinate reference to leaf according to the given key and prefix.
    
    Parameters:
    prefix - the prefix for the namespace
    key - the name of the subordinate leaf
    
    Returns:
    reference to a subordinate leaf node
    
    Throws:
    
    NavuException - if the corresponding subordinate node is not a leaf node or if subordinate node has no matching leaf with the name key and prefix
  - list
```
public NavuList list(Integer key)
              throws NavuException
```
    Returns a subordinate reference to list according to the given hash value key.
    
    Parameters:
    key - the name of the subordinate list
    
    Returns:
    reference to a subordinate list node
    
    Throws:
    
    NavuException - if the corresponding subordinate node is not a list node or if subordinate node has no matching list with the hash value key
  - list
```
public NavuList list(String key)
              throws NavuException
```
    Returns a subordinate reference to NavuNode according to the given string key.
    
    Parameters:
    key - the name of the subordinate list
    
    Returns:
    reference to a subordinate list node
    
    Throws:
    
    NavuException - if the corresponding subordinate node is not a list node or if subordinate node has no matching list with the name key
  - list
```
public NavuList list(String prefix,
            String key)
              throws NavuException
```
    Returns a subordinate reference to list according to the given key and prefix.
    
    Parameters:
    prefix - the prefix for the namespace
    key - the name of the subordinate list
    
    Returns:
    reference to a subordinate list node
    
    Throws:
    
    NavuException - if the corresponding subordinate node is not a list node or if subordinate node has no matching list with the name key and prefix
  - prepareXMLCall
```
public PreparedXMLStatement prepareXMLCall(String xml)
                                    throws NavuException
```
    A Prepared xml setValues() that accepts parameterized values "?" instead of a string representation of the value when on invocation the value is not known. When values that corresponds to ? are known setXXX methods on are used.
```
   PreparedXMLStatement xmlst =
   node.prepareXMLCall("<server><srv-name>?</srv-name>"
                    +   "<ip>?</ip>"
                    +   " <port>?</port>"
                    +   "</server>");

     xmlst.put(0,new ConfKey(new ConfBuf("www1"));
     xmlst.put(1,new ConfIPv4(new ConfIPv4(new int[]{
                                                 192,168,10,12});
     xmlst.put(2,new ConfUInt16(80));
     xmlst.setValues();

 
```
    If no put() method is called before setValues() then the ? is treated as ConfDefault.
    Parameters:
    xml - - Parameterized xml string.
    
    Throws:
    
    NavuException
  - reset
```
public abstract void reset()
```
    When navigating through NAVU to a certain location. The sub-tree from a NavuNode start to finish is populated in a lazy fashion. It does that only once and caches the data as available paths. To clear this cache and indicating NAVU that the underlying store has been altered by a second transaction the reset method is used to result in further invocation of the NavuNode operations re-read the values or possible paths to the cache.
  - select
```
public abstract Collection<NavuNode> select(ConfObject[] query)
                                     throws NavuException
```
    Parameters:
    query -
    
    Returns:
    a collection a nodes matching a Regular Expression query
    
    Throws:
    
    NavuException
  - select
```
public abstract Collection<NavuNode> select(List<String> query)
                                     throws NavuException
```
    Parameters:
    query - a list of regular expression.
    
    Returns:
    a collection a nodes marching the query
    
    Throws:
    
    NavuException
  - select
```
public abstract Collection<NavuNode> select(String query)
                                     throws NavuException
```
    Parameters:
    query - a "/" separated regular expression.
    
    Returns:
    a collection a nodes marching the query
    
    Throws:
    
    NavuException
  - setValues
```
public void setValues(ConfXMLParam[] params)
               throws NavuException
```
    Set arbitrary sub-elements of a container or list entry.
    The ConfXMLParam array must be populated with values according to the specification of the ConfXMLParam array structure.
    If the container or list entry itself, or any sub-elements that are specified as existing, do not exist before this call, they will be created, otherwise the existing values will be updated.
    Both mandatory and optional elements may be omitted from the array, and all omitted elements are left unchanged.
    To actually delete a non-mandatory leaf or presence container ConfNoExists should be used in ConfXMLParamValue instead of being omitted.
    For a list entry, the key values can be specified either in the path or via key elements in ConfXMLParamValue - if the values are in the path, the key elements can be omitted from the array. For sub-lists present in the array, the key elements must of course always also be present though, immediately following the ConfXMLParamStart element and in the order defined by the data model.
    For a list without keys the "pseudo" key may (or in some cases must) be present in the array, but of course there is no tag value for it, since it isn't present in the data model. In this case we must use a tag value of 0, i.e. it can be set with code like:
    ConfXMLParam[] p = new ConfXMLParam[7]; p[1] = new ConfXMLParam(hash, 0, new ConfInt64(42));
    Parameters:
    params - ConfXMLParam structure corresponding values that will be set.
    
    Throws:
    
    IOException
    
    ConfException
    
    NavuException
  - setValues
```
public void setValues(String xml)
               throws NavuException
```
    Set arbitrary sub-elements of a container element.
    This method share the same behavior as setValues(ConfXMLParam[]) but the input parameter is an XML string.
    The XML string passed as the input parameter should reflect the equivalent ConfXMLParam array structure.
    ConfXMLParam p = new ConfXMLParam[]; final int hash = new Ncs().hash(); p[0] = new ConfXMLParamStart(hash,Ncs._config); final int hash2 = new Foo().hash(); p[1] = new ConfXMLParamStart(hash2,Foo._interfaces); p[2] = new ConfXMLParamStart(hash2,Foo._buzz); p[3] = new ConfXMLParamStart(hash2,Foo._servers); p[4] = new ConfXMLParamStart(hash2,Foo._server); p[5] = new ConfXMLParamValue(hash2,Foo._srv_name,new ConfBuf("www")); p[6] = new ConfXMLParamValue(hash2,Foo._port,new ConfUInt16(80)); p[7] = new ConfXMLParamStop(hash2,Foo._server); p[8] = new ConfXMLParamStop(hash2,Foo._servers); p[9] = new ConfXMLParamStop(hash2,Foo.buzz); p[10] = new ConfXMLParamStop(hash2,Foo._interfaces); p[11] = new ConfXMLParamStop(hash,Ncs._config); Represents the XML String Below: <config> <foo:foo xmlns="http://acme.com/foo"> <foo:interfaces> <foo:buzz> <foo:servers> <foo:server> <foo:srv-name>www</foo:srv-name> <foo:port>80</foo:port> </foo:server> </foo:servers> </foo:buzz> </foo:interfaces> </foo:zconfigzub> </config>
    The specified XML string should not contain the "version" tag (<?xml version="1.0" encoding="UTF-8"?>) the method will be appended it.
    The values that is intended to be set must represent a legal string representation of a the value. The corresponding string representation of values will be validated against the current the schema and the operation will fail if the string representation could not be determine.
    Example - Populate tree in a service model:
    augment /ncs:services/ncs:service/ncs:type/ncs:service-type-choice { case buzz-case { container buzz container servers { list server { key "srv-name"; max-elements "64"; leaf srv-name { type string; } leaf ip { type inet:host; mandatory true; } leaf port { type inet:port-number; default "80"; } container foo { leaf bar { type int64; default "42"; } leaf baz { type int64; default "7"; } } list interface { key "if-name"; max-elements "8"; leaf if-name { type string; } leaf mtu { type int64; default "1500"; } } } } } } NavuContainer buzz = ncsRoot.container(Ncs._ncs) .container(Ncs._sm_).list(Ncs._service_) .elem(new ConfKey(new ConfBuf("service1"))) .container(Ncs._type_).container(Buzz._buzz_); //Does wrap string with servers.set("<servers><server> <srv-name>www1</srv-name<ip>192.178.0.1</ip>" "<port>80</port><foo><bar>55</bar> <baz>44</baz></foo>" + "<interface><if-name>eth0</if-name>" + "<mtu>1500</mtu> <if-name>eth1</if-name> <mtu>1600</mtu>" + "</interface></server><server> ;<srv-name>www2</srv-name>" + "<ip>192.178.0.2</ip>" + "<port>8080</port>" + "<foo> <bar>66</bar> <baz>55</baz></foo>" + "<interface><if-name>eth0</if-name>" + "<mtu>1500</mtu> ;<if-name>eth1</if-name>" + "<mtu>1600</mtu> </interface></server>">/servers≷);
    For operational data with lists without keys, list instances cannot be created without passing a pseudo-key. This pseudo-key is used to identify which item in the list to set or update. The pseudo-key has to be specified in the supplied xml-string an is identified by the "<tailf-navu-pseudo-key>1</tailf-navu-pseudo-key>" tag. Internally the pseudo-key value is represented as a ConfInt64 type.
    Parameters:
    xml - - XML structure corresponding values that will be set.
    
    Throws:
    
    NavuException
    See Also:
    setValues(ConfXMLParam[]), ConfXMLParam
  - sharedSetValues
```
public void sharedSetValues(ConfXMLParam[] params)
                     throws NavuException
```
    Set arbitrary sub-elements of a container or list entry with FastMap support, creating backpointers and reference counter. All FastMap code shall (in principle) allways use this method instead of setValues().
    
    Throws:
    
    NavuException
  - sharedSetValues
```
public void sharedSetValues(String xml)
                     throws NavuException
```
    Set arbitrary sub-elements of a container or list entry with FastMap support, creating backpointers and reference counter. All FastMap code shall (in principle) allways use this method instead of setValues().
    This method share the same behavior as sharedSetValues(ConfXMLParam[]) but the input parameter is an XML string.
    
    Throws:
    
    NavuException
  - startCdbSession
```
@Deprecated
public void startCdbSession(CdbDBType dbtype,
                              EnumSet<CdbLockType> lockflags)
```
    Deprecated.
    
    This method is deprecated This method is a no op the internal session pool handles the session start
    
    Parameters:
    dbtype -
    lockflags -
  - stopCdbSession
```
public void stopCdbSession()
```
    Closes all CdbSessions for the NavuContainer. This is only necessary the case if the the NavuContainer was created with a constructor for CDB access. In such cases it is important to call this method as soon as the NavuContainer has been used. The reason for this is to release any locks on the CDB database as soon as possible. Calling this method several times under the life-cycle of the NavuContainer object is supported.
  - xPathSelect
```
public List<NavuNode> xPathSelect(String query)
                           throws NavuException
```
    Evaluates the XPath Path expression query returns resulting node set as list of NavuNode's.
    The expression query will be evaluated using this node as the context node. examples:
```
    NavuContainer  =
    root.container(myns._somecontainer1).
      container(myns._somecontainer2).container(myns._servers);

    //retrieve all the instance entries of the server list "server"
    servers.xPathSelect("server");

    //retrieve all child nodes of instance with srv-name: www1
    //entries of the server list "server"
    servers.xPathSelect("server[srv-name='www1']/*");

     //retrieve all leaf ip node of instance with srv-name: www1
    //entries of the server list "server"
    servers.xPathSelect("server[srv-name='www1']/ip");
```
    Parameters:
    query - - XPath 1.0 query
    
    Returns:
    a collection a nodes marching the query
    
    Throws:
    
    NavuException
  - xPathSelectIterate
```
public void xPathSelectIterate(String query,
                      NavuNodeSetIterate iterate)
                        throws NavuException
```
    Iterate through a NodeSet based on a supplied XPath query. Instead of retrieving a list of nodes as with xPathSelect(String) in this method a supplied callback is called for each node iteration. See @link NavuNodeSetIterate}
    
    Parameters:
    query - - XPath 1.0 query
    iterate - - supplied user code
    
    Throws:
    
    NavuException

Class NavuNode

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

NavuNode

Method Detail

children

container

container

container

context

encodeValues

encodeXML

equals

exists

getCdbSession

getChange

getChangeFlag

getChanges

getChanges

getChanges

getConfPath

getInfo

getKeyPath

getName

getNavuNode

getParent

getRootNS

getValues

getValues

getXml

hashCode

leaf

leaf

leaf

list

list

list

prepareXMLCall

reset

select

select

select

setValues

setValues

sharedSetValues

sharedSetValues

startCdbSession

stopCdbSession

xPathSelect

xPathSelectIterate