*/
package org.opendaylight.yangtools.yang.data.api.schema;
+import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.concepts.Identifiable;
-import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
/**
- *
* Node which is normalized according to the YANG schema
- * is identifiable by {@link InstanceIdentifier}.
+ * is identifiable by a {@link org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier}.
+ *
+ * <p>
+ * See subinterfaces of this interface for concretization of node.
+ */
+/*
+ * FIXME: 8.0.0: NormalizedNode represents the perfectly-compliant view of the data, as evaluated by an implementation,
+ * which is currently singular, with respect of its interpretation of a SchemaContext. This includes
+ * leaf values, which are required to hold normalized representation for a particular implementation,
+ * which may be affected by its understanding of any YANG extensions present -- such as optional type
+ * handling hints and bindings.
*
- * See subinterfaces of this interface for concretization
- * of node.
+ * Implementations (i.e. the reference implementation and parsers) will need to start using
+ * yang.common.Uint8 and friends and, if possible, express data validation in terms
+ * of yang.common.CanonicalValue and yang.common.CanonicalValueValidator.
*
- * @param <K> Local identifier of node
- * @param <V> Value of node
+ * This notably means that to efficiently implement any sort of lenient parsing, we need a separate
+ * concept which contains an unverified, potentially non-conformant data tree, which the consumer needs
+ * to check/fixup if it wishes to use it as a NormalizedNode. Such a concept should be called
+ * "UnverifiedData".
+ *
+ * FIXME: 8.0.0: Once we have UnverifiedData, we should really rename this to "NormalizedData" or similar to unload
+ * some "Node" ambiguity. "Node" should be a generic term reserved for a particular domain -- hence 'node'
+ * can be used to refer to either a 'schema node' in context of yang.model.api, or to
+ * a 'normalized data node' in context of yang.data.api.
+ *
+ * FIXME: 8.0.0: Well, not quite. The structure of unverified data is really codec specific -- and JSON and XML
+ * do not agree on details. Furthermore things get way more complicated when we have a cross-schema
+ * boundary -- like RFC8528. Hence we cannot really have a reasonably-structured concept of unverified
+ * data. Nevertheless, this interface should be named 'NormalizedData'.
*/
-public interface NormalizedNode<K extends InstanceIdentifier.PathArgument, V> extends Identifiable<K> {
- /**
- * QName of the node as defined in YANG schema.
- *
- * @return QName of this node, non-null.
- */
- QName getNodeType();
-
- /**
- * Locally unique identifier of the node.
- *
- * @return Node identifier, non-null.
- */
+public interface NormalizedNode extends Identifiable<PathArgument> {
@Override
- K getIdentifier();
+ // We override here, so that NormalizedNode.getIdentifier() has fewer implementations
+ PathArgument getIdentifier();
/**
- * Value of node.
+ * Returns the body of this node. While the return value specifies {@link Object}, this method's return value has
+ * further semantics. The returned object must be a well-published contract, such as {@code String},
+ * {@code Collection<NormalizedNode>} or {@code DOMSource}.
*
- * @return Value of the node, may be null.
+ * @return Returned value of this node.
*/
- V getValue();
+ @NonNull Object body();
}