Package org.opendaylight.yangtools.yang.data.api.schema

package org.opendaylight.yangtools.yang.data.api.schema

Definition of normalized YANG DOM Model. Normalized DOM Model brings more direct mapping between YANG Model, DOM representation of data.

Normalized DOM Model

Node Types

• NormalizedNode - Base type representing a node in a tree structure; all nodes are derived from it, it contains a leaf identifier and a value.
  • DataContainerNode - Node which contains multiple leafs; it does not have a direct representation in the YANG syntax.
    • ContainerNode - Node, which represents a leaf which can occur only once per parent node; it contains multiple child leaves and maps to the container statement in YANG.
    • MapEntryNode - Node which represents a leaf, which can occur multiple times; a leave is uniquely identified by the value of its key. A MapEntryNode may contain multiple child leaves. MapEntryNode maps to the instance of list in YANG.
    • UnkeyedListEntryNode - Node which represents a leaf, which can occur multiple times; a leave is uniquely identified by the value of its key. A MapEntryNode may contain multiple child leaves. MapEntryNode maps to the instance of list in YANG.
    • ChoiceNode - Node which represents a leaf, which occurs mostly once per parent node, but possible values could have different types. Maps to choice statement. Types maps to the case statements for that choice.
    • AugmentationNode - Node which represents a leaf, which occurs mostly once per parent node.
  • LeafNode - Node which represents a leaf, which occurs mostly once per parent node. Contains simple value.
  • LeafSetEntryNode - Node which represents a leaf, which type could occurs multiple times per parent node. Maps to to the instances of leaf-list in YANG.
  • LeafSetNode - Special node, which can occur only once per parent node; its leaves are LeafSetEntryNode nodes of specified type. Maps into the leaf-list in YANG.
  • MapNode - Special node, which can occur only once per parent node; its leaves are MapEntryNode nodes.
    • UserMapNode - Special node, which can occur only once per parent node; its leaves are MapEntryNode nodes.
  • UnkeyedListNode - Special node, which can occur only once per parent node; its leaves are MapEntryNode nodes.

Tree / subtree structure

Grammar representation

  YangInstanceIdentifier =
    YangInstanceIdentifier.PathArgument*
  YangInstanceIdentifier.PathArgument =
    YangInstanceIdentifier.NodeIdentifier
    | YangInstanceIdentifier.NodeIdentifierWithPredicates
    | YangInstanceIdentifier.NodeWithValue
    | YangInstanceIdentifier.AugmentationIdentifier

  TreeRoot = DataContainerNode
  DataContainerNode =
    ( LeafNode
     | ChoiceNode
     | AugmentationNode
     | MapNode
     | LeafSetNode)*
  ContainerDataNode =
    YangInstanceIdentifier.NodeIdentifier
    DataContainerNode

  LeafNode =
    YangInstanceIdentifier.NodeIdentifier SimpleValue
  AugmentationNode =
    YangInstanceIdentifier.AugmentationIdentifier
    DataContainerNode
  MapNode =
    YangInstanceIdentifier.NodeIdentifier
    MapEntryNode
  MapEntryNode =
    YangInstanceIdentifier.NodeIdentifierWithPredicates
    DataContainerNode

  // Special nodes
  LeafSetNode =
    YangInstanceIdentifier.NodeIdentifier
    LeafSetEntryNode*
  ChoiceNode =
    YangInstanceIdentifier.NodeIdentifier
    DataContainerNode
  LeafSetEntryNode =
    YangInstanceIdentifier.NodeWithValue SimpleValue
 

The resulting tree organization is following:

• (DataContainerNode)
  • (0..n) LeafNode
  • (0..n) LeafSetNode
    • (0..n) LeafSetEntryNode
  • (0..n) ContainerNode
    • (Same as DataContainerNode)
  • (0..n) ContainerNode
    • (Same as DataContainerNode)
  • (0..n) MapNode
    • (0..n) MapEntryNode
      • (Same as DataContainerNode)
  • (0..n) AugmentationNode
    • (Same as DataContainerNode)

Ordering of child nodes

Ordering of child nodes is not enforced by this API definition, unless explicitly stated by subclasses of OrderedNodeContainer which marks nodes with semantic constrain to preserve user-supplied ordering.

Clients should not expect any specific ordering of child nodes for interfaces from this package which does not extend OrderedNodeContainer, since implementations are not required to have well-defined order, which allows for more efficient implementations. If such ordering is required by clients for serialization / debugability it SHOULD be done externally in code using these interfaces.

Related Packages

Package	Description
org.opendaylight.yangtools.yang.data.api
org.opendaylight.yangtools.yang.data.api.schema.builder
org.opendaylight.yangtools.yang.data.api.schema.stream
org.opendaylight.yangtools.yang.data.api.schema.tree
org.opendaylight.yangtools.yang.data.api.codec

Class	Description
AnydataNode<V>	A NormalizedNode holding the contents of an anydata node in some object model.
AnydataNormalizationException
AnyxmlNode<V>	A NormalizedNode holding the contents of an anyxml node in some object model.
AugmentationNode	Data instance of augment associated with parent node.
ChoiceNode	Node representing data instance of choice.
ContainerNode	Data subtree with cardinality 0..1 in the context of parent node.
DataContainerChild	Marker interface for direct children of DataContainerNode.
DataContainerNode	Abstract node which does not have value but contains valid DataContainerChild nodes.
DistinctNodeContainer<K extends YangInstanceIdentifier.PathArgument,V extends NormalizedNode>	A NormalizedNodeContainer which contains directly-addressable children.
DOMSourceAnyxmlNode	An AnyxmlNode with data in DOMSource format.
DuplicateEntry	Entry describing a duplicate found in a NormalizedNode tree.
ForeignDataNode<V>	A NormalizedNode holding a value in some foreign object model.
LeafNode<T>	Leaf node with multiplicity 0..1.
LeafSetEntryNode<T>	Leaf node with multiplicity 0...n.
LeafSetNode<T>	Node representing set of simple leaf nodes.
MapEntryNode	Instance of Map entry, this node does not contains value, but child nodes.
MapNode	Containment node, which contains MapEntryNode of the same type, which may be quickly retrieved using a key.
MixinNode	Marker interface for nodes, which are mixins - their content belongs to parent node and in serialized form this node does not exists, but it's children are present.
NormalizableAnydata	An anydata value object model which can be normalized to NormalizedAnydata when provided with proper context.
NormalizedAnydata	The contents of an anydata node in a normalized format.
NormalizedNode	Node which is normalized according to the YANG schema is identifiable by a YangInstanceIdentifier.
NormalizedNodeContainer<V extends NormalizedNode>	Node which is not leaf, but has child NormalizedNodes as its value.
NormalizedNodes	A set of utility methods for interacting with NormalizedNode objects.
OrderedNodeContainer<V extends NormalizedNode>	A NormalizedNodeContainer which preserves user supplied ordering and allows addressing of child elements by position.
OrderingAware	Marker interfaces for NormalizedNodeContainers which have distinct ordering requirements.
OrderingAware.System	Marker interface for NormalizedNodeContainer implementations which correspond to ordered-by system.
OrderingAware.User	Marker interface for NormalizedNodeContainer implementations which correspond to ordered-by user.
SystemLeafSetNode<T>	LeafSetNode which does not preserve user-supplied ordering.
SystemMapNode	MapNode which additionally preserves user-supplied ordering.
UnkeyedListEntryNode	List entry node, which does not have value, but child nodes.
UnkeyedListNode	Containment node, which contains UnkeyedListEntryNode of the same type, which may be quickly retrieved using key.
UserLeafSetNode<T>	LeafSetNode which preserves user-supplied ordering.
UserMapNode	MapNode which additionally preserves user-supplied ordering.
ValueNode<V>	Interface holding the common trait of LeafSetEntryNode and LeafNode, which both hold a value.