com.tailf.maapi

Class MaapiCursor

Object

com.tailf.maapi.MaapiCursor

public class MaapiCursor
extends Object

Whenever we wish to iterate over a set of objects in the XML tree, we must first initialize a cursor. The cursor is subsequently used in a while loop.

For example if we have:

 module mtest {
   namespace "http://tail-f.com/test/mtest/1.0";
   prefix mtest;
   tailf:id "";

   import ietf-yang-types {
     prefix yang;
   }
   import ietf-inet-types {
     prefix inet;
   }
   import tailf-common {
     prefix tailf;
   }
   import tailf-xsd-types {
     prefix xs;
   }

   container mtest {
     container servers {
       list server {
         key name;
         max-elements 64;
         leaf name {
           type string;
         }
         leaf ip {
           type inet:host;
           mandatory true;
         }
         leaf port {
           type inet:port-number;
           default 80;
         }
         list interface {
           key name;
           max-elements 8;
           leaf name {
             type string;
           }
           leaf mtu {
             type int64;
             default 1500;
           }
         }
       }
     }
   }
 }

 

 We can have the following Java code which iterates  over  all  'server'
 instances.

 
 MaapiCursor c;
 ConfKey x;

 c = maapi.newCursor(th, "/mtest:mtest/servers/server");

 x = maapi.getNext(c);
 while(x != null) {
        // do something
        x = maapi.getNext(c);
 }
 

See Also:

Maapi.getNext(MaapiCursor)

Method Summary

Methods

Modifier and Type	Method and Description
int	getId()
ConfPath	getPath()
ConfEObject	getPrev()
String	getSecondaryIndex() Return the name of the specified secondary index (if any).
int	getTid()
void	setPrev(ConfEObject prev)
void	setSecondaryIndex(String idx) Makes it possible to use a secondary index for the getNext calls.
String	toString()

Methods inherited from class Object

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

Method Detail

getId

public int getId()

getPath

public ConfPath getPath()

getPrev

public ConfEObject getPrev()

getSecondaryIndex

public String getSecondaryIndex()

Return the name of the specified secondary index (if any).

getTid

public int getTid()

setPrev

public void setPrev(ConfEObject prev)

setSecondaryIndex

public void setSecondaryIndex(String idx)

Makes it possible to use a secondary index for the getNext calls.

Parameters:

idx - Secondary index name

toString

public String toString()

Overrides:

toString in class Object