yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/transform/base/serializer/NodeSerializerDispatcher.java

   1 /*
   2  * Copyright (c) 2013 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.data.impl.schema.transform.base.serializer;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.collect.Iterables;
  12 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  13 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  14 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  15 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  16 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  17 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  18 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  19 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  20 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  21 import org.opendaylight.yangtools.yang.data.api.schema.MixinNode;
  22 import org.opendaylight.yangtools.yang.data.impl.schema.transform.FromNormalizedNodeSerializerFactory;
  23 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  25 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  26 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  27 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  29
  30 /**
  31  *
  32  * Dispatches the serialization process of nodes according to schema and returns
  33  * the serialized elements.
  34  *
  35  * @param <E>
  36  *            type of serialized elements
  37  */
  38 public interface NodeSerializerDispatcher<E> {
  39
  40     Iterable<E> dispatchChildElement(Object childSchema,
  41             DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild);
  42
  43     /**
  44      * Abstract implementation that implements the dispatch conditions. Only
  45      * requires serializers to be provided. The same instance of serializer can
  46      * be provided in case it is immutable.
  47      */
  48     public static abstract class BaseNodeSerializerDispatcher<E> implements NodeSerializerDispatcher<E> {
  49         private final FromNormalizedNodeSerializerFactory<E> factory;
  50
  51         protected BaseNodeSerializerDispatcher(final FromNormalizedNodeSerializerFactory<E> factory) {
  52             this.factory = Preconditions.checkNotNull(factory);
  53         }
  54
  55         @Override
  56         public final Iterable<E> dispatchChildElement(Object childSchema,
  57                 DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild) {
  58             if (dataContainerChild instanceof ContainerNode) {
  59                 return onContainerNode(childSchema, dataContainerChild);
  60             } else if (dataContainerChild instanceof LeafNode<?>) {
  61                 return onLeafNode(childSchema, dataContainerChild);
  62             } else if (dataContainerChild instanceof AnyXmlNode) {
  63                 return onAnyXmlNode(childSchema, dataContainerChild);
  64             } else if (dataContainerChild instanceof MixinNode) {
  65                 if (dataContainerChild instanceof LeafSetNode<?>) {
  66                     return onLeafListNode(childSchema, dataContainerChild);
  67                 } else if (dataContainerChild instanceof MapNode) {
  68                     return onListNode(childSchema, dataContainerChild);
  69                 } else if (dataContainerChild instanceof ChoiceNode) {
  70                     return onChoiceNode(childSchema, dataContainerChild);
  71                 } else if (dataContainerChild instanceof AugmentationNode) {
  72                     return onAugmentationSchema(childSchema, dataContainerChild);
  73                 }
  74             }
  75             throw new IllegalArgumentException("Unable to serialize " + childSchema);
  76         }
  77
  78         private Iterable<E> onAugmentationSchema(Object childSchema,
  79                 DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild) {
  80             checkSchemaCompatibility(childSchema, AugmentationSchema.class, dataContainerChild);
  81             return factory.getAugmentationNodeSerializer().serialize((AugmentationSchema) childSchema,
  82                     (AugmentationNode) dataContainerChild);
  83         }
  84
  85         private Iterable<E> onChoiceNode(Object childSchema,
  86                 DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild) {
  87             checkSchemaCompatibility(childSchema, org.opendaylight.yangtools.yang.model.api.ChoiceNode.class,
  88                     dataContainerChild);
  89             return factory.getChoiceNodeSerializer()
  90                     .serialize((org.opendaylight.yangtools.yang.model.api.ChoiceNode) childSchema,
  91                             (ChoiceNode) dataContainerChild);
  92         }
  93
  94         private Iterable<E> onListNode(Object childSchema,
  95                 DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild) {
  96             checkSchemaCompatibility(childSchema, ListSchemaNode.class, dataContainerChild);
  97             return factory.getMapNodeSerializer().serialize((ListSchemaNode) childSchema, (MapNode) dataContainerChild);
  98         }
  99
 100         private Iterable<E> onLeafListNode(Object childSchema,
 101                 DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild) {
 102             checkSchemaCompatibility(childSchema, LeafListSchemaNode.class, dataContainerChild);
 103             return factory.getLeafSetNodeSerializer().serialize((LeafListSchemaNode) childSchema,
 104                     (LeafSetNode<?>) dataContainerChild);
 105         }
 106
 107         private Iterable<E> onLeafNode(Object childSchema,
 108                 DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild) {
 109             checkSchemaCompatibility(childSchema, LeafSchemaNode.class, dataContainerChild);
 110             Iterable<E> elements = factory.getLeafNodeSerializer().serialize((LeafSchemaNode) childSchema,
 111                     (LeafNode<?>) dataContainerChild);
 112             checkOnlyOneSerializedElement(elements, dataContainerChild);
 113             return elements;
 114         }
 115
 116         private Iterable<E> onAnyXmlNode(Object childSchema,
 117                 DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild) {
 118             checkSchemaCompatibility(childSchema, AnyXmlSchemaNode.class, dataContainerChild);
 119             Iterable<E> elements = factory.getAnyXmlNodeSerializer().serialize((AnyXmlSchemaNode) childSchema,
 120                     (AnyXmlNode) dataContainerChild);
 121             checkOnlyOneSerializedElement(elements, dataContainerChild);
 122             return elements;
 123         }
 124
 125         private static void checkOnlyOneSerializedElement(Iterable<?> elements,
 126                 DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild) {
 127             final int size = Iterables.size(elements);
 128             Preconditions.checkArgument(size == 1,
 129                     "Unexpected count of elements for entry serialized from: %s, should be 1, was: %s",
 130                     dataContainerChild, size);
 131         }
 132
 133         private Iterable<E> onContainerNode(Object childSchema,
 134                 DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild) {
 135             checkSchemaCompatibility(childSchema, ContainerSchemaNode.class, dataContainerChild);
 136
 137             Iterable<E> elements = factory.getContainerNodeSerializer().serialize((ContainerSchemaNode) childSchema,
 138                     (ContainerNode) dataContainerChild);
 139             checkOnlyOneSerializedElement(elements, dataContainerChild);
 140             return elements;
 141         }
 142
 143         private static void checkSchemaCompatibility(Object childSchema, Class<?> containerSchemaNodeClass,
 144                 DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild) {
 145             Preconditions.checkArgument(containerSchemaNodeClass.isAssignableFrom(childSchema.getClass()),
 146                     "Incompatible schema: %s with node: %s, expected: %s", childSchema, dataContainerChild,
 147                     containerSchemaNodeClass);
 148         }
 149     }
 150 }