yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/transform/base/parser/ListNodeBaseParser.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.parser;
   9
  10 import java.util.Collections;
  11 import java.util.Map;
  12 import org.opendaylight.yangtools.yang.common.QName;
  13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  14 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  15 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  16 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
  17 import org.opendaylight.yangtools.yang.data.impl.schema.transform.ToNormalizedNodeParser;
  18 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  19
  20 /**
  21  * Abstract(base) parser for ListNodes (MapNode, UnkeyedListNode), parses elements of type E.
  22  *
  23  * @param <E>
  24  *            type of elements to be parsed
  25  */
  26 public abstract class ListNodeBaseParser<E, N extends NormalizedNode<?, ?>, O extends NormalizedNode<YangInstanceIdentifier.NodeIdentifier, ?>, S extends ListSchemaNode>
  27         implements ExtensibleParser<YangInstanceIdentifier.NodeIdentifier, E, O, S> {
  28
  29     private final BuildingStrategy<YangInstanceIdentifier.NodeIdentifier, O> buildingStrategy;
  30
  31     public ListNodeBaseParser() {
  32         buildingStrategy = new SimpleListNodeBuildingStrategy<>();
  33     }
  34
  35     public ListNodeBaseParser(final BuildingStrategy<YangInstanceIdentifier.NodeIdentifier, O> buildingStrategy) {
  36         this.buildingStrategy = buildingStrategy;
  37     }
  38
  39     @Override
  40     public O parse(Iterable<E> childNodes, S schema) {
  41         CollectionNodeBuilder<N, O> listBuilder = provideBuilder(schema);
  42
  43         buildingStrategy.prepareAttributes(Collections.<QName, String>emptyMap(), listBuilder);
  44
  45         for (E childNode : childNodes) {
  46             N listChild = getListEntryNodeParser().parse(Collections.singletonList(childNode), schema);
  47             if (listChild != null) {
  48                 listBuilder.withChild(listChild);
  49             }
  50         }
  51
  52         return buildingStrategy.build(listBuilder);
  53     }
  54
  55     /**
  56      *
  57      * @return parser for inner ListEntryNodes used to parse every entry of ListNode, might be the same instance in case
  58      *         its immutable
  59      */
  60     protected abstract ToNormalizedNodeParser<E, N, S> getListEntryNodeParser();
  61
  62     /**
  63      *
  64      * @return prepares builder which will contain entries of list according to concrete list type
  65      */
  66     protected abstract CollectionNodeBuilder<N, O> provideBuilder(S schema);
  67
  68     @Override
  69     public BuildingStrategy<YangInstanceIdentifier.NodeIdentifier, O> getBuildingStrategy() {
  70         return buildingStrategy;
  71     }
  72
  73     public static class SimpleListNodeBuildingStrategy<O extends NormalizedNode<YangInstanceIdentifier.NodeIdentifier, ?>> implements BuildingStrategy<YangInstanceIdentifier.NodeIdentifier, O> {
  74         @Override
  75         public O build(final NormalizedNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ?, O> builder) {
  76             return builder.build();
  77         }
  78
  79         @Override
  80         public void prepareAttributes(final Map<QName, String> attributes, final NormalizedNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ?, O> containerBuilder) {
  81             // NOOP
  82         }
  83     }
  84 }