BUG 1131: untangling package cyclic dependencies in yang-parser-impl
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / impl / AugmentationSchemaBuilderImpl.java
index 2cc67615c6d31a21fa311d0ffc94f9fbb7180db4..2a73848c29c498828c67b1e94e9c3957e547fc38 100644 (file)
@@ -7,19 +7,25 @@
  */
 package org.opendaylight.yangtools.yang.parser.builder.impl;
 
+import com.google.common.base.Optional;
+import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSet;
+
+import java.net.URI;
 import java.util.ArrayList;
 import java.util.Collections;
-import java.util.HashSet;
+import java.util.Date;
+import java.util.Iterator;
 import java.util.List;
-import java.util.Map;
 import java.util.Set;
-import java.util.TreeMap;
-import java.util.TreeSet;
 
 import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.QNameModule;
 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
+import org.opendaylight.yangtools.yang.model.api.NamespaceRevisionAware;
 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 import org.opendaylight.yangtools.yang.model.api.Status;
@@ -27,41 +33,38 @@ import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.UsesNode;
 import org.opendaylight.yangtools.yang.model.util.RevisionAwareXPathImpl;
-import org.opendaylight.yangtools.yang.parser.builder.api.AbstractDataNodeContainerBuilder;
 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
+import org.opendaylight.yangtools.yang.parser.builder.api.Builder;
 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
+import org.opendaylight.yangtools.yang.parser.builder.api.UnknownSchemaNodeBuilder;
 import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder;
 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
-import org.opendaylight.yangtools.yang.parser.util.Comparators;
-import org.opendaylight.yangtools.yang.parser.util.ParserUtils;
+import org.opendaylight.yangtools.yang.parser.builder.util.AbstractDataNodeContainerBuilder;
 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
 
 public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContainerBuilder implements
         AugmentationSchemaBuilder {
-    private boolean built;
-    private final AugmentationSchemaImpl instance;
-
+    private final int order;
+    private AugmentationSchemaImpl instance;
     private String whenCondition;
+
     private String description;
     private String reference;
     private Status status = Status.CURRENT;
 
     private final String augmentTargetStr;
-    private SchemaPath dirtyAugmentTarget;
-    private SchemaPath finalAugmentTarget;
+    private final SchemaPath targetPath;
+    private SchemaPath targetNodeSchemaPath;
 
-    private final Set<UsesNodeBuilder> usesNodes = new HashSet<UsesNodeBuilder>();
     private boolean resolved;
+    private AugmentationSchemaBuilder copyOf;
 
-    private final static SchemaPath path = new SchemaPath(Collections.<QName> emptyList(), true);
-
-    AugmentationSchemaBuilderImpl(final String moduleName, final int line, final String augmentTargetStr) {
+    public AugmentationSchemaBuilderImpl(final String moduleName, final int line, final String augmentTargetStr, final int order) {
         super(moduleName, line, null);
+        this.order = order;
         this.augmentTargetStr = augmentTargetStr;
-        final SchemaPath targetPath = ParserUtils.parseXPathString(augmentTargetStr);
-        dirtyAugmentTarget = targetPath;
-        instance = new AugmentationSchemaImpl(targetPath);
+        targetPath = BuilderUtils.parseXPathString(augmentTargetStr);
     }
 
     @Override
@@ -75,66 +78,77 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
     }
 
     @Override
-    public void addGrouping(GroupingBuilder grouping) {
-        throw new YangParseException(moduleName, line, "augment can not contains grouping statement");
-    }
-
-    @Override
-    public void addUsesNode(UsesNodeBuilder usesBuilder) {
-        usesNodes.add(usesBuilder);
+    public void addGrouping(final GroupingBuilder grouping) {
+        throw new YangParseException(getModuleName(), grouping.getLine(), "augment can not contains grouping statement");
     }
 
     @Override
     public SchemaPath getPath() {
-        return path;
+        return targetNodeSchemaPath;
     }
 
     @Override
     public AugmentationSchema build() {
-        if (!built) {
-            // process uses
-            for (UsesNodeBuilder use : usesNodes) {
-                addedChildNodes.addAll(use.getTargetChildren());
-                addedUnknownNodes.addAll(use.getTargetUnknownNodes());
-            }
+        if (instance != null) {
+            return instance;
+        }
 
-            instance.setDescription(description);
-            instance.setReference(reference);
-            instance.setStatus(status);
-            instance.setTargetPath(finalAugmentTarget);
+        instance = new AugmentationSchemaImpl(targetPath, order);
 
-            RevisionAwareXPath whenStmt;
-            if (whenCondition == null) {
-                whenStmt = null;
-            } else {
-                whenStmt = new RevisionAwareXPathImpl(whenCondition, false);
-            }
-            instance.setWhenCondition(whenStmt);
+        instance.description = description;
+        instance.reference = reference;
+        instance.status = status;
 
-            // CHILD NODES
-            final Map<QName, DataSchemaNode> childs = new TreeMap<QName, DataSchemaNode>(Comparators.QNAME_COMP);
-            for (DataSchemaNodeBuilder node : addedChildNodes) {
-                childs.put(node.getQName(), node.build());
-            }
-            instance.setChildNodes(childs);
+        Builder parent = getParent();
+        if (parent instanceof ModuleBuilder) {
+            ModuleBuilder moduleBuilder = (ModuleBuilder) parent;
+            instance.namespace = moduleBuilder.getNamespace();
+            instance.revision = moduleBuilder.getRevision();
+        }
 
-            // USES
-            final Set<UsesNode> usesNodeDefinitions = new HashSet<UsesNode>();
-            for (UsesNodeBuilder builder : usesNodes) {
-                usesNodeDefinitions.add(builder.build());
-            }
-            instance.setUses(usesNodeDefinitions);
+        if (parent instanceof UsesNodeBuilder) {
+            final ModuleBuilder mb = BuilderUtils.getParentModule(this);
+            final QNameModule qm = QNameModule.create(mb.getNamespace(), mb.getRevision());
 
-            // UNKNOWN NODES
-            List<UnknownSchemaNode> unknownNodes = new ArrayList<UnknownSchemaNode>();
-            for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
-                unknownNodes.add(b.build());
+            List<QName> newPath = new ArrayList<>();
+            for (QName name : targetPath.getPathFromRoot()) {
+                newPath.add(QName.create(qm, name.getPrefix(), name.getLocalName()));
             }
-            Collections.sort(unknownNodes, Comparators.SCHEMA_NODE_COMP);
-            instance.setUnknownSchemaNodes(unknownNodes);
+            instance.targetPath = SchemaPath.create(newPath, false);
+        } else {
+            instance.targetPath = targetNodeSchemaPath;
+        }
+
+        if (copyOf != null) {
+            instance.setCopyOf(copyOf.build());
+        }
+
+        RevisionAwareXPath whenStmt;
+        if (whenCondition == null) {
+            whenStmt = null;
+        } else {
+            whenStmt = new RevisionAwareXPathImpl(whenCondition, false);
+        }
+        instance.whenCondition = whenStmt;
+
+        // CHILD NODES
+        for (DataSchemaNodeBuilder node : addedChildNodes) {
+            childNodes.put(node.getQName(), node.build());
+        }
+        instance.childNodes = ImmutableSet.copyOf(childNodes.values());
 
-            built = true;
+        // USES
+        for (UsesNodeBuilder builder : addedUsesNodes) {
+            usesNodes.add(builder.build());
         }
+        instance.uses = ImmutableSet.copyOf(usesNodes);
+
+        // UNKNOWN NODES
+        for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
+            unknownNodes.add(b.build());
+        }
+        instance.unknownNodes = ImmutableList.copyOf(unknownNodes);
+
         return instance;
     }
 
@@ -144,15 +158,17 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
     }
 
     @Override
-    public void setResolved(boolean resolved) {
+    public void setResolved(final boolean resolved) {
         this.resolved = resolved;
     }
 
+    @Override
     public String getWhenCondition() {
         return whenCondition;
     }
 
-    public void addWhenCondition(String whenCondition) {
+    @Override
+    public void addWhenCondition(final String whenCondition) {
         this.whenCondition = whenCondition;
     }
 
@@ -162,35 +178,38 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
     }
 
     @Override
-    public void addTypedef(TypeDefinitionBuilder type) {
-        throw new YangParseException(moduleName, line, "Augmentation can not contains typedef statement.");
+    public void addTypedef(final TypeDefinitionBuilder type) {
+        throw new YangParseException(getModuleName(), type.getLine(), "Augmentation can not contains typedef statement.");
     }
 
     @Override
-    public void setDescription(String description) {
+    public String getDescription() {
+        return description;
+    }
+
+    @Override
+    public void setDescription(final String description) {
         this.description = description;
     }
 
     @Override
-    public void setReference(String reference) {
-        this.reference = reference;
+    public String getReference() {
+        return reference;
     }
 
     @Override
-    public void setStatus(Status status) {
-        if (status != null) {
-            this.status = status;
-        }
+    public void setReference(final String reference) {
+        this.reference = reference;
     }
 
     @Override
-    public SchemaPath getTargetPath() {
-        return dirtyAugmentTarget;
+    public Status getStatus() {
+        return status;
     }
 
     @Override
-    public void setTargetPath(SchemaPath path) {
-        this.finalAugmentTarget = path;
+    public void setStatus(final Status status) {
+        this.status = Preconditions.checkNotNull(status, "status cannot be null");
     }
 
     @Override
@@ -198,18 +217,38 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
         return augmentTargetStr;
     }
 
+    @Override
+    public SchemaPath getTargetPath() {
+        return targetPath;
+    }
+
+    @Override
+    public SchemaPath getTargetNodeSchemaPath() {
+        return targetNodeSchemaPath;
+    }
+
+    @Override
+    public void setTargetNodeSchemaPath(final SchemaPath path) {
+        this.targetNodeSchemaPath = path;
+    }
+
+    @Override
+    public int getOrder() {
+        return order;
+    }
+
     @Override
     public int hashCode() {
         final int prime = 17;
         int result = 1;
         result = prime * result + ((augmentTargetStr == null) ? 0 : augmentTargetStr.hashCode());
         result = prime * result + ((whenCondition == null) ? 0 : whenCondition.hashCode());
-        result = prime * result + ((childNodes == null) ? 0 : childNodes.hashCode());
+        result = prime * result + ((addedChildNodes == null) ? 0 : addedChildNodes.hashCode());
         return result;
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(final Object obj) {
         if (this == obj) {
             return true;
         }
@@ -234,41 +273,58 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
         } else if (!whenCondition.equals(other.whenCondition)) {
             return false;
         }
-        if (childNodes == null) {
-            if (other.childNodes != null) {
+        if (addedChildNodes == null) {
+            if (other.addedChildNodes != null) {
                 return false;
             }
-        } else if (!childNodes.equals(other.childNodes)) {
+        } else if (!addedChildNodes.equals(other.addedChildNodes)) {
             return false;
         }
         return true;
     }
 
+    @Override
     public String toString() {
         return "augment " + augmentTargetStr;
     }
 
-    private final class AugmentationSchemaImpl implements AugmentationSchema {
+    public void setCopyOf(final AugmentationSchemaBuilder old) {
+        copyOf = old;
+    }
+
+    private static final class AugmentationSchemaImpl implements AugmentationSchema, NamespaceRevisionAware,
+            Comparable<AugmentationSchemaImpl> {
+        private final int order;
         private SchemaPath targetPath;
         private RevisionAwareXPath whenCondition;
-        private Map<QName, DataSchemaNode> childNodes = Collections.emptyMap();
-        private Set<UsesNode> uses = Collections.emptySet();
+        private ImmutableSet<DataSchemaNode> childNodes;
+        private ImmutableSet<UsesNode> uses;
         private String description;
         private String reference;
         private Status status;
-        private List<UnknownSchemaNode> unknownNodes = Collections.emptyList();
 
-        private AugmentationSchemaImpl(SchemaPath targetPath) {
+        private URI namespace;
+        private Date revision;
+        private ImmutableList<UnknownSchemaNode> unknownNodes;
+        private AugmentationSchema copyOf;
+
+        public AugmentationSchemaImpl(final SchemaPath targetPath, final int order) {
             this.targetPath = targetPath;
+            this.order = order;
+        }
+
+        public void setCopyOf(final AugmentationSchema build) {
+            this.copyOf = build;
         }
 
         @Override
-        public SchemaPath getTargetPath() {
-            return targetPath;
+        public Optional<AugmentationSchema> getOriginalDefinition() {
+            return Optional.fromNullable(this.copyOf);
         }
 
-        private void setTargetPath(SchemaPath path) {
-            this.targetPath = path;
+        @Override
+        public SchemaPath getTargetPath() {
+            return targetPath;
         }
 
         @Override
@@ -276,21 +332,9 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
             return whenCondition;
         }
 
-        private void setWhenCondition(RevisionAwareXPath whenCondition) {
-            this.whenCondition = whenCondition;
-        }
-
         @Override
         public Set<DataSchemaNode> getChildNodes() {
-            final Set<DataSchemaNode> result = new TreeSet<DataSchemaNode>(Comparators.SCHEMA_NODE_COMP);
-            result.addAll(childNodes.values());
-            return result;
-        }
-
-        private void setChildNodes(Map<QName, DataSchemaNode> childNodes) {
-            if (childNodes != null) {
-                this.childNodes = childNodes;
-            }
+            return childNodes;
         }
 
         /**
@@ -307,12 +351,6 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
             return uses;
         }
 
-        private void setUses(Set<UsesNode> uses) {
-            if (uses != null) {
-                this.uses = uses;
-            }
-        }
-
         /**
          * Always returns an empty set, because augment can not contains type
          * definitions.
@@ -327,54 +365,39 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
             return description;
         }
 
-        private void setDescription(String description) {
-            this.description = description;
-        }
-
         @Override
         public String getReference() {
             return reference;
         }
 
-        private void setReference(String reference) {
-            this.reference = reference;
-        }
-
         @Override
         public Status getStatus() {
             return status;
         }
 
-        private void setStatus(Status status) {
-            this.status = status;
-        }
-
         @Override
         public List<UnknownSchemaNode> getUnknownSchemaNodes() {
             return unknownNodes;
         }
 
-        private void setUnknownSchemaNodes(List<UnknownSchemaNode> unknownSchemaNodes) {
-            if (unknownSchemaNodes != null) {
-                this.unknownNodes = unknownSchemaNodes;
-            }
+        @Override
+        public DataSchemaNode getDataChildByName(final QName name) {
+            return getChildNode(childNodes, name);
         }
 
         @Override
-        public DataSchemaNode getDataChildByName(QName name) {
-            return childNodes.get(name);
+        public DataSchemaNode getDataChildByName(final String name) {
+            return getChildNode(childNodes, name);
         }
 
         @Override
-        public DataSchemaNode getDataChildByName(String name) {
-            DataSchemaNode result = null;
-            for (Map.Entry<QName, DataSchemaNode> entry : childNodes.entrySet()) {
-                if (entry.getKey().getLocalName().equals(name)) {
-                    result = entry.getValue();
-                    break;
-                }
-            }
-            return result;
+        public URI getNamespace() {
+            return namespace;
+        }
+
+        @Override
+        public Date getRevision() {
+            return revision;
         }
 
         @Override
@@ -388,7 +411,7 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
         }
 
         @Override
-        public boolean equals(Object obj) {
+        public boolean equals(final Object obj) {
             if (this == obj) {
                 return true;
             }
@@ -432,6 +455,26 @@ public final class AugmentationSchemaBuilderImpl extends AbstractDataNodeContain
             sb.append("]");
             return sb.toString();
         }
+
+        @Override
+        public int compareTo(final AugmentationSchemaImpl o) {
+            Iterator<QName> thisIt = this.targetPath.getPathFromRoot().iterator();
+            Iterator<QName> otherIt = o.getTargetPath().getPathFromRoot().iterator();
+            while (thisIt.hasNext()) {
+                if (otherIt.hasNext()) {
+                    int comp = thisIt.next().compareTo(otherIt.next());
+                    if (comp != 0) {
+                        return comp;
+                    }
+                } else {
+                    return 1;
+                }
+            }
+            if (otherIt.hasNext()) {
+                return -1;
+            }
+            return this.order - o.order;
+        }
     }
 
 }