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.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;
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;
26 * Stateless Normalized Node Stream Writer decorator, which performs QName translation.
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.
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);
64 * Returns decorator, which uses supplied map to transform QNames.
66 * QNames not present in map are left unchanged.
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.
72 public static NormalizedNodeStreamWriter createQNameReplacing(final NormalizedNodeStreamWriter delegate,
73 final Map<QName, QName> mapping) {
74 return fromFunction(delegate, new QNameReplacementFunction(mapping));
78 * Returns decorator, which uses supplied map to transform QNameModules.
80 * QNameModules not present in map are left unchanged.
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.
86 public static NormalizedNodeStreamWriter createQNameModuleReplacing(final NormalizedNodeStreamWriter delegate,
87 final Map<QNameModule, QNameModule> mapping) {
88 return fromFunction(delegate, new QNameModuleReplacementFunction(mapping));
92 * Transforms a QName to new mapping.
94 * NOTE: If QName should be unchanged implementation needs to return original QName.
96 * @param key QName to transform.
97 * @return Returns new value of QName.
99 protected abstract @Nonnull QName transform(@Nonnull QName key);
102 public void leafNode(final NodeIdentifier name, final Object value) throws IOException, IllegalArgumentException {
103 delegate().leafNode(transform(name), value);
107 public void startLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
108 delegate().startLeafSet(transform(name), childSizeHint);
112 public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
113 delegate().startOrderedLeafSet(transform(name), childSizeHint);
117 public void leafSetEntryNode(final Object value) throws IOException, IllegalArgumentException {
118 delegate().leafSetEntryNode(value);
122 public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
123 delegate().startContainerNode(transform(name), childSizeHint);
127 public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
128 delegate().startUnkeyedList(transform(name), childSizeHint);
132 public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalStateException {
133 delegate().startUnkeyedListItem(transform(name), childSizeHint);
137 public void startMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
138 delegate().startMapNode(transform(name), childSizeHint);
142 public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint) throws IOException,
143 IllegalArgumentException {
144 delegate().startMapEntryNode(transform(identifier), childSizeHint);
148 public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException,
149 IllegalArgumentException {
150 delegate().startOrderedMapNode(transform(name), childSizeHint);
154 public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
155 delegate().startChoiceNode(transform(name), childSizeHint);
159 public void startAugmentationNode(final AugmentationIdentifier identifier) throws IOException, IllegalArgumentException {
160 delegate().startAugmentationNode(transform(identifier));
164 public void anyxmlNode(final NodeIdentifier name, final Object value) throws IOException, IllegalArgumentException {
165 delegate().anyxmlNode(transform(name), value);
169 public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException, IllegalArgumentException {
170 delegate().startYangModeledAnyXmlNode(transform(name), childSizeHint);
174 public void endNode() throws IOException, IllegalStateException {
175 delegate().endNode();
179 public void close() throws IOException {
184 public void flush() throws IOException {
188 private NodeIdentifier transform(final NodeIdentifier name) {
189 return new NodeIdentifier(transform(name.getNodeType()));
192 private AugmentationIdentifier transform(final AugmentationIdentifier identifier) {
193 ImmutableSet.Builder<QName> builder = ImmutableSet.builder();
194 for (QName original : identifier.getPossibleChildNames()) {
195 builder.add(transform(original));
197 return new AugmentationIdentifier(builder.build());
200 private NodeIdentifierWithPredicates transform(final NodeIdentifierWithPredicates identifier) {
201 Map<QName, Object> keyValues = new HashMap<>();
202 for (Map.Entry<QName, Object> original : identifier.getKeyValues().entrySet()) {
203 keyValues.put(transform(original.getKey()), original.getValue());
205 return new NodeIdentifierWithPredicates(transform(identifier.getNodeType()), keyValues);