2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.transform;
10 import com.google.common.collect.ForwardingObject;
11 import com.google.common.collect.ImmutableSet;
12 import java.io.IOException;
13 import java.util.HashMap;
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.YangInstanceIdentifier.NodeWithValue;
23 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
26 * Stateless Normalized Node Stream Writer decorator, which performs QName translation.
29 * This class serves as base for Normalized Node Stream Writer decorators with option to transform
30 * QNames by user-implemented {@link #transform(QName)} function.
32 public abstract class QNameTransformingStreamWriter extends ForwardingObject implements NormalizedNodeStreamWriter {
34 // FIXME: Probably use loading cache to decrease memory
36 protected abstract NormalizedNodeStreamWriter delegate();
39 * Returns decorator, which uses supplied function to transform QNames.
41 * @param delegate Underlying normalized node stream writer
42 * @param transformation Transformation function, function is required to return non-null
44 * @return decorator, which uses supplied function to transform QNames.
46 public static NormalizedNodeStreamWriter fromFunction(final NormalizedNodeStreamWriter delegate,
47 final Function<QName, QName> transformation) {
48 return new QNameTransformingStreamWriter() {
51 protected NormalizedNodeStreamWriter delegate() {
56 protected QName transform(final QName key) {
57 return transformation.apply(key);
63 * Returns decorator, which uses supplied map to transform QNames. QNames not present in map are left unchanged.
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.
69 public static NormalizedNodeStreamWriter createQNameReplacing(final NormalizedNodeStreamWriter delegate,
70 final Map<QName, QName> mapping) {
71 return fromFunction(delegate, new QNameReplacementFunction(mapping));
75 * Returns decorator, which uses supplied map to transform QNameModules. QNameModules not present in map are left
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.
82 public static NormalizedNodeStreamWriter createQNameModuleReplacing(final NormalizedNodeStreamWriter delegate,
83 final Map<QNameModule, QNameModule> mapping) {
84 return fromFunction(delegate, new QNameModuleReplacementFunction(mapping));
88 public void startLeafNode(final NodeIdentifier name) throws IOException {
89 delegate().startLeafNode(transform(name));
93 public void startLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException {
94 delegate().startLeafSet(transform(name), childSizeHint);
98 public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException {
99 delegate().startOrderedLeafSet(transform(name), childSizeHint);
103 public void startLeafSetEntryNode(final NodeWithValue<?> name) throws IOException {
104 delegate().startLeafSetEntryNode(transform(name));
108 public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
109 delegate().startContainerNode(transform(name), childSizeHint);
113 public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) throws IOException {
114 delegate().startUnkeyedList(transform(name), childSizeHint);
118 public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) throws IOException {
119 delegate().startUnkeyedListItem(transform(name), childSizeHint);
123 public void startMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
124 delegate().startMapNode(transform(name), childSizeHint);
128 public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint)
130 delegate().startMapEntryNode(transform(identifier), childSizeHint);
134 public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
135 delegate().startOrderedMapNode(transform(name), childSizeHint);
139 public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
140 delegate().startChoiceNode(transform(name), childSizeHint);
144 public void startAugmentationNode(final AugmentationIdentifier identifier) throws IOException {
145 delegate().startAugmentationNode(transform(identifier));
149 public void startAnyxmlNode(final NodeIdentifier name) throws IOException {
150 delegate().startAnyxmlNode(transform(name));
154 public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
155 delegate().startYangModeledAnyXmlNode(transform(name), childSizeHint);
159 public void endNode() throws IOException {
160 delegate().endNode();
164 public void close() throws IOException {
169 public void flush() throws IOException {
174 public void nodeValue(final Object value) throws IOException {
175 delegate().nodeValue(value);
179 * Transforms a QName to new mapping.
182 * NOTE: If QName should be unchanged implementation needs to return original QName.
184 * @param key QName to transform.
185 * @return Returns new value of QName.
187 protected abstract @NonNull QName transform(@NonNull QName key);
189 private NodeIdentifier transform(final NodeIdentifier name) {
190 return new NodeIdentifier(transform(name.getNodeType()));
193 private <T> NodeWithValue<T> transform(final NodeWithValue<T> name) {
194 return new NodeWithValue<>(transform(name.getNodeType()), name.getValue());
197 private AugmentationIdentifier transform(final AugmentationIdentifier identifier) {
198 ImmutableSet.Builder<QName> builder = ImmutableSet.builder();
199 for (QName original : identifier.getPossibleChildNames()) {
200 builder.add(transform(original));
202 return new AugmentationIdentifier(builder.build());
205 private NodeIdentifierWithPredicates transform(final NodeIdentifierWithPredicates identifier) {
206 Map<QName, Object> keyValues = new HashMap<>();
207 for (Map.Entry<QName, Object> original : identifier.getKeyValues().entrySet()) {
208 keyValues.put(transform(original.getKey()), original.getValue());
210 return new NodeIdentifierWithPredicates(transform(identifier.getNodeType()), keyValues);