yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/package-info.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 /**
  10  * Meta model of YANG model as was defined in RFC6020 and extracted by analysis
  11  * of YANG text.
  12  *
  13  * <p>
  14  * Existence of meta-model allows for better evolution of YANG language as it evolves
  15  * and allows for better support of different serializations of YANG model.
  16  *
  17  * <h2>Statements</h2>
  18  * YANG source is defined as sequence of statement in
  19  * <a href="https://tools.ietf.org/html/rfc6020#section-6.3">RFC6020, Section 6.3</a>.
  20  * this model is also correct for YIN, which is XML serialisation of YANG source.
  21  * <p>
  22  * Statements are represented as instances / subclasses of {@link org.opendaylight.yangtools.yang.model.api.meta.ModelStatement}
  23  * concept and its two subconcepts which are:
  24  * <ul>
  25  * <li>
  26  * {@link org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement} - this contains navigable
  27  * set of statements model as they was defined / present in original processed
  28  * sources.
  29  * </li>
  30  * <li>{@link org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement} - navigable set of statements
  31  * which represents effective model of parsed YANG sources, which is derived by rules
  32  * present in YANG specification and/or was introduced in form of extensions.
  33  * </li>
  34  * </ul>
  35  * <p>
  36  * Clear separation of declared / effective model is needed, since statement definition also
  37  * contains information how effective model is computed and there is no one to one mapping
  38  * between declared and effective model thanks to statements such as {@code uses},
  39  * {@code augment},{@code deviate},{@code refine}.
  40  *
  41  * <h2>Identifiers and Namespaces</h2>
  42  * Effective model of YANG has several identifier types and namespaces, which behaves differently
  43  * and are mostly used during processing data and/or during computing effective (semantic) model.
  44  * <p>
  45  * Common abstraction for various types of namespaces is {@link org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace}
  46  * from which concrete effective model namespaces are derived.
  47  *
  48  */
  49 package org.opendaylight.yangtools.yang.model.api.meta;