*/
package org.opendaylight.yangtools.yang.data.impl.codec;
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Verify.verify;
+import static java.util.Objects.requireNonNull;
+
import com.google.common.annotations.Beta;
-import com.google.common.base.Preconditions;
import com.google.common.collect.Iterables;
import java.io.IOException;
import java.util.ArrayDeque;
import java.util.Deque;
-import java.util.HashSet;
+import java.util.Optional;
+import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
import org.opendaylight.yangtools.yang.data.impl.schema.SchemaUtils;
-import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
+import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
-import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
+import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ContainerLike;
import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
+import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
+import org.opendaylight.yangtools.yang.model.api.EffectiveStatementInference;
import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.opendaylight.yangtools.yang.model.api.SchemaNode;
import org.opendaylight.yangtools.yang.model.api.SchemaPath;
-import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.ActionEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
import org.opendaylight.yangtools.yang.model.util.EffectiveAugmentationSchema;
+import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
+import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Utility class for tracking the underlying state of the underlying
- * schema node.
+ * Utility class for tracking the underlying state of the underlying schema node.
*/
@Beta
public final class SchemaTracker {
private static final Logger LOG = LoggerFactory.getLogger(SchemaTracker.class);
- private final Deque<Object> schemaStack = new ArrayDeque<>();
+
+ private final Deque<WithStatus> schemaStack = new ArrayDeque<>();
+ private final SchemaInferenceStack dataTree;
private final DataNodeContainer root;
- private SchemaTracker(final SchemaContext context, final SchemaPath path) {
- SchemaNode current = SchemaUtils.findParentSchemaOnPath(context, path);
- Preconditions.checkArgument(current instanceof DataNodeContainer,"Schema path must point to container or list or an rpc input/output. Supplied path %s pointed to: %s",path,current);
- root = (DataNodeContainer) current;
+ private SchemaTracker(final EffectiveModelContext context) {
+ root = requireNonNull(context);
+ dataTree = SchemaInferenceStack.of(context);
+ }
+
+ private SchemaTracker(final SchemaInferenceStack dataTree) {
+ this.dataTree = requireNonNull(dataTree);
+ if (!dataTree.isEmpty()) {
+ final EffectiveStatement<?, ?> current = dataTree.currentStatement();
+ checkArgument(current instanceof DataNodeContainer, "Cannot instantiate on %s", current);
+
+ root = (DataNodeContainer) current;
+ } else {
+ root = dataTree.getEffectiveModelContext();
+ }
}
/**
- * Create a new writer with the specified context as its root.
+ * Create a new writer with the specified inference state as its root.
*
- * @param context Associated {@link SchemaContext}.
+ * @param root Root inference state
* @return A new {@link NormalizedNodeStreamWriter}
+ * @throws NullPointerException if {@code root} is null
*/
- public static SchemaTracker create(final SchemaContext context) {
- return create(context, SchemaPath.ROOT);
+ public static @NonNull SchemaTracker create(final EffectiveStatementInference root) {
+ return new SchemaTracker(SchemaInferenceStack.ofInference(root));
}
/**
- * Create a new writer with the specified context and rooted in the specified schema path
+ * Create a new writer with the specified inference state as its root.
*
- * @param context Associated {@link SchemaContext}
- * @param path schema path
+ * @param root Root inference state
+ * @return A new {@link NormalizedNodeStreamWriter}
+ * @throws NullPointerException if {@code root} is null
+ */
+ public static @NonNull SchemaTracker create(final Inference root) {
+ return new SchemaTracker(root.toSchemaInferenceStack());
+ }
+
+ /**
+ * Create a new writer at the root of specified {@link EffectiveModelContext}.
*
+ * @param context effective model context
* @return A new {@link NormalizedNodeStreamWriter}
+ * @throws NullPointerException if {@code context} is null
*/
- public static SchemaTracker create(final SchemaContext context, final SchemaPath path) {
- return new SchemaTracker(context, path);
+ public static @NonNull SchemaTracker create(final EffectiveModelContext context) {
+ return new SchemaTracker(context);
}
- public Object getParent() {
- if (schemaStack.isEmpty()) {
- return root;
- }
- return schemaStack.peek();
+ /**
+ * Create a new writer with the specified context and rooted in the specified schema path.
+ *
+ * @param context Associated {@link EffectiveModelContext}
+ * @param path schema path
+ * @return A new {@link SchemaTracker}
+ * @throws NullPointerException if any argument is null
+ * @throws IllegalArgumentException if {@code path} does not point to a valid root
+ */
+ public static @NonNull SchemaTracker create(final EffectiveModelContext context, final Absolute path) {
+ return new SchemaTracker(SchemaInferenceStack.of(context, path));
}
- private SchemaNode getSchema(final PathArgument name) {
- final Object parent = getParent();
- SchemaNode schema = null;
- final QName qname = name.getNodeType();
- if (parent instanceof DataNodeContainer) {
- schema = ((DataNodeContainer)parent).getDataChildByName(qname);
+ /**
+ * Create a new writer with the specified context and rooted in the specified schema path.
+ *
+ * @param context Associated {@link EffectiveModelContext}
+ * @param path schema path
+ * @return A new {@link SchemaTracker}
+ * @throws NullPointerException if any argument is null
+ * @throws IllegalArgumentException if {@code path} does not point to a valid root
+ */
+ public static @NonNull SchemaTracker create(final EffectiveModelContext context, final SchemaPath path) {
+ return new SchemaTracker(SchemaInferenceStack.ofInstantiatedPath(context, path));
+ }
- if (schema == null && parent instanceof GroupingDefinition) {
- schema = ((GroupingDefinition) parent);
- }
+ /**
+ * Create a new writer with the specified context and rooted in the specified schema path.
+ *
+ * @param context Associated {@link EffectiveModelContext}
+ * @param operation Operation schema path
+ * @param qname Input/Output container QName
+ * @return A new {@link NormalizedNodeStreamWriter}
+ * @throws NullPointerException if any argument is null
+ * @throws IllegalArgumentException if {@code operation} does not point to an actual operation or if {@code qname}
+ * does not identify a valid root underneath it.
+ */
+ public static @NonNull SchemaTracker forOperation(final EffectiveModelContext context, final Absolute operation,
+ final QName qname) {
+ final SchemaInferenceStack stack = SchemaInferenceStack.of(context, operation);
+ final EffectiveStatement<?, ?> current = stack.currentStatement();
+ checkArgument(current instanceof RpcEffectiveStatement || current instanceof ActionEffectiveStatement,
+ "Path %s resolved into non-operation %s", operation, current);
+ stack.enterSchemaTree(qname);
+ return new SchemaTracker(stack);
+ }
- if (schema == null && parent instanceof NotificationDefinition) {
- schema = ((NotificationDefinition) parent);
- }
- } else if (parent instanceof ChoiceSchemaNode) {
- schema = findChildInCases((ChoiceSchemaNode) parent, qname);
- } else {
- throw new IllegalStateException("Unsupported schema type "+ parent.getClass() +" on stack.");
- }
- Preconditions.checkArgument(schema != null, "Could not find schema for node %s in %s", qname, parent);
- return schema;
+ /**
+ * Return a copy of this tracker's state as an {@link SchemaInferenceStack}.
+ *
+ * @return A SchemaInferenceStack
+ */
+ public @NonNull SchemaInferenceStack toSchemaInferenceStack() {
+ return dataTree.copy();
}
- private static SchemaNode findChildInCases(final ChoiceSchemaNode parent, final QName qname) {
- DataSchemaNode schema = null;
- for (final ChoiceCaseNode caze : parent.getCases()) {
- final DataSchemaNode potential = caze.getDataChildByName(qname);
- if (potential != null) {
- schema = potential;
- break;
- }
- }
- return schema;
+ public Object getParent() {
+ final WithStatus schema = schemaStack.peek();
+ return schema == null ? root : schema;
}
- private static SchemaNode findCaseByChild(final ChoiceSchemaNode parent, final QName qname) {
- DataSchemaNode schema = null;
- for (final ChoiceCaseNode caze : parent.getCases()) {
- final DataSchemaNode potential = caze.getDataChildByName(qname);
- if (potential != null) {
- schema = caze;
- break;
- }
+ private SchemaNode enterDataTree(final PathArgument name) {
+ final QName qname = name.getNodeType();
+ final DataTreeEffectiveStatement<?> stmt = dataTree.enterDataTree(qname);
+ verify(stmt instanceof SchemaNode, "Unexpected result %s", stmt);
+ final SchemaNode ret = (SchemaNode) stmt;
+ final Object parent = getParent();
+ if (parent instanceof ChoiceSchemaNode) {
+ final DataSchemaNode check = ((ChoiceSchemaNode) parent).findDataSchemaChild(qname).orElse(null);
+ verify(check == ret, "Data tree result %s does not match choice result %s", ret, check);
}
- return schema;
+ return ret;
}
public void startList(final PathArgument name) {
- final SchemaNode schema = getSchema(name);
- Preconditions.checkArgument(schema instanceof ListSchemaNode, "Node %s is not a list", schema.getPath());
+ final SchemaNode schema = enterDataTree(name);
+ checkArgument(schema instanceof ListSchemaNode, "Node %s is not a list", schema);
schemaStack.push(schema);
}
public void startListItem(final PathArgument name) throws IOException {
final Object schema = getParent();
- Preconditions.checkArgument(schema instanceof ListSchemaNode, "List item is not appropriate");
- schemaStack.push(schema);
+ checkArgument(schema instanceof ListSchemaNode, "List item is not appropriate");
+ schemaStack.push((ListSchemaNode) schema);
}
- public LeafSchemaNode leafNode(final NodeIdentifier name) throws IOException {
- final SchemaNode schema = getSchema(name);
-
- Preconditions.checkArgument(schema instanceof LeafSchemaNode, "Node %s is not a leaf", schema.getPath());
- return (LeafSchemaNode) schema;
+ public void startLeafNode(final NodeIdentifier name) throws IOException {
+ final SchemaNode schema = enterDataTree(name);
+ checkArgument(schema instanceof LeafSchemaNode, "Node %s is not a leaf", schema);
+ schemaStack.push(schema);
}
public LeafListSchemaNode startLeafSet(final NodeIdentifier name) {
- final SchemaNode schema = getSchema(name);
-
- Preconditions.checkArgument(schema instanceof LeafListSchemaNode, "Node %s is not a leaf-list", schema.getPath());
+ final SchemaNode schema = enterDataTree(name);
+ checkArgument(schema instanceof LeafListSchemaNode, "Node %s is not a leaf-list", schema);
schemaStack.push(schema);
- return (LeafListSchemaNode)schema;
- }
-
- @Deprecated
- public LeafListSchemaNode leafSetEntryNode() {
- final Object parent = getParent();
-
- Preconditions.checkArgument(parent instanceof LeafListSchemaNode, "Not currently in a leaf-list");
- return (LeafListSchemaNode) parent;
+ return (LeafListSchemaNode) schema;
}
public LeafListSchemaNode leafSetEntryNode(final QName qname) {
return (LeafListSchemaNode) parent;
}
- final SchemaNode child = SchemaUtils.findChildSchemaByQName((SchemaNode) parent, qname);
- Preconditions.checkArgument(child instanceof LeafListSchemaNode,
- "Node %s is neither a leaf-list nor currently in a leaf-list", child.getPath());
+ // FIXME: when would this trigger?
+ final SchemaNode child = SchemaUtils.findDataChildSchemaByQName((SchemaNode) parent, qname);
+ checkArgument(child instanceof LeafListSchemaNode,
+ "Node %s is neither a leaf-list nor currently in a leaf-list", child);
return (LeafListSchemaNode) child;
}
+ public void startLeafSetEntryNode(final NodeWithValue<?> name) {
+ schemaStack.push(leafSetEntryNode(name.getNodeType()));
+ }
+
public ChoiceSchemaNode startChoiceNode(final NodeIdentifier name) {
LOG.debug("Enter choice {}", name);
- final SchemaNode schema = getSchema(name);
-
- Preconditions.checkArgument(schema instanceof ChoiceSchemaNode, "Node %s is not a choice", schema.getPath());
- schemaStack.push(schema);
- return (ChoiceSchemaNode)schema;
+ final ChoiceEffectiveStatement stmt = dataTree.enterChoice(name.getNodeType());
+ verify(stmt instanceof ChoiceSchemaNode, "Node %s is not a choice", stmt);
+ final ChoiceSchemaNode ret = (ChoiceSchemaNode) stmt;
+ schemaStack.push(ret);
+ return ret;
}
public SchemaNode startContainerNode(final NodeIdentifier name) {
LOG.debug("Enter container {}", name);
- final SchemaNode schema = getSchema(name);
-
- boolean isAllowed = schema instanceof ContainerSchemaNode;
- isAllowed |= schema instanceof NotificationDefinition;
-
- Preconditions.checkArgument(isAllowed, "Node %s is not a container nor a notification", schema.getPath());
+ final SchemaNode schema = enterDataTree(name);
+ checkArgument(schema instanceof ContainerLike || schema instanceof NotificationDefinition,
+ "Node %s is not a container nor a notification", schema);
schemaStack.push(schema);
-
- return schema;
- }
-
- public SchemaNode startYangModeledAnyXmlNode(final NodeIdentifier name) {
- LOG.debug("Enter yang modeled anyXml {}", name);
- final SchemaNode schema = getSchema(name);
-
- Preconditions.checkArgument(schema instanceof YangModeledAnyXmlSchemaNode,
- "Node %s is not an yang modeled anyXml.", schema.getPath());
-
- schemaStack.push(((YangModeledAnyXmlSchemaNode) schema).getSchemaOfAnyXmlData());
-
return schema;
}
- public AugmentationSchema startAugmentationNode(final AugmentationIdentifier identifier) {
+ public AugmentationSchemaNode startAugmentationNode(final AugmentationIdentifier identifier) {
LOG.debug("Enter augmentation {}", identifier);
Object parent = getParent();
- Preconditions.checkArgument(parent instanceof AugmentationTarget, "Augmentation not allowed under %s", parent);
+ checkArgument(parent instanceof AugmentationTarget, "Augmentation not allowed under %s", parent);
if (parent instanceof ChoiceSchemaNode) {
final QName name = Iterables.get(identifier.getPossibleChildNames(), 0);
parent = findCaseByChild((ChoiceSchemaNode) parent, name);
}
- Preconditions.checkArgument(parent instanceof DataNodeContainer, "Augmentation allowed only in DataNodeContainer",parent);
- final AugmentationSchema schema = SchemaUtils.findSchemaForAugment((AugmentationTarget) parent, identifier.getPossibleChildNames());
- final HashSet<DataSchemaNode> realChildSchemas = new HashSet<>();
- for (final DataSchemaNode child : schema.getChildNodes()) {
- realChildSchemas.add(((DataNodeContainer) parent).getDataChildByName(child.getQName()));
- }
- final AugmentationSchema resolvedSchema = new EffectiveAugmentationSchema(schema, realChildSchemas);
+ checkArgument(parent instanceof DataNodeContainer, "Augmentation allowed only in DataNodeContainer", parent);
+ final AugmentationSchemaNode schema = SchemaUtils.findSchemaForAugment((AugmentationTarget) parent,
+ identifier.getPossibleChildNames());
+ final AugmentationSchemaNode resolvedSchema = EffectiveAugmentationSchema.create(schema,
+ (DataNodeContainer) parent);
schemaStack.push(resolvedSchema);
return resolvedSchema;
}
- public AnyXmlSchemaNode anyxmlNode(final NodeIdentifier name) {
- final SchemaNode schema = getSchema(name);
+ private static SchemaNode findCaseByChild(final ChoiceSchemaNode parent, final QName qname) {
+ for (final CaseSchemaNode caze : parent.getCases()) {
+ final Optional<DataSchemaNode> potential = caze.findDataChildByName(qname);
+ if (potential.isPresent()) {
+ return caze;
+ }
+ }
+ return null;
+ }
+
+ public void startAnyxmlNode(final NodeIdentifier name) {
+ final SchemaNode schema = enterDataTree(name);
+ checkArgument(schema instanceof AnyxmlSchemaNode, "Node %s is not anyxml", schema);
+ schemaStack.push(schema);
+ }
- Preconditions.checkArgument(schema instanceof AnyXmlSchemaNode, "Node %s is not anyxml", schema.getPath());
- return (AnyXmlSchemaNode)schema;
+ public void startAnydataNode(final NodeIdentifier name) {
+ final SchemaNode schema = enterDataTree(name);
+ checkArgument(schema instanceof AnydataSchemaNode, "Node %s is not anydata", schema);
+ schemaStack.push(schema);
}
public Object endNode() {
- return schemaStack.pop();
+ final Object ret = schemaStack.pop();
+ // If this is a data tree node, make sure it is updated. Before that, though, we need to check if this is not
+ // actually listEntry -> list or leafListEntry -> leafList exit.
+ if (!(ret instanceof AugmentationSchemaNode) && getParent() != ret) {
+ dataTree.exit();
+ }
+ return ret;
}
-
}
Code Review / yangtools.git / blobdiff