org.onosproject.yms.app.ydt

Class YdtNode<T>

java.lang.Object

org.onosproject.yms.app.ydt.YdtNode<T>

All Implemented Interfaces:

Cloneable, YdtExtendedContext, YdtContext

Direct Known Subclasses:

YdtMultiInstanceNode, YdtSingleInstanceLeafNode

public abstract class YdtNode<T>
extends Object
implements YdtExtendedContext, Cloneable

Represents implementation of interfaces to build and obtain YANG data tree which is data (sub)instance representation, abstract of protocol.

Method Summary

Modifier and Type	Method and Description
void	addAppInfo(AppType appType, Object object) Sets application stored information.
void	addChild(YdtContext newChild, boolean isAtomic) Adds a child node.
void	addValue(String value) Adds the given value to the non single instance leaf node.
void	addValueSet(Set<String> valueSet) Adds the given valueSet to the non multi instance leaf node.
void	addValueSetWithoutValidation(Set<String> valueSet) Adds the given valueSet to the non multi instance leaf node.
void	addValueWithoutValidation(String value, boolean isKeyLeaf) Adds the given value to the non single instance leaf node.
YdtNode	clone() Clones the current node contents and create a new node.
void	createKeyNodeList() Creates the list of key element's of multi instance node.
boolean	getAppContextSwitch() Returns the flag for node if context switch.
Object	getAppInfo(AppType appType) Returns the application stored information.
YdtContext	getClonedNode() Returns the cloned ydt node.
YdtNode	getCollidingChild(org.onosproject.yangutils.datamodel.YangSchemaNodeIdentifier id) Returns already existing YdtNode in Ydt tree with same nodeIdentifier.
YdtNode	getFirstChild() Returns the context of first child.
YdtNode	getLastChild() Returns the context of last child.
String	getModuleNameAsNameSpace() Returns module name as namespace.
String	getName() Returns the node name.
String	getNamespace() Returns the node namespace.
YdtNode	getNextSibling() Returns the context of next sibling.
YdtNode	getParent() Returns the context of parent node.
YdtNode	getPreviousSibling() Returns the previous sibling of a node.
org.onosproject.yangutils.datamodel.YangSchemaNodeContextInfo	getSchemaNodeContextInfo(org.onosproject.yangutils.datamodel.YangSchemaNodeIdentifier id) Returns child schema node context information.
String	getValue() Returns value of node, this is only valid for single instance leaf node, to obtain the nature of the node protocols need to use getYdtType().
Set<String>	getValueSet() Returns set of values of a node, this is only valid for multi instance leaf node, to obtain the nature of the node protocols need to use getYdtType().
org.onosproject.yangutils.datamodel.YangSchemaNode	getYangSchemaNode() Returns schema node from data model for curNode.
<T> T	getYdtContextExtendedInfo() Returns the YDT node extended context information corresponding to YDT node.
YdtContextOperationType	getYdtContextOperationType() Returns YDT current extended context operation type.
YdtExtendedInfoType	getYdtExtendedInfoType() Returns YANG data tree extended information type.
YdtType	getYdtType() Returns the type of YDT entity.
void	setAppContextSwitch() Sets the flag to keep the track of context switch.
void	setChild(YdtNode child) Sets the first instance of a child node.
void	setClonedNode(YdtContext clonedNode) Sets the cloned node.
void	setLastChild(YdtNode child) Sets the last instance of a child node.
void	setNextSibling(YdtNode sibling) Sets the next sibling of node.
void	setParent(YdtNode parent) Sets the parent of node.
void	setPreviousSibling(YdtNode previousSibling) Sets the previous sibling.
void	setYangSchemaNode(org.onosproject.yangutils.datamodel.YangSchemaNode yangSchemaNode) Sets the data-model node reference for of a given node.
void	setYdtContextOperationType(YdtContextOperationType opType) Sets type of yang data tree node operation.
void	validateMultiInstanceNode() Validates all multi Instance nodes inside current context.

Methods inherited from class java.lang.Object

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

Method Detail

getClonedNode

public YdtContext getClonedNode()

Returns the cloned ydt node.

Returns:

clonedNode cloned ydt node

setClonedNode

public void setClonedNode(YdtContext clonedNode)

Sets the cloned node.

Parameters:

clonedNode - cloned ydt node

getName

public String getName()

Description copied from interface: YdtContext

Returns the node name.

Specified by:

getName in interface YdtContext

Returns:

node name

getNamespace

public String getNamespace()

Description copied from interface: YdtContext

Returns the node namespace.

Specified by:

getNamespace in interface YdtContext

Returns:

node namespace

getModuleNameAsNameSpace

public String getModuleNameAsNameSpace()

Description copied from interface: YdtContext

Returns module name as namespace.

Specified by:

getModuleNameAsNameSpace in interface YdtContext

Returns:

module name

getYdtContextExtendedInfo

public <T> T getYdtContextExtendedInfo()

Description copied from interface: YdtContext

Returns the YDT node extended context information corresponding to YDT node.

Specified by:

getYdtContextExtendedInfo in interface YdtContext

Type Parameters:

T - specifies YMS operation specific extended information associated with YDT context. It will be YdtContextOperationType in case extended information type is EDIT_REQUEST and will be YdtContextResponseInfo in case extended information type is RESPONSE.

Returns:

YdtContextOperationType YDT node operation type

getYdtExtendedInfoType

public YdtExtendedInfoType getYdtExtendedInfoType()

Description copied from interface: YdtContext

Returns YANG data tree extended information type. This is used to identify the type of extended information applicable for YDT node.

Specified by:

getYdtExtendedInfoType in interface YdtContext

Returns:

type of extended information

getYdtType

public YdtType getYdtType()

Description copied from interface: YdtContext

Returns the type of YDT entity. This type will be used by protocols to identify the nature of node and can implement it accordingly.

Specified by:

getYdtType in interface YdtContext

Returns:

YDT entity type

getParent

public YdtNode getParent()

Description copied from interface: YdtContext

Returns the context of parent node.

Specified by:

getParent in interface YdtContext

Returns:

context of parent node

getFirstChild

public YdtNode getFirstChild()

Description copied from interface: YdtContext

Returns the context of first child.

Specified by:

getFirstChild in interface YdtContext

Returns:

context of first child

getNextSibling

public YdtNode getNextSibling()

Description copied from interface: YdtContext

Returns the context of next sibling.

Specified by:

getNextSibling in interface YdtContext

Returns:

context of next sibling

getYangSchemaNode

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

Description copied from interface: YdtExtendedContext

Returns schema node from data model for curNode.

Specified by:

getYangSchemaNode in interface YdtExtendedContext

Returns:

yang schema node

getLastChild

public YdtNode getLastChild()

Description copied from interface: YdtContext

Returns the context of last child.

Specified by:

getLastChild in interface YdtContext

Returns:

context of last child

getAppInfo

public Object getAppInfo(AppType appType)

Description copied from interface: YdtExtendedContext

Returns the application stored information. Application type is used to identify application.

Specified by:

getAppInfo in interface YdtExtendedContext

Parameters:

appType - application type

Returns:

application information

addAppInfo

public void addAppInfo(AppType appType,
                       Object object)

Description copied from interface: YdtExtendedContext

Sets application stored information. Application type is used to identify application.

Specified by:

addAppInfo in interface YdtExtendedContext

Parameters:

appType - application type

object - application information object

getSchemaNodeContextInfo

public org.onosproject.yangutils.datamodel.YangSchemaNodeContextInfo getSchemaNodeContextInfo(org.onosproject.yangutils.datamodel.YangSchemaNodeIdentifier id)
                                                                                       throws YdtException

Returns child schema node context information. It is used by YMS to obtain the child schema corresponding to data node identifier.

Parameters:

id - represents a identifier of YANG data tree node

Returns:

YANG data node context information

Throws:

YdtException - when user requested node schema doesn't exist

addValue

public void addValue(String value)
              throws YdtException

Adds the given value to the non single instance leaf node.

This default implementation throws an exception stating that the value cannot be added. Subclasses may override this method to provide the correct behavior for their specific implementation.

Parameters:

value - value in a single instance node

Throws:

YdtException - when fails to add value for non single instance leaf node

createKeyNodeList

public void createKeyNodeList()
                       throws YdtException

Creates the list of key element's of multi instance node. This will not be applicable on leaf and leaf-list node.

Throws:

YdtException - when user requested multi instance node is missing any of the key element in request or requested node is of type other then multi instance node

addValueWithoutValidation

public void addValueWithoutValidation(String value,
                                      boolean isKeyLeaf)
                               throws YdtException

Adds the given value to the non single instance leaf node.

This default implementation throws an exception stating that the value cannot be added. Subclasses may override this method to provide the correct behavior for their specific implementation. This will be applicable in case of call from SBI so no need to validate the value.

Parameters:

value - value in a single instance leaf node

isKeyLeaf - true, for key leaf; false non key leaf

Throws:

YdtException - when fails to add value for non single instance leaf node

addValueSet

public void addValueSet(Set<String> valueSet)
                 throws YdtException

Adds the given valueSet to the non multi instance leaf node.

This default implementation throws an exception stating that the value cannot be added. Subclasses may override this method to provide the correct behavior for their specific implementation.

Parameters:

valueSet - valueSet in a multi instance leaf node

Throws:

YdtException - when fails to add value set for non multi instance leaf node

addValueSetWithoutValidation

public void addValueSetWithoutValidation(Set<String> valueSet)
                                  throws YdtException

Adds the given valueSet to the non multi instance leaf node.

This default implementation throws an exception stating that the value cannot be added. Subclasses may override this method to provide the correct behavior for their specific implementation. This will be applicable in case of call from SBI so no need to validate the value.

Parameters:

valueSet - valueSet in a multi instance leaf node

Throws:

YdtException - when fails to add value set for non multi instance leaf node

getCollidingChild

public YdtNode getCollidingChild(org.onosproject.yangutils.datamodel.YangSchemaNodeIdentifier id)
                          throws YdtException

Returns already existing YdtNode in Ydt tree with same nodeIdentifier.

Parameters:

id - represents a identifier of YANG data tree node

Returns:

YDT node

Throws:

YdtException - when user requested node already part of YDT tree.

setParent

public void setParent(YdtNode parent)

Sets the parent of node.

Parameters:

parent - node

setChild

public void setChild(YdtNode child)

Sets the first instance of a child node.

Parameters:

child - is only child to be set

setNextSibling

public void setNextSibling(YdtNode sibling)

Sets the next sibling of node.

Parameters:

sibling - YANG node

getPreviousSibling

public YdtNode getPreviousSibling()

Returns the previous sibling of a node.

Specified by:

getPreviousSibling in interface YdtContext

Returns:

previous sibling of a node

setPreviousSibling

public void setPreviousSibling(YdtNode previousSibling)

Sets the previous sibling.

Parameters:

previousSibling - points to predecessor sibling

getValue

public String getValue()
                throws YdtException

Description copied from interface: YdtContext

Returns value of node, this is only valid for single instance leaf node, to obtain the nature of the node protocols need to use getYdtType().

Specified by:

getValue in interface YdtContext

Returns:

value of node

Throws:

YdtException

getValueSet

public Set<String> getValueSet()
                        throws YdtException

Description copied from interface: YdtContext

Returns set of values of a node, this is only valid for multi instance leaf node, to obtain the nature of the node protocols need to use getYdtType().

Specified by:

getValueSet in interface YdtContext

Returns:

value of YDT leaf

Throws:

YdtException

setYangSchemaNode

public void setYangSchemaNode(org.onosproject.yangutils.datamodel.YangSchemaNode yangSchemaNode)

Sets the data-model node reference for of a given node.

Parameters:

yangSchemaNode - YANG data node

setLastChild

public void setLastChild(YdtNode child)

Sets the last instance of a child node.

Parameters:

child - is last child to be set

addChild

public void addChild(YdtContext newChild,
                     boolean isAtomic)
              throws YdtException

Adds a child node. The children sibling list will be sorted based on node type. This will add single child or sub-tree based on isAtomic flag.

Parameters:

newChild - refers to a new child to be added

isAtomic - boolean flag to maintain atomicity of the current node

Throws:

YdtException - in case of violation of any YDT rule

getYdtContextOperationType

public YdtContextOperationType getYdtContextOperationType()

Description copied from interface: YdtExtendedContext

Returns YDT current extended context operation type.

Specified by:

getYdtContextOperationType in interface YdtExtendedContext

Returns:

operation type

setYdtContextOperationType

public void setYdtContextOperationType(YdtContextOperationType opType)

Sets type of yang data tree node operation.

Parameters:

opType - type of yang data tree node operation

getAppContextSwitch

public boolean getAppContextSwitch()

Returns the flag for node if context switch.

Returns:

isContextSwitch flag of a node

setAppContextSwitch

public void setAppContextSwitch()

Sets the flag to keep the track of context switch. If it is set then when YDT get traverToParent then traverse back to parent in YDT application tree.

validateMultiInstanceNode

public void validateMultiInstanceNode()
                               throws YdtException

Validates all multi Instance nodes inside current context.

Throws:

YdtException - when fails to validate multi instance node

clone

public YdtNode clone()
              throws CloneNotSupportedException

Clones the current node contents and create a new node.

Overrides:

clone in class Object

Returns:

cloned node

Throws:

CloneNotSupportedException - clone is not supported by the referred node