yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/effective/ListEffectiveStatementImpl.java

   1 /*
   2  * Copyright (c) 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.yangtools.yang.parser.stmt.rfc6020.effective;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.ImmutableSet;
  14 import java.util.Collection;
  15 import java.util.HashSet;
  16 import java.util.LinkedList;
  17 import java.util.List;
  18 import java.util.Objects;
  19 import java.util.Set;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  22 import org.opendaylight.yangtools.yang.model.api.ConstraintDefinition;
  23 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  26 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  30 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.TypeOfCopy;
  33 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.Utils;
  34
  35 public class ListEffectiveStatementImpl extends AbstractEffectiveDocumentedDataNodeContainer<QName, ListStatement>
  36         implements ListSchemaNode, DerivableSchemaNode {
  37     private final QName qname;
  38     private final SchemaPath path;
  39
  40     boolean augmenting;
  41     private boolean addedByUses;
  42     ListSchemaNode original;
  43     boolean configuration = true;
  44     ConstraintDefinition constraints;
  45     boolean userOrdered;
  46
  47     ImmutableList<QName> keyDefinition;
  48     ImmutableSet<AugmentationSchema> augmentations;
  49     ImmutableList<UnknownSchemaNode> unknownNodes;
  50
  51     public ListEffectiveStatementImpl(StmtContext<QName, ListStatement, EffectiveStatement<QName, ListStatement>> ctx) {
  52         super(ctx);
  53         this.qname = ctx.getStatementArgument();
  54         this.path = Utils.getSchemaPath(ctx);
  55         this.constraints = new EffectiveConstraintDefinitionImpl(this);
  56
  57         initSubstatementCollectionsAndFields();
  58         initCopyType(ctx);
  59
  60         // should be after initSubstatementCollectionsAndFields()
  61         initKeyDefinition(ctx);
  62     }
  63
  64     private void initCopyType(
  65             StmtContext<QName, ListStatement, EffectiveStatement<QName, ListStatement>> ctx) {
  66
  67         List<TypeOfCopy> copyTypesFromOriginal = ctx.getCopyHistory();
  68
  69         if(copyTypesFromOriginal.contains(TypeOfCopy.ADDED_BY_AUGMENTATION)) {
  70             augmenting = true;
  71         }
  72         if(copyTypesFromOriginal.contains(TypeOfCopy.ADDED_BY_USES)) {
  73             addedByUses = true;
  74         }
  75         if(copyTypesFromOriginal.contains(TypeOfCopy.ADDED_BY_USES_AUGMENTATION)) {
  76             addedByUses = augmenting = true;
  77         }
  78
  79         if (ctx.getOriginalCtx() != null) {
  80             original = (ListSchemaNode) ctx.getOriginalCtx().buildEffective();
  81         }
  82     }
  83
  84     private void initKeyDefinition(StmtContext<QName, ListStatement, EffectiveStatement<QName, ListStatement>> ctx) {
  85         List<QName> keyDefinitionInit = new LinkedList<>();
  86         KeyEffectiveStatementImpl keyEffectiveSubstatement = firstEffective(KeyEffectiveStatementImpl.class);
  87
  88         if (keyEffectiveSubstatement != null) {
  89             Set<QName> possibleLeafQNamesForKey = new HashSet<>();
  90
  91             for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
  92                 if (effectiveStatement instanceof LeafSchemaNode) {
  93                     possibleLeafQNamesForKey.add(((LeafSchemaNode) effectiveStatement).getQName());
  94                 }
  95             }
  96
  97             Collection<SchemaNodeIdentifier> keys = keyEffectiveSubstatement.argument();
  98             for (SchemaNodeIdentifier key : keys) {
  99                 final QName keyQName = key.getLastComponent();
 100
 101                 if (!possibleLeafQNamesForKey.contains(keyQName)) {
 102                     throw new IllegalArgumentException(String.format("Key '%s' misses node '%s' in list '%s', file %s",
 103                             keyEffectiveSubstatement.getDeclared().rawArgument(), keyQName.getLocalName(), ctx.getStatementArgument(),
 104                             ctx.getStatementSourceReference()));
 105                 }
 106
 107                 keyDefinitionInit.add(keyQName);
 108             }
 109         }
 110
 111         this.keyDefinition = ImmutableList.copyOf(keyDefinitionInit);
 112     }
 113
 114     private void initSubstatementCollectionsAndFields() {
 115         Collection<? extends EffectiveStatement<?, ?>> effectiveSubstatements = effectiveSubstatements();
 116
 117         List<UnknownSchemaNode> unknownNodesInit = new LinkedList<>();
 118         Set<AugmentationSchema> augmentationsInit = new HashSet<>();
 119
 120         boolean configurationInit = false;
 121         boolean userOrderedInit = false;
 122         for (EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements) {
 123             if (effectiveStatement instanceof UnknownSchemaNode) {
 124                 UnknownSchemaNode unknownNode = (UnknownSchemaNode) effectiveStatement;
 125                 unknownNodesInit.add(unknownNode);
 126             }
 127             if (effectiveStatement instanceof AugmentationSchema) {
 128                 AugmentationSchema augmentationSchema = (AugmentationSchema) effectiveStatement;
 129                 augmentationsInit.add(augmentationSchema);
 130             }
 131             if (!configurationInit && effectiveStatement instanceof ConfigEffectiveStatementImpl) {
 132                 ConfigEffectiveStatementImpl configStmt = (ConfigEffectiveStatementImpl) effectiveStatement;
 133                 this.configuration = configStmt.argument();
 134                 configurationInit = true;
 135             }
 136             if (!userOrderedInit && effectiveStatement instanceof OrderedByEffectiveStatementImpl) {
 137                 OrderedByEffectiveStatementImpl orderedByStmt = (OrderedByEffectiveStatementImpl) effectiveStatement;
 138                 this.userOrdered = orderedByStmt.argument().equals("user") ? true : false;
 139                 userOrderedInit = true;
 140             }
 141         }
 142
 143         this.unknownNodes = ImmutableList.copyOf(unknownNodesInit);
 144         this.augmentations = ImmutableSet.copyOf(augmentationsInit);
 145     }
 146
 147     @Override
 148     public QName getQName() {
 149         return qname;
 150     }
 151
 152     @Override
 153     public SchemaPath getPath() {
 154         return path;
 155     }
 156
 157     @Override
 158     public List<QName> getKeyDefinition() {
 159         return keyDefinition;
 160     }
 161
 162     @Override
 163     public boolean isAugmenting() {
 164         return augmenting;
 165     }
 166
 167     @Override
 168     public boolean isAddedByUses() {
 169         return addedByUses;
 170     }
 171
 172     @Override
 173     public Optional<ListSchemaNode> getOriginal() {
 174         return Optional.fromNullable(original);
 175     }
 176
 177     @Override
 178     public boolean isConfiguration() {
 179         return configuration;
 180     }
 181
 182     @Override
 183     public ConstraintDefinition getConstraints() {
 184         return constraints;
 185     }
 186
 187     @Override
 188     public Set<AugmentationSchema> getAvailableAugmentations() {
 189         return augmentations;
 190     }
 191
 192     @Override
 193     public boolean isUserOrdered() {
 194         return userOrdered;
 195     }
 196
 197     @Override
 198     public List<UnknownSchemaNode> getUnknownSchemaNodes() {
 199         return unknownNodes;
 200     }
 201
 202     @Override
 203     public int hashCode() {
 204         final int prime = 31;
 205         int result = 1;
 206         result = prime * result + Objects.hashCode(qname);
 207         result = prime * result + Objects.hashCode(path);
 208         return result;
 209     }
 210
 211     @Override
 212     public boolean equals(final Object obj) {
 213         if (this == obj) {
 214             return true;
 215         }
 216         if (obj == null) {
 217             return false;
 218         }
 219         if (getClass() != obj.getClass()) {
 220             return false;
 221         }
 222         final ListEffectiveStatementImpl other = (ListEffectiveStatementImpl) obj;
 223         if (qname == null) {
 224             if (other.qname != null) {
 225                 return false;
 226             }
 227         } else if (!qname.equals(other.qname)) {
 228             return false;
 229         }
 230         if (path == null) {
 231             if (other.path != null) {
 232                 return false;
 233             }
 234         } else if (!path.equals(other.path)) {
 235             return false;
 236         }
 237         return true;
 238     }
 239
 240     @Override
 241     public String toString() {
 242         return "list " + qname.getLocalName();
 243     }
 244 }