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.ContainerSchemaNode;
  27 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  30
  31 /**
  32  *
  33  * Dispatches the serialization process of nodes according to schema and returns
  34  * the serialized elements.
  35  *
  36  * @param <E>
  37  *            type of serialized elements
  38  */
  39 public interface NodeSerializerDispatcher<E> {
  40
  41     Iterable<E> dispatchChildElement(Object childSchema,
  42             DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild);
  43
  44     /**
  45      * Abstract implementation that implements the dispatch conditions. Only
  46      * requires serializers to be provided. The same instance of serializer can
  47      * be provided in case it is immutable.
  48      */
  49     public static abstract class BaseNodeSerializerDispatcher<E> implements NodeSerializerDispatcher<E> {
  50         private final FromNormalizedNodeSerializerFactory<E> factory;
  51
  52         protected BaseNodeSerializerDispatcher(final FromNormalizedNodeSerializerFactory<E> factory) {
  53             this.factory = Preconditions.checkNotNull(factory);
  54         }
  55
  56         @Override
  57         public final Iterable<E> dispatchChildElement(Object childSchema,
  58                 DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild) {
  59             if (dataContainerChild instanceof ContainerNode) {
  60                 return onContainerNode(childSchema, dataContainerChild);
  61             } else if (dataContainerChild instanceof LeafNode<?>) {
  62                 return onLeafNode(childSchema, dataContainerChild);
  63             } else if (dataContainerChild instanceof AnyXmlNode) {
  64                 return onAnyXmlNode(childSchema, dataContainerChild);
  65             } else if (dataContainerChild instanceof MixinNode) {
  66                 if (dataContainerChild instanceof LeafSetNode<?>) {
  67                     return onLeafListNode(childSchema, dataContainerChild);
  68                 } else if (dataContainerChild instanceof MapNode) {
  69                     return onMapNode(childSchema, dataContainerChild);
  70                 } else if (dataContainerChild instanceof  UnkeyedListNode) {
  71                     return onUnkeyedListNode(childSchema, dataContainerChild);
  72                 } else if (dataContainerChild instanceof ChoiceNode) {
  73                     return onChoiceNode(childSchema, dataContainerChild);
  74                 } else if (dataContainerChild instanceof AugmentationNode) {
  75                     return onAugmentationSchema(childSchema, dataContainerChild);
  76                 }
  77             }
  78             throw new IllegalArgumentException("Unable to serialize " + childSchema);
  79         }
  80
  81         private Iterable<E> onAugmentationSchema(Object childSchema,
  82                 DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild) {
  83             checkSchemaCompatibility(childSchema, AugmentationSchema.class, dataContainerChild);
  84             return factory.getAugmentationNodeSerializer().serialize((AugmentationSchema) childSchema,
  85                     (AugmentationNode) dataContainerChild);
  86         }
  87
  88         private Iterable<E> onChoiceNode(Object childSchema,
  89                 DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataContainerChild) {
  90             checkSchemaCompatibility(childSchema, org.opendaylight.yangtools.yang.model.api.ChoiceNode.class,
  91                     dataContainerChild);
  92             return factory.getChoiceNodeSerializer()
  93                     .serialize((org.opendaylight.yangtools.yang.model.api.ChoiceNode) childSchema,
  94                             (ChoiceNode) dataContainerChild);
  95         }
  96
  97         private Iterable<E> onMapNode(Object childSchema,
  98                 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(Object childSchema,
 104                 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(Object childSchema,
 110                 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(Object childSchema,
 117                 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(Object childSchema,
 126                 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(Iterable<?> elements,
 135                 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(Object childSchema,
 143                 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(Object childSchema, Class<?> containerSchemaNodeClass,
 153                 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 }