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