Fix license header violations in sal-clustering-commons
[controller.git] / opendaylight / md-sal / sal-clustering-commons / src / main / java / org / opendaylight / controller / cluster / datastore / node / utils / NormalizedNodeNavigator.java
1 /*
2  * Copyright (c) 2014, 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 package org.opendaylight.controller.cluster.datastore.node.utils;
10
11 import com.google.common.base.Preconditions;
12 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
13 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
14 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
15 import org.opendaylight.yangtools.yang.data.api.schema.MixinNode;
16 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
17 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
18
19 /**
20  * NormalizedNodeNavigator walks a {@link NormalizedNodeVisitor} through the NormalizedNode
21  *
22  * {@link NormalizedNode } is a tree like structure that provides a generic structure for a yang data model
23  *
24  * For examples of visitors
25  * @see NormalizedNodePrinter
26  *
27  *
28  */
29 public class NormalizedNodeNavigator {
30
31   private final org.opendaylight.controller.cluster.datastore.node.utils.NormalizedNodeVisitor
32       visitor;
33
34   public NormalizedNodeNavigator(
35       org.opendaylight.controller.cluster.datastore.node.utils.NormalizedNodeVisitor visitor){
36     Preconditions.checkNotNull(visitor, "visitor should not be null");
37     this.visitor = visitor;
38   }
39   public void navigate(String parentPath, NormalizedNode<?,?> normalizedNode){
40     if(parentPath == null){
41       parentPath = "";
42     }
43     navigateNormalizedNode(0, parentPath, normalizedNode);
44   }
45
46   private void navigateDataContainerNode(int level, final String parentPath, final DataContainerNode<?> dataContainerNode){
47     visitor.visitNode(level, parentPath ,dataContainerNode);
48
49     String newParentPath = parentPath + "/" + dataContainerNode.getIdentifier().toString();
50
51     final Iterable<DataContainerChild<? extends YangInstanceIdentifier.PathArgument,?>> value = dataContainerNode.getValue();
52     for(NormalizedNode<?,?> node : value){
53       if(node instanceof MixinNode && node instanceof NormalizedNodeContainer){
54         navigateNormalizedNodeContainerMixin(level, newParentPath, (NormalizedNodeContainer<?, ?, ?>) node);
55       } else {
56         navigateNormalizedNode(level, newParentPath, node);
57       }
58     }
59
60   }
61
62   private void navigateNormalizedNodeContainerMixin(int level, final String parentPath, NormalizedNodeContainer<?, ?, ?> node) {
63     visitor.visitNode(level, parentPath, node);
64
65     String newParentPath = parentPath + "/" + node.getIdentifier().toString();
66
67     final Iterable<? extends NormalizedNode<?, ?>> value = node.getValue();
68     for(NormalizedNode<?, ?> normalizedNode : value){
69       if(normalizedNode instanceof MixinNode && normalizedNode instanceof NormalizedNodeContainer){
70         navigateNormalizedNodeContainerMixin(level + 1, newParentPath, (NormalizedNodeContainer) normalizedNode);
71       } else {
72         navigateNormalizedNode(level, newParentPath, normalizedNode);
73       }
74     }
75
76   }
77
78
79   private void navigateNormalizedNode(int level, String parentPath, NormalizedNode<?,?> normalizedNode){
80     if(normalizedNode instanceof DataContainerNode){
81
82       final DataContainerNode<?> dataContainerNode = (DataContainerNode<?>) normalizedNode;
83
84       navigateDataContainerNode(level + 1, parentPath, dataContainerNode);
85     } else {
86       visitor.visitNode(level+1, parentPath, normalizedNode);
87     }
88   }
89 }