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

@Export 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.
  • 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

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

  LeafNode =
    YangInstanceIdentifier.NodeIdentifier SimpleValue
  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)

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
AbstractAnydataNode<T>	Abstract base class for AnydataNode implementations.
AbstractAnyxmlNode<T>	Abstract base class for AnyxmlNode implementations.
AbstractChoiceNode	Abstract base class for ChoiceNode implementations.
AbstractContainerNode	Abstract base class for ContainerNode implementations.
AbstractLeafNode<T>	Abstract base class for LeafNode implementations.
AbstractLeafSetEntryNode<T>	Abstract base class for LeafSetEntryNode implementations.
AbstractMapEntryNode	Abstract base class for MapEntryNode implementations.
AbstractNormalizedNode<T extends NormalizedNode>	Abstract base class for NormalizedNode implementations.
AbstractSystemLeafSetNode<T>	Abstract base class for implementing SystemLeafSetNodes.
AbstractSystemMapNode	Abstract base class for SystemMapNode implementations.
AbstractUnkeyedListEntryNode	Abstract base class for UnkeyedListEntryNode implementations.
AbstractUnkeyedListNode	Abstract base class for implementing UnkeyedListNodes.
AbstractUserLeafSetNode<T>	Abstract base class for implementing UserLeafSetNodes.
AbstractUserMapNode	Abstract base class for UserMapNode implementations.
AnydataNode<V>	A NormalizedNode holding the contents of an anydata node in some object model.
AnydataNode.Builder<V>	A builder of AnydataNodes.
AnydataNormalizationException
AnyxmlNode<V>	A NormalizedNode holding the contents of an anyxml node in some object model.
AnyxmlNode.Builder<V,N extends AnyxmlNode<V>>	A builder of AnyxmlNodes.
ChoiceNode	Node representing data instance of choice.
ChoiceNode.Builder	A builder of ChoiceNodes.
ContainerNode	Data subtree with cardinality 0..1 in the context of parent node.
ContainerNode.Builder	A builder of ContainerNodes.
DataContainer	A DistinctContainer containing DataContainerChild children.
DataContainerChild	Marker interface for direct children of DataContainerNode.
DataContainerNode	Abstract node which does not have value but contains valid DataContainerChild nodes.
DistinctContainer<K extends YangInstanceIdentifier.PathArgument,V extends NormalizedNode>	A NormalizedContainer which contains distinctly-addressable children.
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.
LeafNode.Builder<V>	A builder of LeafNodes.
LeafSetEntryNode<T>	Leaf node with multiplicity 0...n.
LeafSetEntryNode.Builder<T>	A builder of LeafSetEntryNodes.
LeafSetNode<T>	Node representing set of simple leaf nodes.
LeafSetNode.Builder<T,N extends LeafSetNode<T>>	A builder of LeafSetNodes.
MapEntryNode	Instance of Map entry, this node does not contains value, but child nodes.
MapEntryNode.Builder	A builder of MapEntryNodes.
MapNode	Containment node, which contains MapEntryNode of the same type, which may be quickly retrieved using a key.
MapNode.Builder<T extends MapNode>	A builder of MapNodes.
MetadataNormalizedAnydata	A piece of NormalizedAnydata with a corresponding piece of NormalizedMetadata.
MixinNode	Deprecated, for removal: This API element is subject to removal in a future version. This interface assumes XML encoding.
MountPointChild	An unresolved child within a mount point.
MountPointContext	A context of either an explicit (RFC8528 Schema Mount instance) or implicit (system root).
MountPointContextFactory	An entity able to resolve the SchemaContext for embedded mount points based on generic data provided by the current interpretation context.
MountPointContextFactory.ContainerName	Top-level containers which hold YANG Library information, ordered by descending preference, with more modern and/or preferred entries first.
MountPointException	Exception thrown when a mount-point-related operation cannot be performed.
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.
NormalizedContainer<V extends NormalizedNode>	A piece of NormalizedData which holds some child NormalizedNodes.
NormalizedData	A piece of data normalized to a particular EffectiveModelContext.
NormalizedMetadata	RFC7952 metadata counterpart to a NormalizedNode.
NormalizedMountPoint	Normalized representation of a YANG mount point.
NormalizedMountpoints	RFC8528 mount point counterpart to a NormalizedNode structure.
NormalizedNode	Node which is normalized according to the YANG schema is identifiable by a YangInstanceIdentifier.
NormalizedNode.Builder	A builder of NormalizedNodes.
NormalizedNode.BuilderFactory	A factory for concrete NormalizedNode.Builders.
NormalizedNodeContainer<V extends NormalizedNode>	Node which is not leaf, but has child NormalizedNodes as its value.
NormalizedNodePrettyTree
NormalizedNodes	A set of utility methods for interacting with NormalizedNode objects.
NormalizedTuple<T extends NormalizedNode>	A tuple of normalized NormalizedTuple.data(), with corresponding NormalizedTuple.metadata() and NormalizedTuple.mountPoints().
NormalizedYangData	The contents of a yang-data template instance, as defined in RFC8040's ietf-restconf module.
OrderedContainer<V extends NormalizedNode>	A NormalizedContainer which preserves user supplied ordering and allows addressing of child elements by position.
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.
SystemLeafSetNode.Builder<T>	A builder of SystemLeafSetNodes.
SystemMapNode	MapNode which additionally preserves user-supplied ordering.
SystemMapNode.Builder	A builder of SystemMapNodes.
UnkeyedListEntryNode	List entry node, which does not have value, but child nodes.
UnkeyedListEntryNode.Builder	A builder of UnkeyedListNodes.
UnkeyedListNode	Containment node, which contains UnkeyedListEntryNode of the same type, which may be quickly retrieved using key.
UnkeyedListNode.Builder	A builder of UnkeyedListNodes.
UserLeafSetNode<T>	LeafSetNode which preserves user-supplied ordering.
UserLeafSetNode.Builder<T>	A builder of UserLeafSetNodes.
UserMapNode	MapNode which additionally preserves user-supplied ordering.
UserMapNode.Builder	A builder of UserMapNodes.
ValueNode<V>	Interface holding the common trait of LeafSetEntryNode and LeafNode, which both hold a value.