org.onosproject.yms.app.ydt

Interface YdtAppContext

All Known Implementing Classes:

DefaultYdtAppContext

public interface YdtAppContext

Abstraction of an entity which represents YANG application data tree context information. This context information will be used by protocol to obtain the information associated with YDT application node. This is used when protocol is walking the application data tree in both visitor and listener mechanism.

Method Summary

Modifier and Type	Method and Description
void	addChild(YdtAppContext newChild) Adds a last child to ydt application data tree.
void	addDeleteNode(YdtNode node) Adds the ydt node with operation type delete in module delete node list.
AppData	getAppData() Returns the app data for current context.
org.onosproject.yangutils.datamodel.YangSchemaNode	getAugmentingSchemaNode() Returns the YangSchemaNode of augmenting application.
List<YdtContext>	getDeleteNodes() Returns the list of nodes with operation type delete.
YdtAppContext	getFirstChild() Returns the context of first child.
YdtAppContext	getLastChild() Returns the context of last child.
YdtContext	getModuleContext() Returns application's root ydtContext.
YdtAppContext	getNextSibling() Returns the context of next sibling.
YdtAppNodeOperationType	getOperationType() Returns the app tree operation type.
YdtAppContext	getParent() Returns the context of parent node.
YdtAppContext	getPreviousSibling() Returns the context of previous sibling.
org.onosproject.yangutils.datamodel.YangSchemaNode	getYangSchemaNode() Returns the yang schema for requested node.
void	setAppData(YdtNode moduleNode, org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode) Sets the application data for given request.
void	setAugmentingSchemaNode(org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode) Sets the YangSchemaNode of augmenting application root node.
void	setNextSibling(YdtAppContext nextSibling) Sets the context of next sibling.
void	setOperationType(YdtAppNodeOperationType opType) Set the app tree operation type.
void	setParent(YdtAppContext parent) Sets the context of parent node.
void	setPreviousSibling(YdtAppContext preSibling) Sets the context of previous sibling.
void	updateAppOperationType(YdtContextOperationType opType) Updates the app tree operation type.

Method Detail

getParent

YdtAppContext getParent()

Returns the context of parent node.

Returns:

context of parent node

setParent

void setParent(YdtAppContext parent)

Sets the context of parent node.

Parameters:

parent - node

getFirstChild

YdtAppContext getFirstChild()

Returns the context of first child.

Returns:

context of first child

getLastChild

YdtAppContext getLastChild()

Returns the context of last child.

Returns:

context of last child

getNextSibling

YdtAppContext getNextSibling()

Returns the context of next sibling.

Returns:

context of next sibling

setNextSibling

void setNextSibling(YdtAppContext nextSibling)

Sets the context of next sibling.

Parameters:

nextSibling - node

getPreviousSibling

YdtAppContext getPreviousSibling()

Returns the context of previous sibling.

Returns:

context of previous sibling

setPreviousSibling

void setPreviousSibling(YdtAppContext preSibling)

Sets the context of previous sibling.

Parameters:

preSibling - node

getOperationType

YdtAppNodeOperationType getOperationType()

Returns the app tree operation type.

Returns:

app tree operation type

setOperationType

void setOperationType(YdtAppNodeOperationType opType)

Set the app tree operation type.

Parameters:

opType - app tree operation type

getDeleteNodes

List<YdtContext> getDeleteNodes()

Returns the list of nodes with operation type delete.

Returns:

list of nodes with operation type delete

addDeleteNode

void addDeleteNode(YdtNode node)

Adds the ydt node with operation type delete in module delete node list.

Parameters:

node - ydt node with operation type delete/remove

getModuleContext

YdtContext getModuleContext()

Returns application's root ydtContext.

Returns:

YdtContext of application root node

getAugmentingSchemaNode

org.onosproject.yangutils.datamodel.YangSchemaNode getAugmentingSchemaNode()

Returns the YangSchemaNode of augmenting application.

Returns:

YangSchemaNode of augmenting application

setAugmentingSchemaNode

void setAugmentingSchemaNode(org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode)

Sets the YangSchemaNode of augmenting application root node.

Parameters:

schemaNode - YangSchemaNode of augmenting application module

addChild

void addChild(YdtAppContext newChild)

Adds a last child to ydt application data tree.

Parameters:

newChild - name of child to be added

updateAppOperationType

void updateAppOperationType(YdtContextOperationType opType)

Updates the app tree operation type.

If earlier operation type was OTHER_EDIT and now operation type came as DELETE_ONLY or vice-versa, then update operation type to BOTH.

Parameters:

opType - ydt current context operation type

setAppData

void setAppData(YdtNode moduleNode,
                org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode)

Sets the application data for given request. If in requested parameters schemaNode is not null then appData will be set with augmentedSchemaData else with moduleSchemaData object.

Parameters:

moduleNode - module node of requested app

schemaNode - augmented schema node of requested context

getAppData

AppData getAppData()

Returns the app data for current context.

Returns:

app data

getYangSchemaNode

org.onosproject.yangutils.datamodel.YangSchemaNode getYangSchemaNode()

Returns the yang schema for requested node.

Returns:

schema node