yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/transform/dom/parser/DomToNormalizedNodeParserFactory.java

   1 /*
   2  * Copyright (c) 2014 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.dom.parser;
   9
  10 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  11 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  12 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  13 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  14 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  15 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  16 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  17 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  18 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  19 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  20 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
  21 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  23 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlCodecProvider;
  24 import org.opendaylight.yangtools.yang.data.impl.schema.transform.ToNormalizedNodeParser;
  25 import org.opendaylight.yangtools.yang.data.impl.schema.transform.ToNormalizedNodeParserFactory;
  26 import org.opendaylight.yangtools.yang.data.impl.schema.transform.base.parser.BaseDispatcherParser;
  27 import org.opendaylight.yangtools.yang.data.impl.schema.transform.base.parser.ExtensibleParser;
  28 import org.opendaylight.yangtools.yang.data.impl.schema.transform.base.parser.LeafNodeBaseParser;
  29 import org.opendaylight.yangtools.yang.data.impl.schema.transform.base.parser.LeafSetEntryNodeBaseParser;
  30 import org.opendaylight.yangtools.yang.data.impl.schema.transform.base.parser.ListNodeBaseParser;
  31 import org.opendaylight.yangtools.yang.data.impl.schema.transform.base.parser.NodeParserDispatcher;
  32 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  34 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  36 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  37 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  38 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  39 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  40 import org.w3c.dom.Element;
  41
  42 public final class DomToNormalizedNodeParserFactory implements ToNormalizedNodeParserFactory<Element> {
  43
  44     private final AugmentationNodeDomParser augmentationNodeParser;
  45     private final ChoiceNodeDomParser choiceNodeParser;
  46     private final ContainerNodeDomParser containerNodeParser;
  47     private final LeafNodeDomParser leafNodeParser;
  48     private final LeafSetEntryNodeDomParser leafSetEntryNodeParser;
  49     private final LeafSetNodeDomParser leafSetNodeParser;
  50     private final MapNodeDomParser mapNodeParser;
  51     private final MapEntryNodeDomParser mapEntryNodeParser;
  52     private final UnkeyedListEntryNodeDomParser unkeyedListEntryNodeParser;
  53     private final UnkeyedListNodeDomParser unkeyedListNodeParser;
  54     private final OrderedListNodeDomParser orderedListNodeParser;
  55     private final AnyXmlDomParser anyXmlNodeParser;
  56
  57     private DomToNormalizedNodeParserFactory(final XmlCodecProvider codecProvider, final SchemaContext schema, final boolean strictParsing) {
  58         leafNodeParser = new LeafNodeDomParser(codecProvider, schema);
  59         leafSetEntryNodeParser = new LeafSetEntryNodeDomParser(codecProvider, schema);
  60         leafSetNodeParser = new LeafSetNodeDomParser(leafSetEntryNodeParser);
  61         anyXmlNodeParser = new AnyXmlDomParser();
  62
  63         final NodeParserDispatcher<Element> dispatcher = new NodeParserDispatcher.BaseNodeParserDispatcher<Element>(this) {
  64
  65         };
  66
  67         containerNodeParser = new ContainerNodeDomParser(dispatcher, strictParsing);
  68         mapEntryNodeParser = new MapEntryNodeDomParser(dispatcher, strictParsing);
  69         mapNodeParser = new MapNodeDomParser(mapEntryNodeParser);
  70         orderedListNodeParser = new OrderedListNodeDomParser(mapEntryNodeParser);
  71         unkeyedListEntryNodeParser = new UnkeyedListEntryNodeDomParser(dispatcher);
  72         unkeyedListNodeParser = new UnkeyedListNodeDomParser(unkeyedListEntryNodeParser);
  73         choiceNodeParser = new ChoiceNodeDomParser(dispatcher);
  74         augmentationNodeParser = new AugmentationNodeDomParser(dispatcher, strictParsing);
  75     }
  76
  77     private DomToNormalizedNodeParserFactory(final XmlCodecProvider codecProvider, final SchemaContext schema,
  78                                              final BuildingStrategyProvider buildingStratProvider, final boolean strictParsing) {
  79         leafNodeParser = new LeafNodeDomParser(codecProvider, schema, buildingStratProvider.forLeaf());
  80         leafSetEntryNodeParser = new LeafSetEntryNodeDomParser(codecProvider, schema, buildingStratProvider.forLeafSetEntry());
  81
  82         // no buildingStrategy for Augment (no use case for now)
  83         leafSetNodeParser = new LeafSetNodeDomParser(leafSetEntryNodeParser);
  84         // no buildingStrategy for anyXml (probably not necessary)
  85         anyXmlNodeParser = new AnyXmlDomParser();
  86
  87         final NodeParserDispatcher<Element> dispatcher = new NodeParserDispatcher.BaseNodeParserDispatcher<Element>(this) {
  88
  89         };
  90
  91         containerNodeParser = new ContainerNodeDomParser(dispatcher, buildingStratProvider.forContainer(), strictParsing);
  92         mapEntryNodeParser = new MapEntryNodeDomParser(dispatcher, buildingStratProvider.forMapEntry(), strictParsing);
  93         mapNodeParser = new MapNodeDomParser(mapEntryNodeParser, buildingStratProvider.forMap());
  94         orderedListNodeParser = new OrderedListNodeDomParser(mapEntryNodeParser, buildingStratProvider.forOrderedList());
  95         unkeyedListEntryNodeParser = new UnkeyedListEntryNodeDomParser(buildingStratProvider.forUnkeyedListEntry(), dispatcher);
  96         unkeyedListNodeParser = new UnkeyedListNodeDomParser(buildingStratProvider.forUnkeyedList(), unkeyedListEntryNodeParser);
  97         choiceNodeParser = new ChoiceNodeDomParser(dispatcher, buildingStratProvider.forChoice());
  98         // no buildingStrategy for Augment (no use case for now)
  99         augmentationNodeParser = new AugmentationNodeDomParser(buildingStratProvider.forAugmentation(), dispatcher, strictParsing);
 100     }
 101
 102     public static DomToNormalizedNodeParserFactory getInstance(final XmlCodecProvider codecProvider, final SchemaContext schema, final boolean strictParsing) {
 103         return new DomToNormalizedNodeParserFactory(codecProvider, schema, strictParsing);
 104     }
 105
 106     public static DomToNormalizedNodeParserFactory getInstance(final XmlCodecProvider codecProvider, final SchemaContext schema) {
 107         return new DomToNormalizedNodeParserFactory(codecProvider, schema, true);
 108     }
 109
 110     public static DomToNormalizedNodeParserFactory getInstance(final XmlCodecProvider codecProvider, final SchemaContext schema,
 111                                                                final BuildingStrategyProvider buildingStratProvider) {
 112         return new DomToNormalizedNodeParserFactory(codecProvider, schema, buildingStratProvider, true);
 113     }
 114
 115     public static DomToNormalizedNodeParserFactory getInstance(final XmlCodecProvider codecProvider, final SchemaContext schema,
 116                                                                final BuildingStrategyProvider buildingStratProvider,
 117                                                                final boolean strictParsing) {
 118         return new DomToNormalizedNodeParserFactory(codecProvider, schema, buildingStratProvider, strictParsing);
 119     }
 120
 121     @Override
 122     public ToNormalizedNodeParser<Element, AugmentationNode, AugmentationSchema> getAugmentationNodeParser() {
 123         return augmentationNodeParser;
 124     }
 125
 126     @Override
 127     public ToNormalizedNodeParser<Element, ChoiceNode, ChoiceSchemaNode> getChoiceNodeParser() {
 128         return choiceNodeParser;
 129     }
 130
 131     @Override
 132     public ToNormalizedNodeParser<Element, ContainerNode, ContainerSchemaNode> getContainerNodeParser() {
 133         return containerNodeParser;
 134     }
 135
 136     @Override
 137     public ToNormalizedNodeParser<Element, LeafNode<?>, LeafSchemaNode> getLeafNodeParser() {
 138         return leafNodeParser;
 139     }
 140
 141     @Override
 142     public ToNormalizedNodeParser<Element, LeafSetEntryNode<?>, LeafListSchemaNode> getLeafSetEntryNodeParser() {
 143         return leafSetEntryNodeParser;
 144     }
 145
 146     @Override
 147     public ToNormalizedNodeParser<Element, LeafSetNode<?>, LeafListSchemaNode> getLeafSetNodeParser() {
 148         return leafSetNodeParser;
 149     }
 150
 151     @Override
 152     public ToNormalizedNodeParser<Element, MapEntryNode, ListSchemaNode> getMapEntryNodeParser() {
 153         return mapEntryNodeParser;
 154     }
 155
 156     @Override
 157     public ToNormalizedNodeParser<Element, MapNode, ListSchemaNode> getMapNodeParser() {
 158         return mapNodeParser;
 159     }
 160
 161     @Override
 162     public ToNormalizedNodeParser<Element, UnkeyedListNode, ListSchemaNode> getUnkeyedListNodeParser() {
 163         return unkeyedListNodeParser;
 164     }
 165
 166     @Override
 167     public ToNormalizedNodeParser<Element, UnkeyedListEntryNode, ListSchemaNode> getUnkeyedListEntryNodeParser() {
 168         return unkeyedListEntryNodeParser;
 169     }
 170
 171     @Override
 172     public ToNormalizedNodeParser<Element, OrderedMapNode, ListSchemaNode> getOrderedListNodeParser() {
 173         return orderedListNodeParser;
 174     }
 175
 176     @Override
 177     public ToNormalizedNodeParser<Element, AnyXmlNode, AnyXmlSchemaNode> getAnyXmlNodeParser() {
 178         return anyXmlNodeParser;
 179     }
 180
 181     /**
 182      * Base provider of building strategies used for customizing parsing process
 183      */
 184     public static abstract class BuildingStrategyProvider {
 185
 186         protected ExtensibleParser.BuildingStrategy<YangInstanceIdentifier.NodeIdentifier,LeafNode<?>> forLeaf() {
 187             return new LeafNodeBaseParser.SimpleLeafBuildingStrategy();
 188         }
 189
 190         protected ExtensibleParser.BuildingStrategy<YangInstanceIdentifier.NodeWithValue,LeafSetEntryNode<?>> forLeafSetEntry() {
 191             return new LeafSetEntryNodeBaseParser.SimpleLeafSetEntryBuildingStrategy();
 192         }
 193
 194         protected ExtensibleParser.BuildingStrategy<YangInstanceIdentifier.NodeIdentifier,ContainerNode> forContainer() {
 195             return new BaseDispatcherParser.SimpleBuildingStrategy<>();
 196         }
 197
 198         protected ExtensibleParser.BuildingStrategy<YangInstanceIdentifier.NodeIdentifierWithPredicates,MapEntryNode> forMapEntry() {
 199             return new BaseDispatcherParser.SimpleBuildingStrategy<>();
 200         }
 201
 202         protected ExtensibleParser.BuildingStrategy<YangInstanceIdentifier.NodeIdentifier,MapNode> forMap() {
 203             return new ListNodeBaseParser.SimpleListNodeBuildingStrategy<>();
 204         }
 205
 206         protected ExtensibleParser.BuildingStrategy<YangInstanceIdentifier.NodeIdentifier,OrderedMapNode> forOrderedList() {
 207             return new ListNodeBaseParser.SimpleListNodeBuildingStrategy<>();
 208         }
 209
 210         protected ExtensibleParser.BuildingStrategy<YangInstanceIdentifier.NodeIdentifier,UnkeyedListEntryNode> forUnkeyedListEntry() {
 211             return new BaseDispatcherParser.SimpleBuildingStrategy<>();
 212         }
 213
 214         protected ExtensibleParser.BuildingStrategy<YangInstanceIdentifier.NodeIdentifier,UnkeyedListNode> forUnkeyedList() {
 215             return new ListNodeBaseParser.SimpleListNodeBuildingStrategy<>();
 216         }
 217
 218         protected ExtensibleParser.BuildingStrategy<YangInstanceIdentifier.NodeIdentifier,ChoiceNode> forChoice() {
 219             return new BaseDispatcherParser.SimpleBuildingStrategy<>();
 220         }
 221
 222         public ExtensibleParser.BuildingStrategy<YangInstanceIdentifier.AugmentationIdentifier, AugmentationNode> forAugmentation() {
 223             return new BaseDispatcherParser.SimpleBuildingStrategy<>();
 224         }
 225     }
 226 }