binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/gen/impl/DataNodeContainerSerializerSource.java

   1 /*
   2  * Copyright (c) 2014, 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.mdsal.binding.dom.codec.gen.impl;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import java.util.HashMap;
  14 import java.util.Map;
  15 import org.opendaylight.mdsal.binding.dom.codec.util.BindingSchemaMapping;
  16 import org.opendaylight.mdsal.binding.dom.codec.util.ChoiceDispatchSerializer;
  17 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  18 import org.opendaylight.mdsal.binding.model.api.MethodSignature;
  19 import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
  20 import org.opendaylight.mdsal.binding.model.api.Type;
  21 import org.opendaylight.yangtools.yang.binding.BindingSerializer;
  22 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
  23 import org.opendaylight.yangtools.yang.binding.DataObject;
  24 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerImplementation;
  25 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerRegistry;
  26 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  27 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  30 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 abstract class DataNodeContainerSerializerSource extends DataObjectSerializerSource {
  38
  39     private static final Logger LOG = LoggerFactory.getLogger(DataNodeContainerSerializerSource.class);
  40
  41     protected static final String INPUT = "_input";
  42     private static final String CHOICE_PREFIX = "CHOICE_";
  43
  44     protected final DataNodeContainer schemaNode;
  45     private final GeneratedType dtoType;
  46
  47     DataNodeContainerSerializerSource(final AbstractGenerator generator, final GeneratedType type,
  48             final DataNodeContainer node) {
  49         super(generator);
  50         this.dtoType = requireNonNull(type);
  51         this.schemaNode = requireNonNull(node);
  52     }
  53
  54     /**
  55      * Return the character sequence which should be used for start event.
  56      *
  57      * @return Start event character sequence
  58      */
  59     protected abstract CharSequence emitStartEvent();
  60
  61     @Override
  62     protected CharSequence getSerializerBody() {
  63         final StringBuilder sb = new StringBuilder()
  64                 .append("{\n")
  65                 .append(statement(assign(DataObjectSerializerRegistry.class, REGISTRY, "$1")))
  66                 .append(statement(assign(dtoType, INPUT, cast(dtoType, "$2"))))
  67                 .append(statement(assign(BindingStreamEventWriter.class, STREAM,
  68                     cast(BindingStreamEventWriter.class, "$3"))))
  69                 .append(statement(assign(BindingSerializer.class, SERIALIZER, null)))
  70                 .append("if (")
  71                 .append(STREAM)
  72                 .append(" instanceof ")
  73                 .append(BindingSerializer.class.getName())
  74                 .append(") {")
  75                 .append(statement(assign(SERIALIZER, cast(BindingSerializer.class, STREAM))))
  76                 .append('}')
  77                 .append(statement(emitStartEvent()));
  78
  79         emitBody(sb);
  80         emitAfterBody(sb);
  81
  82         return sb.append(statement(endNode()))
  83                 .append(statement("return null"))
  84                 .append('}');
  85     }
  86
  87     /**
  88      * Allows for customization of emitting code, which is processed after
  89      * normal DataNodeContainer body. Ideal for augmentations or others.
  90      */
  91     protected void emitAfterBody(final StringBuilder sb) {
  92         // No-op
  93     }
  94
  95     private static Map<String, Type> collectAllProperties(final GeneratedType type, final Map<String, Type> hashMap) {
  96         for (final MethodSignature definition : type.getMethodDefinitions()) {
  97             hashMap.put(definition.getName(), definition.getReturnType());
  98         }
  99         for (final Type parent : type.getImplements()) {
 100             if (parent instanceof GeneratedType) {
 101                 collectAllProperties((GeneratedType) parent, hashMap);
 102             }
 103         }
 104         return hashMap;
 105     }
 106
 107     private void emitBody(final StringBuilder sb) {
 108         final Map<String, Type> getterToType = collectAllProperties(dtoType, new HashMap<String, Type>());
 109         for (final DataSchemaNode schemaChild : schemaNode.getChildNodes()) {
 110             if (!schemaChild.isAugmenting()) {
 111                 final String getter = BindingSchemaMapping.getGetterMethodName(schemaChild);
 112                 final Type childType = getterToType.get(getter);
 113                 checkState(childType != null, "Unable to find type for child node %s. Expected child nodes: %s",
 114                         schemaChild.getPath(), getterToType);
 115                 emitChild(sb, getter, childType, schemaChild);
 116             }
 117         }
 118     }
 119
 120     private void emitChild(final StringBuilder sb, final String getterName, final Type childType,
 121             final DataSchemaNode schemaChild) {
 122         sb.append(statement(assign(childType, getterName, cast(childType, invoke(INPUT, getterName)))));
 123
 124         sb.append("if (").append(getterName).append(" != null) {\n");
 125         emitChildInner(sb, getterName, childType, schemaChild);
 126         sb.append("}\n");
 127     }
 128
 129     private void emitChildInner(final StringBuilder sb, final String getterName, final Type childType,
 130             final DataSchemaNode child) {
 131         if (child instanceof LeafSchemaNode) {
 132             sb.append(statement(leafNode(child.getQName().getLocalName(), getterName)));
 133         } else if (child instanceof AnyXmlSchemaNode) {
 134             sb.append(statement(anyxmlNode(child.getQName().getLocalName(), getterName)));
 135         } else if (child instanceof LeafListSchemaNode) {
 136             final CharSequence startEvent;
 137             if (((LeafListSchemaNode) child).isUserOrdered()) {
 138                 startEvent = startOrderedLeafSet(child.getQName().getLocalName(),invoke(getterName, "size"));
 139             } else {
 140                 startEvent = startLeafSet(child.getQName().getLocalName(),invoke(getterName, "size"));
 141             }
 142             sb.append(statement(startEvent));
 143             final Type valueType = ((ParameterizedType) childType).getActualTypeArguments()[0];
 144             sb.append(forEach(getterName, valueType, statement(leafSetEntryNode(CURRENT))));
 145             sb.append(statement(endNode()));
 146         } else if (child instanceof ListSchemaNode) {
 147             final Type valueType = ((ParameterizedType) childType).getActualTypeArguments()[0];
 148             final ListSchemaNode casted = (ListSchemaNode) child;
 149             emitList(sb, getterName, valueType, casted);
 150         } else if (child instanceof ContainerSchemaNode) {
 151             sb.append(tryToUseCacheElse(getterName, statement(staticInvokeEmitter(childType, getterName))));
 152         } else if (child instanceof ChoiceSchemaNode) {
 153             final String propertyName = CHOICE_PREFIX + childType.getName();
 154             staticConstant(propertyName, DataObjectSerializerImplementation.class,
 155                 ChoiceDispatchSerializer.from(loadClass(childType)));
 156             sb.append(tryToUseCacheElse(getterName, statement(invoke(propertyName,
 157                 StreamWriterGenerator.SERIALIZE_METHOD_NAME, REGISTRY, cast(DataObject.class, getterName), STREAM))));
 158         }
 159     }
 160
 161     private static StringBuilder tryToUseCacheElse(final String getterName, final CharSequence statement) {
 162         return new StringBuilder()
 163                 .append("if (").append(SERIALIZER).append(" == null || ")
 164                 .append(invoke(SERIALIZER, "serialize", getterName)).append(" == null) {\n")
 165                 .append(statement)
 166                 .append('}');
 167     }
 168
 169     private void emitList(final StringBuilder sb, final String getterName, final Type valueType,
 170             final ListSchemaNode child) {
 171         final CharSequence startEvent;
 172
 173         sb.append(statement(assign("int", "_count", invoke(getterName, "size"))));
 174         if (child.getKeyDefinition().isEmpty()) {
 175             startEvent = startUnkeyedList(classReference(valueType), "_count");
 176         } else if (child.isUserOrdered()) {
 177             startEvent = startOrderedMapNode(classReference(valueType), "_count");
 178         } else {
 179             startEvent = startMapNode(classReference(valueType), "_count");
 180         }
 181         sb.append(statement(startEvent));
 182         sb.append(forEach(getterName, valueType, tryToUseCacheElse(CURRENT, statement(staticInvokeEmitter(valueType,
 183             CURRENT)))));
 184         sb.append(statement(endNode()));
 185     }
 186 }