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