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