Refactored parsing of yang uses statement.
[yangtools.git] / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / impl / NotificationBuilder.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.parser.builder.impl;
9
10 import java.util.ArrayList;
11 import java.util.Collections;
12 import java.util.HashSet;
13 import java.util.List;
14 import java.util.Map;
15 import java.util.Set;
16 import java.util.TreeMap;
17 import java.util.TreeSet;
18
19 import org.opendaylight.yangtools.yang.common.QName;
20 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
21 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
22 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
23 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
24 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
25 import org.opendaylight.yangtools.yang.model.api.Status;
26 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
27 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
28 import org.opendaylight.yangtools.yang.model.api.UsesNode;
29 import org.opendaylight.yangtools.yang.parser.builder.api.AbstractDataNodeContainerBuilder;
30 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
31 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationTargetBuilder;
32 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
33 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
34 import org.opendaylight.yangtools.yang.parser.builder.api.SchemaNodeBuilder;
35 import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder;
36 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
37 import org.opendaylight.yangtools.yang.parser.util.Comparators;
38
39 public final class NotificationBuilder extends AbstractDataNodeContainerBuilder implements SchemaNodeBuilder,
40         AugmentationTargetBuilder {
41     private boolean isBuilt;
42     private final NotificationDefinitionImpl instance;
43     private SchemaPath schemaPath;
44     private String description;
45     private String reference;
46     private Status status = Status.CURRENT;
47     private final Set<TypeDefinitionBuilder> addedTypedefs = new HashSet<TypeDefinitionBuilder>();
48     private final Set<UsesNodeBuilder> addedUsesNodes = new HashSet<UsesNodeBuilder>();
49     private Set<AugmentationSchema> augmentations;
50     private final Set<AugmentationSchemaBuilder> addedAugmentations = new HashSet<AugmentationSchemaBuilder>();
51
52     NotificationBuilder(final String moduleName, final int line, final QName qname) {
53         super(moduleName, line, qname);
54         instance = new NotificationDefinitionImpl(qname);
55     }
56
57     @Override
58     public NotificationDefinition build() {
59         if (!isBuilt) {
60             // process uses
61             for(UsesNodeBuilder use : addedUsesNodes) {
62                 addedChildNodes.addAll(use.getTargetChildren());
63                 addedGroupings.addAll(use.getTargetGroupings());
64                 addedTypedefs.addAll(use.getTargetTypedefs());
65                 addedUnknownNodes.addAll(use.getTargetUnknownNodes());
66             }
67
68             instance.setPath(schemaPath);
69             instance.setDescription(description);
70             instance.setReference(reference);
71             instance.setStatus(status);
72
73             // CHILD NODES
74             final Map<QName, DataSchemaNode> childs = new TreeMap<QName, DataSchemaNode>(Comparators.QNAME_COMP);
75             for (DataSchemaNodeBuilder node : addedChildNodes) {
76                 childs.put(node.getQName(), node.build());
77             }
78             instance.setChildNodes(childs);
79
80             // GROUPINGS
81             final Set<GroupingDefinition> groupingDefs = new TreeSet<GroupingDefinition>(Comparators.SCHEMA_NODE_COMP);
82             for (GroupingBuilder builder : addedGroupings) {
83                 groupingDefs.add(builder.build());
84             }
85             instance.setGroupings(groupingDefs);
86
87             // TYPEDEFS
88             final Set<TypeDefinition<?>> typedefs = new TreeSet<TypeDefinition<?>>(Comparators.SCHEMA_NODE_COMP);
89             for (TypeDefinitionBuilder entry : addedTypedefs) {
90                 typedefs.add(entry.build());
91             }
92             instance.setTypeDefinitions(typedefs);
93
94             // USES
95             final Set<UsesNode> uses = new HashSet<UsesNode>();
96             for (UsesNodeBuilder builder : addedUsesNodes) {
97                 uses.add(builder.build());
98             }
99             instance.setUses(uses);
100
101             // AUGMENTATIONS
102             if (augmentations == null) {
103                 augmentations = new HashSet<AugmentationSchema>();
104                 for (AugmentationSchemaBuilder builder : addedAugmentations) {
105                     augmentations.add(builder.build());
106                 }
107             }
108             instance.setAvailableAugmentations(augmentations);
109
110             // UNKNOWN NODES
111             final List<UnknownSchemaNode> unknownNodes = new ArrayList<UnknownSchemaNode>();
112             for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
113                 unknownNodes.add(b.build());
114             }
115             Collections.sort(unknownNodes, Comparators.SCHEMA_NODE_COMP);
116             instance.setUnknownSchemaNodes(unknownNodes);
117
118             isBuilt = true;
119         }
120
121         return instance;
122     }
123
124     @Override
125     public void rebuild() {
126         isBuilt = false;
127         build();
128     }
129
130     @Override
131     public Set<TypeDefinitionBuilder> getTypeDefinitionBuilders() {
132         return addedTypedefs;
133     }
134
135     @Override
136     public void addTypedef(final TypeDefinitionBuilder type) {
137         addedTypedefs.add(type);
138     }
139
140     @Override
141     public void addUsesNode(final UsesNodeBuilder usesNodeBuilder) {
142         addedUsesNodes.add(usesNodeBuilder);
143     }
144
145     @Override
146     public SchemaPath getPath() {
147         return schemaPath;
148     }
149
150     @Override
151     public void setPath(SchemaPath schemaPath) {
152         this.schemaPath = schemaPath;
153     }
154
155     @Override
156     public String getDescription() {
157         return description;
158     }
159
160     @Override
161     public void setDescription(final String description) {
162         this.description = description;
163     }
164
165     @Override
166     public String getReference() {
167         return reference;
168     }
169
170     @Override
171     public void setReference(final String reference) {
172         this.reference = reference;
173     }
174
175     @Override
176     public Status getStatus() {
177         return status;
178     }
179
180     @Override
181     public void setStatus(final Status status) {
182         if (status != null) {
183             this.status = status;
184         }
185     }
186
187     public Set<AugmentationSchemaBuilder> getAugmentations() {
188         return addedAugmentations;
189     }
190
191     @Override
192     public void addAugmentation(AugmentationSchemaBuilder augment) {
193         addedAugmentations.add(augment);
194     }
195
196     public void setAugmentations(final Set<AugmentationSchema> augmentations) {
197         this.augmentations = augmentations;
198     }
199
200     @Override
201     public String toString() {
202         return "notification " + getQName().getLocalName();
203     }
204
205     public final class NotificationDefinitionImpl implements NotificationDefinition {
206         private final QName qname;
207         private SchemaPath path;
208         private String description;
209         private String reference;
210         private Status status = Status.CURRENT;
211         private Map<QName, DataSchemaNode> childNodes = Collections.emptyMap();
212         private Set<GroupingDefinition> groupings = Collections.emptySet();
213         private Set<TypeDefinition<?>> typeDefinitions = Collections.emptySet();
214         private Set<UsesNode> uses = Collections.emptySet();
215         private Set<AugmentationSchema> augmentations = Collections.emptySet();
216         private List<UnknownSchemaNode> unknownNodes = Collections.emptyList();
217
218         private NotificationDefinitionImpl(final QName qname) {
219             this.qname = qname;
220         }
221
222         @Override
223         public QName getQName() {
224             return qname;
225         }
226
227         @Override
228         public SchemaPath getPath() {
229             return path;
230         }
231
232         private void setPath(final SchemaPath path) {
233             this.path = path;
234         }
235
236         @Override
237         public String getDescription() {
238             return description;
239         }
240
241         private void setDescription(final String description) {
242             this.description = description;
243         }
244
245         @Override
246         public String getReference() {
247             return reference;
248         }
249
250         private void setReference(String reference) {
251             this.reference = reference;
252         }
253
254         @Override
255         public Status getStatus() {
256             return status;
257         }
258
259         private void setStatus(Status status) {
260             if (status != null) {
261                 this.status = status;
262             }
263         }
264
265         @Override
266         public Set<DataSchemaNode> getChildNodes() {
267             return new HashSet<DataSchemaNode>(childNodes.values());
268         }
269
270         private void setChildNodes(Map<QName, DataSchemaNode> childNodes) {
271             if (childNodes != null) {
272                 this.childNodes = childNodes;
273             }
274         }
275
276         @Override
277         public Set<GroupingDefinition> getGroupings() {
278             return groupings;
279         }
280
281         private void setGroupings(Set<GroupingDefinition> groupings) {
282             if (groupings != null) {
283                 this.groupings = groupings;
284             }
285         }
286
287         @Override
288         public Set<UsesNode> getUses() {
289             return uses;
290         }
291
292         private void setUses(Set<UsesNode> uses) {
293             if (uses != null) {
294                 this.uses = uses;
295             }
296         }
297
298         @Override
299         public Set<TypeDefinition<?>> getTypeDefinitions() {
300             return typeDefinitions;
301         }
302
303         private void setTypeDefinitions(final Set<TypeDefinition<?>> typeDefinitions) {
304             if (typeDefinitions != null) {
305                 this.typeDefinitions = typeDefinitions;
306             }
307         }
308
309         @Override
310         public Set<AugmentationSchema> getAvailableAugmentations() {
311             return augmentations;
312         }
313
314         private void setAvailableAugmentations(Set<AugmentationSchema> augmentations) {
315             if (augmentations != null) {
316                 this.augmentations = augmentations;
317             }
318         }
319
320         @Override
321         public List<UnknownSchemaNode> getUnknownSchemaNodes() {
322             return unknownNodes;
323         }
324
325         private void setUnknownSchemaNodes(final List<UnknownSchemaNode> unknownNodes) {
326             if (unknownNodes != null) {
327                 this.unknownNodes = unknownNodes;
328             }
329         }
330
331         @Override
332         public DataSchemaNode getDataChildByName(QName name) {
333             return childNodes.get(name);
334         }
335
336         @Override
337         public DataSchemaNode getDataChildByName(String name) {
338             DataSchemaNode result = null;
339             for (Map.Entry<QName, DataSchemaNode> entry : childNodes.entrySet()) {
340                 if (entry.getKey().getLocalName().equals(name)) {
341                     result = entry.getValue();
342                     break;
343                 }
344             }
345             return result;
346         }
347
348         public NotificationBuilder toBuilder() {
349             return NotificationBuilder.this;
350         }
351
352         @Override
353         public int hashCode() {
354             final int prime = 31;
355             int result = 1;
356             result = prime * result + ((qname == null) ? 0 : qname.hashCode());
357             result = prime * result + ((path == null) ? 0 : path.hashCode());
358             return result;
359         }
360
361         @Override
362         public boolean equals(Object obj) {
363             if (this == obj) {
364                 return true;
365             }
366             if (obj == null) {
367                 return false;
368             }
369             if (getClass() != obj.getClass()) {
370                 return false;
371             }
372             final NotificationDefinitionImpl other = (NotificationDefinitionImpl) obj;
373             if (qname == null) {
374                 if (other.qname != null) {
375                     return false;
376                 }
377             } else if (!qname.equals(other.qname)) {
378                 return false;
379             }
380             if (path == null) {
381                 if (other.path != null) {
382                     return false;
383                 }
384             } else if (!path.equals(other.path)) {
385                 return false;
386             }
387             return true;
388         }
389
390         @Override
391         public String toString() {
392             StringBuilder sb = new StringBuilder(NotificationDefinitionImpl.class.getSimpleName());
393             sb.append("[qname=" + qname + ", path=" + path + "]");
394             return sb.toString();
395         }
396     }
397
398 }