yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/AbstractSchemaContext.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.model.util;
  10
  11 import com.google.common.collect.SetMultimap;
  12 import java.net.URI;
  13 import java.util.ArrayList;
  14 import java.util.Collections;
  15 import java.util.Comparator;
  16 import java.util.Date;
  17 import java.util.HashSet;
  18 import java.util.LinkedHashSet;
  19 import java.util.List;
  20 import java.util.Objects;
  21 import java.util.Optional;
  22 import java.util.Set;
  23 import java.util.TreeSet;
  24 import javax.annotation.Nonnull;
  25 import org.opendaylight.yangtools.yang.common.QName;
  26 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  27 import org.opendaylight.yangtools.yang.model.api.ConstraintDefinition;
  28 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
  30 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  31 import org.opendaylight.yangtools.yang.model.api.Module;
  32 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  33 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  34 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  35 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  36 import org.opendaylight.yangtools.yang.model.api.Status;
  37 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  38 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  39 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  40
  41 public abstract class AbstractSchemaContext implements SchemaContext {
  42     protected static final Comparator<Module> REVISION_COMPARATOR = (o1, o2) -> {
  43         if (o1.getRevision() == null) {
  44             return o2.getRevision() == null ? 0 : 1;
  45         }
  46
  47         return o2.getRevision() == null ? -1 : o2.getRevision().compareTo(o1.getRevision());
  48     };
  49
  50     protected static final TreeSet<Module> createModuleSet() {
  51         return new TreeSet<>(REVISION_COMPARATOR);
  52     }
  53
  54     /**
  55      * Returns the namespace-to-module mapping.
  56      *
  57      * @return Map of modules where key is namespace
  58      */
  59     protected abstract SetMultimap<URI, Module> getNamespaceToModules();
  60
  61     /**
  62      * Returns the module name-to-module mapping.
  63      *
  64      * @return Map of modules where key is name of module
  65      */
  66     protected abstract SetMultimap<String, Module> getNameToModules();
  67
  68     @Override
  69     public Set<DataSchemaNode> getDataDefinitions() {
  70         final Set<DataSchemaNode> dataDefs = new HashSet<>();
  71         for (Module m : getModules()) {
  72             dataDefs.addAll(m.getChildNodes());
  73         }
  74         return dataDefs;
  75     }
  76
  77     @Override
  78     public Set<NotificationDefinition> getNotifications() {
  79         final Set<NotificationDefinition> notifications = new HashSet<>();
  80         for (Module m : getModules()) {
  81             notifications.addAll(m.getNotifications());
  82         }
  83         return notifications;
  84     }
  85
  86     @Override
  87     public Set<RpcDefinition> getOperations() {
  88         final Set<RpcDefinition> rpcs = new HashSet<>();
  89         for (Module m : getModules()) {
  90             rpcs.addAll(m.getRpcs());
  91         }
  92         return rpcs;
  93     }
  94
  95     @Override
  96     public Set<ExtensionDefinition> getExtensions() {
  97         final Set<ExtensionDefinition> extensions = new HashSet<>();
  98         for (Module m : getModules()) {
  99             extensions.addAll(m.getExtensionSchemaNodes());
 100         }
 101         return extensions;
 102     }
 103
 104
 105     @Override
 106     public Optional<Module> findModule(final String name, final Date revision) {
 107         for (final Module module : getNameToModules().get(name)) {
 108             if (Objects.equals(revision, module.getRevision())) {
 109                 return Optional.of(module);
 110             }
 111         }
 112
 113         return Optional.empty();
 114     }
 115
 116     @Override
 117     public Set<Module> findModules(final URI namespace) {
 118         final Set<Module> ret = getNamespaceToModules().get(namespace);
 119         return ret == null ? Collections.emptySet() : ret;
 120     }
 121
 122     @Override
 123     public boolean isAugmenting() {
 124         return false;
 125     }
 126
 127     @Override
 128     public boolean isAddedByUses() {
 129         return false;
 130     }
 131
 132     @Override
 133     public boolean isConfiguration() {
 134         return false;
 135     }
 136
 137     @Override
 138     public ConstraintDefinition getConstraints() {
 139         return null;
 140     }
 141
 142     @Nonnull
 143     @Override
 144     public QName getQName() {
 145         return SchemaContext.NAME;
 146     }
 147
 148     @Nonnull
 149     @Override
 150     public SchemaPath getPath() {
 151         return SchemaPath.ROOT;
 152     }
 153
 154     @Override
 155     public String getDescription() {
 156         return null;
 157     }
 158
 159     @Override
 160     public String getReference() {
 161         return null;
 162     }
 163
 164     @Nonnull
 165     @Override
 166     public Status getStatus() {
 167         return Status.CURRENT;
 168     }
 169
 170     @Nonnull
 171     @Override
 172     public List<UnknownSchemaNode> getUnknownSchemaNodes() {
 173         final List<UnknownSchemaNode> result = new ArrayList<>();
 174         for (Module module : getModules()) {
 175             result.addAll(module.getUnknownSchemaNodes());
 176         }
 177         return Collections.unmodifiableList(result);
 178     }
 179
 180     @Override
 181     public Set<TypeDefinition<?>> getTypeDefinitions() {
 182         final Set<TypeDefinition<?>> result = new LinkedHashSet<>();
 183         for (Module module : getModules()) {
 184             result.addAll(module.getTypeDefinitions());
 185         }
 186         return Collections.unmodifiableSet(result);
 187     }
 188
 189     @Override
 190     public Set<DataSchemaNode> getChildNodes() {
 191         final Set<DataSchemaNode> result = new LinkedHashSet<>();
 192         for (Module module : getModules()) {
 193             result.addAll(module.getChildNodes());
 194         }
 195         return Collections.unmodifiableSet(result);
 196     }
 197
 198     @Override
 199     public Set<GroupingDefinition> getGroupings() {
 200         final Set<GroupingDefinition> result = new LinkedHashSet<>();
 201         for (Module module : getModules()) {
 202             result.addAll(module.getGroupings());
 203         }
 204         return Collections.unmodifiableSet(result);
 205     }
 206
 207     @Override
 208     public DataSchemaNode getDataChildByName(final QName name) {
 209         for (Module module : getModules()) {
 210             final DataSchemaNode result = module.getDataChildByName(name);
 211             if (result != null) {
 212                 return result;
 213             }
 214         }
 215         return null;
 216     }
 217
 218     @Override
 219     public Set<UsesNode> getUses() {
 220         return Collections.emptySet();
 221     }
 222
 223     @Override
 224     public boolean isPresenceContainer() {
 225         return false;
 226     }
 227
 228     @Override
 229     public Set<AugmentationSchema> getAvailableAugmentations() {
 230         return Collections.emptySet();
 231     }
 232 }