yang/yang-data-transform/src/main/java/org/opendaylight/yangtools/transform/QNameTransformingStreamWriter.java

   1 /*
   2  * Copyright (c) 2015 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.transform;
   9
  10 import com.google.common.collect.ForwardingObject;
  11 import com.google.common.collect.ImmutableSet;
  12 import java.io.IOException;
  13 import java.util.HashMap;
  14 import java.util.Map;
  15 import java.util.function.Function;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.opendaylight.yangtools.yang.common.QName;
  18 import org.opendaylight.yangtools.yang.common.QNameModule;
  19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  22 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  23
  24 /**
  25  * Stateless Normalized Node Stream Writer decorator, which performs QName translation.
  26  *
  27  * <p>
  28  * This class serves as base for Normalized Node Stream Writer decorators with option to transform
  29  * QNames by user-implemented {@link #transform(QName)} function.
  30  */
  31 public abstract class QNameTransformingStreamWriter extends ForwardingObject implements NormalizedNodeStreamWriter {
  32
  33     // FIXME: Probably use loading cache to decrease memory
  34     @Override
  35     protected abstract NormalizedNodeStreamWriter delegate();
  36
  37     /**
  38      * Returns decorator, which uses supplied function to transform QNames.
  39      *
  40      * @param delegate Underlying normalized node stream writer
  41      * @param transformation Transformation function, function is required to return non-null
  42      *        values.
  43      * @return decorator, which uses supplied function to transform QNames.
  44      */
  45     public static NormalizedNodeStreamWriter fromFunction(final NormalizedNodeStreamWriter delegate,
  46             final Function<QName, QName> transformation) {
  47         return new QNameTransformingStreamWriter() {
  48
  49             @Override
  50             protected NormalizedNodeStreamWriter delegate() {
  51                 return delegate;
  52             }
  53
  54             @Override
  55             protected QName transform(final QName key) {
  56                 return transformation.apply(key);
  57             }
  58
  59         };
  60     }
  61
  62     /**
  63      * Returns decorator, which uses supplied map to transform QNames. QNames not present in map are left unchanged.
  64      *
  65      * @param delegate Underlying normalized node stream writer
  66      * @param mapping Immutable map which represent mapping from original to new values.
  67      * @return decorator, which uses supplied mapping to transform QNames.
  68      */
  69     public static NormalizedNodeStreamWriter createQNameReplacing(final NormalizedNodeStreamWriter delegate,
  70             final Map<QName, QName> mapping) {
  71         return fromFunction(delegate, new QNameReplacementFunction(mapping));
  72     }
  73
  74     /**
  75      * Returns decorator, which uses supplied map to transform QNameModules. QNameModules not present in map are left
  76      * unchanged.
  77      *
  78      * @param delegate Underlying normalized node stream writer
  79      * @param mapping Immutable map which represent mapping from original to new values.
  80      * @return decorator, which uses supplied mapping to transform QNameModules.
  81      */
  82     public static NormalizedNodeStreamWriter createQNameModuleReplacing(final NormalizedNodeStreamWriter delegate,
  83             final Map<QNameModule, QNameModule> mapping) {
  84         return fromFunction(delegate, new QNameModuleReplacementFunction(mapping));
  85     }
  86
  87     @Override
  88     public void leafNode(final NodeIdentifier name, final Object value) throws IOException {
  89         delegate().leafNode(transform(name), value);
  90     }
  91
  92     @Override
  93     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException {
  94         delegate().startLeafSet(transform(name), childSizeHint);
  95     }
  96
  97     @Override
  98     public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException {
  99         delegate().startOrderedLeafSet(transform(name), childSizeHint);
 100     }
 101
 102     @Override
 103     public void leafSetEntryNode(final QName name, final Object value) throws IOException {
 104         delegate().leafSetEntryNode(transform(name), value);
 105     }
 106
 107     @Override
 108     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 109         delegate().startContainerNode(transform(name), childSizeHint);
 110     }
 111
 112     @Override
 113     public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) throws IOException {
 114         delegate().startUnkeyedList(transform(name), childSizeHint);
 115     }
 116
 117     @Override
 118     public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) throws IOException {
 119         delegate().startUnkeyedListItem(transform(name), childSizeHint);
 120     }
 121
 122     @Override
 123     public void startMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 124         delegate().startMapNode(transform(name), childSizeHint);
 125     }
 126
 127     @Override
 128     public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint)
 129             throws IOException {
 130         delegate().startMapEntryNode(transform(identifier), childSizeHint);
 131     }
 132
 133     @Override
 134     public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 135         delegate().startOrderedMapNode(transform(name), childSizeHint);
 136     }
 137
 138     @Override
 139     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 140         delegate().startChoiceNode(transform(name), childSizeHint);
 141     }
 142
 143     @Override
 144     public void startAugmentationNode(final AugmentationIdentifier identifier) throws IOException {
 145         delegate().startAugmentationNode(transform(identifier));
 146     }
 147
 148     @Override
 149     public void anyxmlNode(final NodeIdentifier name, final Object value) throws IOException {
 150         delegate().anyxmlNode(transform(name), value);
 151     }
 152
 153     @Override
 154     public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 155         delegate().startYangModeledAnyXmlNode(transform(name), childSizeHint);
 156     }
 157
 158     @Override
 159     public void endNode() throws IOException {
 160         delegate().endNode();
 161     }
 162
 163     @Override
 164     public void close() throws IOException {
 165         delegate().close();
 166     }
 167
 168     @Override
 169     public void flush() throws IOException {
 170         delegate().flush();
 171     }
 172
 173     /**
 174      * Transforms a QName to new mapping.
 175      *
 176      * <p>
 177      * NOTE: If QName should be unchanged implementation needs to return original QName.
 178      *
 179      * @param key QName to transform.
 180      * @return Returns new value of QName.
 181      */
 182     protected abstract @NonNull QName transform(@NonNull QName key);
 183
 184     private NodeIdentifier transform(final NodeIdentifier name) {
 185         return new NodeIdentifier(transform(name.getNodeType()));
 186     }
 187
 188     private AugmentationIdentifier transform(final AugmentationIdentifier identifier) {
 189         ImmutableSet.Builder<QName> builder = ImmutableSet.builder();
 190         for (QName original : identifier.getPossibleChildNames()) {
 191             builder.add(transform(original));
 192         }
 193         return new AugmentationIdentifier(builder.build());
 194     }
 195
 196     private NodeIdentifierWithPredicates transform(final NodeIdentifierWithPredicates identifier) {
 197         Map<QName, Object> keyValues = new HashMap<>();
 198         for (Map.Entry<QName, Object> original : identifier.getKeyValues().entrySet()) {
 199             keyValues.put(transform(original.getKey()), original.getValue());
 200         }
 201         return new NodeIdentifierWithPredicates(transform(identifier.getNodeType()), keyValues);
 202     }
 203 }