binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/yangtools/binding/data/codec/impl/UnionTypeCodec.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.collect.ImmutableSet;
  11 import java.lang.reflect.Method;
  12 import java.util.LinkedHashSet;
  13 import java.util.Set;
  14 import java.util.concurrent.Callable;
  15 import org.opendaylight.yangtools.concepts.Codec;
  16 import org.opendaylight.yangtools.sal.binding.yang.types.BaseYangTypes;
  17 import org.opendaylight.yangtools.yang.binding.BindingMapping;
  18 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  19 import org.opendaylight.yangtools.yang.model.api.Module;
  20 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
  21 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  22 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  24 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
  25 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
  26 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
  27
  28 final class UnionTypeCodec extends ReflectionBasedCodec {
  29     private final ImmutableSet<UnionValueOptionContext> typeCodecs;
  30
  31     private UnionTypeCodec(final Class<?> unionCls,final Set<UnionValueOptionContext> codecs) {
  32         super(unionCls);
  33         this.typeCodecs = ImmutableSet.copyOf(codecs);
  34     }
  35
  36     static Callable<UnionTypeCodec> loader(final Class<?> unionCls, final UnionTypeDefinition unionType,
  37                                            final BindingCodecContext bindingCodecContext) {
  38         return () -> {
  39             final Set<UnionValueOptionContext> values = new LinkedHashSet<>();
  40             for (final TypeDefinition<?> subtype : unionType.getTypes()) {
  41                 if (subtype instanceof LeafrefTypeDefinition) {
  42                     addLeafrefValueCodec(unionCls, unionType, bindingCodecContext, values, subtype);
  43                 } else {
  44                     final Method valueGetter =
  45                             unionCls.getMethod("get" + BindingMapping.getClassName(subtype.getQName()));
  46                     final Class<?> valueType = valueGetter.getReturnType();
  47                     final Codec<Object, Object> valueCodec = bindingCodecContext.getCodec(valueType, subtype);
  48
  49                     values.add(new UnionValueOptionContext(unionCls, valueType, valueGetter, valueCodec));
  50                 }
  51             }
  52             return new UnionTypeCodec(unionCls, values);
  53         };
  54     }
  55
  56     /**
  57      * Prepare codec for type from leaf's return type of leafref.
  58      *
  59      * @param unionCls
  60      *            - union class
  61      * @param unionType
  62      *            - union type
  63      * @param bindingCodecContext
  64      *            - binding codec context
  65      * @param values
  66      *            - union values
  67      * @param subtype
  68      *            - subtype of union
  69      * @throws NoSuchMethodException
  70      */
  71     private static void addLeafrefValueCodec(final Class<?> unionCls, final UnionTypeDefinition unionType,
  72             final BindingCodecContext bindingCodecContext, final Set<UnionValueOptionContext> values,
  73             final TypeDefinition<?> subtype) throws NoSuchMethodException {
  74         final SchemaContext schemaContext = bindingCodecContext.getRuntimeContext().getSchemaContext();
  75         final Module module = schemaContext.findModuleByNamespaceAndRevision(
  76                 subtype.getQName().getNamespace(), subtype.getQName().getRevision());
  77         final RevisionAwareXPath xpath = ((LeafrefTypeDefinition) subtype).getPathStatement();
  78         // find schema node in schema context by xpath of leafref
  79         final SchemaNode dataNode;
  80         if (xpath.isAbsolute()) {
  81             dataNode = SchemaContextUtil.findDataSchemaNode(schemaContext, module, xpath);
  82         } else {
  83             dataNode = SchemaContextUtil.findDataSchemaNodeForRelativeXPath(schemaContext, module,
  84                     unionType, xpath);
  85         }
  86         final String className = BindingMapping.getClassName(unionCls.getSimpleName());
  87         final LeafSchemaNode typeNode = (LeafSchemaNode) dataNode;
  88
  89         // prepare name of type form return type of referenced leaf
  90         final String typeName = BindingMapping.getClassName(BaseYangTypes.BASE_YANG_TYPES_PROVIDER
  91                 .javaTypeForSchemaDefinitionType(typeNode.getType(), typeNode).getName());
  92
  93         // get method via reflection from generated code according to
  94         // get_TypeName_Value method
  95         final Method valueGetterParent = unionCls.getMethod(
  96                 new StringBuilder("get").append(typeName).append(className).append("Value").toString());
  97         final Class<?> returnType = valueGetterParent.getReturnType();
  98
  99         // prepare codec of union subtype according to return type of referenced
 100         // leaf
 101         final Codec<Object, Object> valueCodec = bindingCodecContext.getCodec(returnType, subtype);
 102         values.add(new UnionValueOptionContext(unionCls, returnType, valueGetterParent, valueCodec));
 103     }
 104
 105     @Override
 106     public Object deserialize(final Object input) {
 107         for (final UnionValueOptionContext member : this.typeCodecs) {
 108             final Object ret = member.deserializeUnion(input);
 109             if (ret != null) {
 110                 return ret;
 111             }
 112         }
 113
 114         throw new IllegalArgumentException(String.format("Failed to construct instance of %s for input %s",
 115             getTypeClass(), input));
 116     }
 117
 118     @Override
 119     public Object serialize(final Object input) {
 120         if (input != null) {
 121             for (final UnionValueOptionContext valCtx : this.typeCodecs) {
 122                 final Object domValue = valCtx.serialize(input);
 123                 if (domValue != null) {
 124                     return domValue;
 125                 }
 126             }
 127         }
 128         return null;
 129     }
 130 }