Merge "BUG-994: introduce SchemaPath.getParent()"
[yangtools.git] / yang / yang-data-impl / src / main / java / org / opendaylight / yangtools / yang / data / impl / CompositeNodeTOImpl.java
1 /*
2  * Copyright (c) 2013 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 package org.opendaylight.yangtools.yang.data.impl;
9
10 import java.io.IOException;
11 import java.io.ObjectInputStream;
12 import java.io.ObjectOutputStream;
13 import java.io.Serializable;
14 import java.util.ArrayList;
15 import java.util.Collection;
16 import java.util.Collections;
17 import java.util.HashMap;
18 import java.util.List;
19 import java.util.Map;
20 import java.util.Set;
21
22 import org.opendaylight.yangtools.yang.common.QName;
23 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
24 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
25 import org.opendaylight.yangtools.yang.data.api.MutableCompositeNode;
26 import org.opendaylight.yangtools.yang.data.api.Node;
27 import org.opendaylight.yangtools.yang.data.api.SimpleNode;
28
29 /**
30  * @author michal.rehak
31  *
32  */
33 public class CompositeNodeTOImpl extends AbstractNodeTO<List<Node<?>>> implements CompositeNode, Serializable {
34
35     private static final long serialVersionUID = 100L;
36
37     private Map<QName, List<Node<?>>> nodeMap = new HashMap<>();
38
39     /**
40      * @param qname
41      * @param parent
42      *            use null to create top composite node (without parent)
43      * @param value
44      */
45     public CompositeNodeTOImpl(final QName qname, final CompositeNode parent, final List<Node<?>> value) {
46         super(qname, parent, value);
47         init();
48     }
49
50     /**
51      * @param qname
52      * @param parent
53      *            use null to create top composite node (without parent)
54      * @param value
55      * @param modifyAction
56      */
57     public CompositeNodeTOImpl(final QName qname, final CompositeNode parent, final List<Node<?>> value, final ModifyAction modifyAction) {
58         super(qname, parent, value, modifyAction);
59         init();
60     }
61
62     protected void init() {
63         if (getValue() != null) {
64             nodeMap = NodeUtils.buildNodeMap(getValue());
65         }
66     }
67
68     protected Map<QName, List<Node<?>>> getNodeMap() {
69         return nodeMap;
70     }
71
72     @Override
73     public List<Node<?>> getChildren() {
74         return Collections.unmodifiableList(getValue() == null ? new ArrayList<Node<?>>() : getValue());
75     }
76
77     @Override
78     public SimpleNode<?> getFirstSimpleByName(final QName leafQName) {
79         List<SimpleNode<?>> list = getSimpleNodesByName(leafQName);
80         if (list.isEmpty()) {
81             return null;
82         }
83         return list.get(0);
84     }
85
86     @Override
87     public List<CompositeNode> getCompositesByName(final QName children) {
88         List<Node<?>> toFilter = getNodeMap().get(children);
89         if(toFilter == null) {
90             return Collections.emptyList();
91         }
92         List<CompositeNode> list = new ArrayList<CompositeNode>();
93         for (Node<?> node : toFilter) {
94             if (node instanceof CompositeNode) {
95                 list.add((CompositeNode) node);
96             }
97         }
98         return list;
99     }
100
101     @Override
102     public List<SimpleNode<?>> getSimpleNodesByName(final QName children) {
103         List<Node<?>> toFilter = getNodeMap().get(children);
104         if(toFilter == null) {
105             return Collections.emptyList();
106         }
107         List<SimpleNode<?>> list = new ArrayList<SimpleNode<?>>();
108
109         for (Node<?> node : toFilter) {
110             if (node instanceof SimpleNode<?>) {
111                 list.add((SimpleNode<?>) node);
112             }
113         }
114         return list;
115     }
116
117     @Override
118     public CompositeNode getFirstCompositeByName(final QName container) {
119         List<CompositeNode> list = getCompositesByName(container);
120         if (list.isEmpty()) {
121             return null;
122         }
123         return list.get(0);
124     }
125
126     /**
127      * @param leaf
128      * @return TODO:: do we need this method?
129      */
130     public SimpleNode<?> getFirstLeafByName(final QName leaf) {
131         List<SimpleNode<?>> list = getSimpleNodesByName(leaf);
132         if (list.isEmpty()) {
133             return null;
134         }
135         return list.get(0);
136     }
137
138     @Override
139     public List<CompositeNode> getCompositesByName(final String children) {
140         return getCompositesByName(new QName(getNodeType(), children));
141     }
142
143     @Override
144     public List<SimpleNode<?>> getSimpleNodesByName(final String children) {
145         return getSimpleNodesByName(new QName(getNodeType(), children));
146     }
147
148     @Override
149     public MutableCompositeNode asMutable() {
150         throw new IllegalAccessError("cast to mutable is not supported - " + getClass().getSimpleName());
151     }
152
153     @Override
154     public String toString() {
155         return super.toString() + ", children.size = " + (getChildren() != null ? getChildren().size() : "n/a");
156     }
157
158     @Override
159     public void clear() {
160         nodeMap.clear();
161     }
162
163     @Override
164     public boolean containsKey(final Object key) {
165         return nodeMap.containsKey(key);
166     }
167
168     @Override
169     public boolean containsValue(final Object value) {
170         return nodeMap.containsValue(value);
171     }
172
173     @Override
174     public Set<java.util.Map.Entry<QName, List<Node<?>>>> entrySet() {
175         return nodeMap.entrySet();
176     }
177
178     @Override
179     public int size() {
180         return nodeMap.size();
181     }
182
183     @Override
184     public boolean isEmpty() {
185         return nodeMap.isEmpty();
186     }
187
188     @Override
189     public List<Node<?>> get(final Object key) {
190         return nodeMap.get(key);
191     }
192
193     @Override
194     public List<Node<?>> put(final QName key, final List<Node<?>> value) {
195         return nodeMap.put(key, value);
196     }
197
198     @Override
199     public List<Node<?>> remove(final Object key) {
200         return nodeMap.remove(key);
201     }
202
203     @Override
204     public void putAll(final Map<? extends QName, ? extends List<Node<?>>> m) {
205         nodeMap.putAll(m);
206     }
207
208     @Override
209     public Set<QName> keySet() {
210         return nodeMap.keySet();
211     }
212
213     @Override
214     public Collection<List<Node<?>>> values() {
215         return nodeMap.values();
216     }
217
218   // Serialization related
219
220     private void readObject(final ObjectInputStream aStream) throws IOException, ClassNotFoundException {
221         aStream.defaultReadObject();
222         QName qName = (QName)aStream.readObject();
223         CompositeNode parent = (CompositeNode) aStream.readObject();
224         @SuppressWarnings("unchecked")
225         List<Node<?>> value = (List<Node<?>>) aStream.readObject();
226         ModifyAction modifyAction = (ModifyAction) aStream.readObject();
227
228         init(qName, parent, value, modifyAction);
229     }
230
231     private void writeObject(final ObjectOutputStream aStream) throws IOException {
232         aStream.defaultWriteObject();
233         //manually serialize superclass
234         aStream.writeObject(getQName());
235         aStream.writeObject(getParent());
236         aStream.writeObject(getValue());
237         aStream.writeObject(getModificationAction());
238     }
239 }