code-generator/binding-data-codec/src/main/java/org/opendaylight/yangtools/binding/data/codec/impl/DataObjectCodecContext.java

   1 /*
   2  * Copyright (c) 2014 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.binding.data.codec.impl;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.ImmutableMap;
  13
  14 import java.lang.reflect.Method;
  15 import java.util.Collection;
  16 import java.util.HashMap;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Map.Entry;
  20
  21 import org.opendaylight.yangtools.sal.binding.generator.api.ClassLoadingStrategy;
  22 import org.opendaylight.yangtools.sal.binding.model.api.Type;
  23 import org.opendaylight.yangtools.yang.binding.Augmentable;
  24 import org.opendaylight.yangtools.yang.binding.Augmentation;
  25 import org.opendaylight.yangtools.yang.binding.DataObject;
  26 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  27 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
  28 import org.opendaylight.yangtools.yang.common.QName;
  29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  36 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  37 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  38 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  39 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 abstract class DataObjectCodecContext<T extends DataNodeContainer> extends DataContainerCodecContext<T> {
  44     private static final Logger LOG = LoggerFactory.getLogger(DataObjectCodecContext.class);
  45
  46     private final ImmutableMap<String, LeafNodeCodecContext> leafChild;
  47     private final ImmutableMap<YangInstanceIdentifier.PathArgument, NodeContextSupplier> byYang;
  48     private final ImmutableMap<Method, NodeContextSupplier> byMethod;
  49     private final ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> byStreamClass;
  50     private final ImmutableMap<Class<?>, DataContainerCodecPrototype<?>> byBindingArgClass;
  51     protected final Method augmentationGetter;
  52
  53     protected DataObjectCodecContext(final DataContainerCodecPrototype<T> prototype) {
  54         super(prototype);
  55
  56         this.leafChild = factory().getLeafNodes(bindingClass(), schema());
  57
  58         Map<Class<?>, Method> clsToMethod = BindingReflections.getChildrenClassToMethod(bindingClass());
  59
  60         Map<YangInstanceIdentifier.PathArgument, NodeContextSupplier> byYangBuilder = new HashMap<>();
  61         Map<Method, NodeContextSupplier> byMethodBuilder = new HashMap<>();
  62         Map<Class<?>, DataContainerCodecPrototype<?>> byStreamClassBuilder = new HashMap<>();
  63         Map<Class<?>, DataContainerCodecPrototype<?>> byBindingArgClassBuilder = new HashMap<>();
  64
  65         // Adds leaves to mapping
  66         for (LeafNodeCodecContext leaf : leafChild.values()) {
  67             byMethodBuilder.put(leaf.getGetter(), leaf);
  68             byYangBuilder.put(leaf.getDomPathArgument(), leaf);
  69         }
  70
  71         for (Entry<Class<?>, Method> childDataObj : clsToMethod.entrySet()) {
  72             DataContainerCodecPrototype<?> childProto = loadChildPrototype(childDataObj.getKey());
  73             byMethodBuilder.put(childDataObj.getValue(), childProto);
  74             byStreamClassBuilder.put(childProto.getBindingClass(), childProto);
  75             byYangBuilder.put(childProto.getYangArg(), childProto);
  76             if (childProto.isChoice()) {
  77                 ChoiceNodeCodecContext choice = (ChoiceNodeCodecContext) childProto.get();
  78                 for(Class<?> cazeChild : choice.getCaseChildrenClasses()) {
  79                     byBindingArgClassBuilder.put(cazeChild, childProto);
  80                 }
  81             }
  82         }
  83         this.byMethod = ImmutableMap.copyOf(byMethodBuilder);
  84         if (Augmentable.class.isAssignableFrom(bindingClass())) {
  85             try {
  86                 augmentationGetter = bindingClass().getMethod("getAugmentation", Class.class);
  87             } catch (NoSuchMethodException | SecurityException e) {
  88                throw new IllegalStateException("Could not get required method.",e);
  89             }
  90             ImmutableMap<AugmentationIdentifier, Type> augmentations = factory().getRuntimeContext()
  91                     .getAvailableAugmentationTypes(schema());
  92             for (Entry<AugmentationIdentifier, Type> augment : augmentations.entrySet()) {
  93                 DataContainerCodecPrototype<?> augProto = getAugmentationPrototype(augment.getValue());
  94                 if (augProto != null) {
  95                     byYangBuilder.put(augProto.getYangArg(), augProto);
  96                     byStreamClassBuilder.put(augProto.getBindingClass(), augProto);
  97                 }
  98             }
  99         } else {
 100             augmentationGetter = null;
 101         }
 102
 103         this.byYang = ImmutableMap.copyOf(byYangBuilder);
 104         this.byStreamClass = ImmutableMap.copyOf(byStreamClassBuilder);
 105         byBindingArgClassBuilder.putAll(byStreamClass);
 106         this.byBindingArgClass = ImmutableMap.copyOf(byBindingArgClassBuilder);
 107     }
 108
 109     @Override
 110     protected DataContainerCodecContext<?> getStreamChild(final Class<?> childClass) {
 111         DataContainerCodecPrototype<?> childProto = byStreamClass.get(childClass);
 112         Preconditions.checkArgument(childProto != null, " Child %s is not valid child.",childClass);
 113         return childProto.get();
 114     }
 115
 116     @Override
 117     protected DataContainerCodecContext<?> getIdentifierChild(final InstanceIdentifier.PathArgument arg,
 118             final List<YangInstanceIdentifier.PathArgument> builder) {
 119
 120         Class<? extends DataObject> argType = arg.getType();
 121         DataContainerCodecPrototype<?> ctxProto = byBindingArgClass.get(argType);
 122         Preconditions.checkArgument(ctxProto != null,"Invalid child");
 123
 124         DataContainerCodecContext<?> context = ctxProto.get();
 125         if(context instanceof ChoiceNodeCodecContext) {
 126             ChoiceNodeCodecContext casted = (ChoiceNodeCodecContext) context;
 127             casted.addYangPathArgument(arg, builder);
 128             DataContainerCodecContext<?> caze = casted.getCazeByChildClass(arg.getType());
 129             caze.addYangPathArgument(arg, builder);
 130             return caze.getIdentifierChild(arg, builder);
 131         }
 132         context.addYangPathArgument(arg, builder);
 133         return context;
 134     }
 135
 136     @Override
 137     protected NodeCodecContext getYangIdentifierChild(YangInstanceIdentifier.PathArgument arg) {
 138         if(arg instanceof NodeIdentifierWithPredicates) {
 139             arg = new NodeIdentifier(arg.getNodeType());
 140         }
 141         NodeContextSupplier childSupplier = byYang.get(arg);
 142         Preconditions.checkArgument(childSupplier != null, "Argument %s is not valid child of %s", arg, schema());
 143         return childSupplier.get();
 144     }
 145
 146     protected final LeafNodeCodecContext getLeafChild(final String name) {
 147         final LeafNodeCodecContext value = leafChild.get(name);
 148         Preconditions.checkArgument(value != null, "Leaf %s is not valid for %s", name, bindingClass());
 149         return value;
 150     }
 151
 152     private DataContainerCodecPrototype<?> loadChildPrototype(final Class<?> childClass) {
 153         DataSchemaNode origDef = factory().getRuntimeContext().getSchemaDefinition(childClass);
 154         // Direct instantiation or use in same module in which grouping
 155         // was defined.
 156         DataSchemaNode sameName;
 157         try {
 158             sameName = schema().getDataChildByName(origDef.getQName());
 159         } catch (IllegalArgumentException e) {
 160             sameName = null;
 161         }
 162         final DataSchemaNode childSchema;
 163         if (sameName != null) {
 164             // Exactly same schema node
 165             if (origDef.equals(sameName)) {
 166                 childSchema = sameName;
 167                 // We check if instantiated node was added via uses
 168                 // statement and is instantiation of same grouping
 169             } else if (origDef.equals(SchemaNodeUtils.getRootOriginalIfPossible(sameName))) {
 170                 childSchema = sameName;
 171             } else {
 172                 // Node has same name, but clearly is different
 173                 childSchema = null;
 174             }
 175         } else {
 176             // We are looking for instantiation via uses in other module
 177             QName instantiedName = QName.create(namespace(), origDef.getQName().getLocalName());
 178             DataSchemaNode potential = schema().getDataChildByName(instantiedName);
 179             // We check if it is really instantiated from same
 180             // definition as class was derived
 181             if (potential != null && origDef.equals(SchemaNodeUtils.getRootOriginalIfPossible(potential))) {
 182                 childSchema = potential;
 183             } else {
 184                 childSchema = null;
 185             }
 186         }
 187         Preconditions.checkArgument(childSchema != null, "Node %s does not have child named %s", schema(), childClass);
 188         return DataContainerCodecPrototype.from(childClass, childSchema, factory());
 189     }
 190
 191     private DataContainerCodecPrototype<?> getAugmentationPrototype(final Type value) {
 192         ClassLoadingStrategy loader = factory().getRuntimeContext().getStrategy();
 193         @SuppressWarnings("rawtypes")
 194         final Class augClass;
 195         try {
 196             augClass = loader.loadClass(value);
 197         } catch (ClassNotFoundException e) {
 198             LOG.warn("Failed to load augmentation prototype for {}", value, e);
 199             return null;
 200         }
 201
 202         Entry<AugmentationIdentifier, AugmentationSchema> augSchema = factory().getRuntimeContext()
 203                 .getResolvedAugmentationSchema(schema(), augClass);
 204         return DataContainerCodecPrototype.from(augClass, augSchema.getKey(), augSchema.getValue(), factory());
 205     }
 206
 207     @SuppressWarnings("rawtypes")
 208     Object getBindingChildValue(final Method method, final NormalizedNodeContainer domData) {
 209         NodeCodecContext childContext = byMethod.get(method).get();
 210         Optional<NormalizedNode<?, ?>> domChild = domData.getChild(childContext.getDomPathArgument());
 211         if (domChild.isPresent()) {
 212             return childContext.dataFromNormalizedNode(domChild.get());
 213         }
 214         return null;
 215     }
 216
 217     public Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAllAugmentationsFrom(
 218             final NormalizedNodeContainer<?, PathArgument, NormalizedNode<?, ?>> data) {
 219
 220         @SuppressWarnings("rawtypes")
 221         Map map = new HashMap<>();
 222
 223         for(DataContainerCodecPrototype<?> value : byStreamClass.values()) {
 224             if(Augmentation.class.isAssignableFrom(value.getBindingClass())) {
 225                 Optional<NormalizedNode<?, ?>> augData = data.getChild(value.getYangArg());
 226                 if(augData.isPresent()) {
 227                     map.put(value.getBindingClass(), value.get().dataFromNormalizedNode(augData.get()));
 228                 }
 229             }
 230         }
 231         return map;
 232     }
 233
 234     public Collection<Method> getHashCodeAndEqualsMethods() {
 235         // FIXME: Sort method in same order as in hashCode for generated class.
 236         return byMethod.keySet();
 237     }
 238
 239 }