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 javax.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             @Nonnull
  55             @Override
  56             protected QName transform(@Nonnull final QName key) {
  57                 return transformation.apply(key);
  58             }
  59
  60         };
  61     }
  62
  63     /**
  64      * Returns decorator, which uses supplied map to transform QNames. QNames not present in map are left unchanged.
  65      *
  66      * @param delegate Underlying normalized node stream writer
  67      * @param mapping Immutable map which represent mapping from original to new values.
  68      * @return decorator, which uses supplied mapping to transform QNames.
  69      */
  70     public static NormalizedNodeStreamWriter createQNameReplacing(final NormalizedNodeStreamWriter delegate,
  71             final Map<QName, QName> mapping) {
  72         return fromFunction(delegate, new QNameReplacementFunction(mapping));
  73     }
  74
  75     /**
  76      * Returns decorator, which uses supplied map to transform QNameModules. QNameModules not present in map are left
  77      * unchanged.
  78      *
  79      * @param delegate Underlying normalized node stream writer
  80      * @param mapping Immutable map which represent mapping from original to new values.
  81      * @return decorator, which uses supplied mapping to transform QNameModules.
  82      */
  83     public static NormalizedNodeStreamWriter createQNameModuleReplacing(final NormalizedNodeStreamWriter delegate,
  84             final Map<QNameModule, QNameModule> mapping) {
  85         return fromFunction(delegate, new QNameModuleReplacementFunction(mapping));
  86     }
  87
  88     @Override
  89     public void leafNode(final NodeIdentifier name, final Object value) throws IOException {
  90         delegate().leafNode(transform(name), value);
  91     }
  92
  93     @Override
  94     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException {
  95         delegate().startLeafSet(transform(name), childSizeHint);
  96     }
  97
  98     @Override
  99     public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException {
 100         delegate().startOrderedLeafSet(transform(name), childSizeHint);
 101     }
 102
 103     @Override
 104     public void leafSetEntryNode(final QName name, final Object value) throws IOException {
 105         delegate().leafSetEntryNode(transform(name), value);
 106     }
 107
 108     @Override
 109     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 110         delegate().startContainerNode(transform(name), childSizeHint);
 111     }
 112
 113     @Override
 114     public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) throws IOException {
 115         delegate().startUnkeyedList(transform(name), childSizeHint);
 116     }
 117
 118     @Override
 119     public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) throws IOException {
 120         delegate().startUnkeyedListItem(transform(name), childSizeHint);
 121     }
 122
 123     @Override
 124     public void startMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 125         delegate().startMapNode(transform(name), childSizeHint);
 126     }
 127
 128     @Override
 129     public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint)
 130             throws IOException {
 131         delegate().startMapEntryNode(transform(identifier), childSizeHint);
 132     }
 133
 134     @Override
 135     public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 136         delegate().startOrderedMapNode(transform(name), childSizeHint);
 137     }
 138
 139     @Override
 140     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 141         delegate().startChoiceNode(transform(name), childSizeHint);
 142     }
 143
 144     @Override
 145     public void startAugmentationNode(final AugmentationIdentifier identifier) throws IOException {
 146         delegate().startAugmentationNode(transform(identifier));
 147     }
 148
 149     @Override
 150     public void anyxmlNode(final NodeIdentifier name, final Object value) throws IOException {
 151         delegate().anyxmlNode(transform(name), value);
 152     }
 153
 154     @Override
 155     public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 156         delegate().startYangModeledAnyXmlNode(transform(name), childSizeHint);
 157     }
 158
 159     @Override
 160     public void endNode() throws IOException {
 161         delegate().endNode();
 162     }
 163
 164     @Override
 165     public void close() throws IOException {
 166         delegate().close();
 167     }
 168
 169     @Override
 170     public void flush() throws IOException {
 171         delegate().flush();
 172     }
 173
 174     /**
 175      * Transforms a QName to new mapping.
 176      *
 177      * <p>
 178      * NOTE: If QName should be unchanged implementation needs to return original QName.
 179      *
 180      * @param key QName to transform.
 181      * @return Returns new value of QName.
 182      */
 183     protected abstract @Nonnull QName transform(@Nonnull QName key);
 184
 185     private NodeIdentifier transform(final NodeIdentifier name) {
 186         return new NodeIdentifier(transform(name.getNodeType()));
 187     }
 188
 189     private AugmentationIdentifier transform(final AugmentationIdentifier identifier) {
 190         ImmutableSet.Builder<QName> builder = ImmutableSet.builder();
 191         for (QName original : identifier.getPossibleChildNames()) {
 192             builder.add(transform(original));
 193         }
 194         return new AugmentationIdentifier(builder.build());
 195     }
 196
 197     private NodeIdentifierWithPredicates transform(final NodeIdentifierWithPredicates identifier) {
 198         Map<QName, Object> keyValues = new HashMap<>();
 199         for (Map.Entry<QName, Object> original : identifier.getKeyValues().entrySet()) {
 200             keyValues.put(transform(original.getKey()), original.getValue());
 201         }
 202         return new NodeIdentifierWithPredicates(transform(identifier.getNodeType()), keyValues);
 203     }
 204 }