2 * Copyright (c) 2016 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 package io.fd.honeycomb.translate.impl.read.registry;
19 import com.google.common.collect.ImmutableMap;
20 import io.fd.honeycomb.translate.impl.read.GenericListReader;
21 import io.fd.honeycomb.translate.impl.read.GenericReader;
22 import io.fd.honeycomb.translate.read.InitReader;
23 import io.fd.honeycomb.translate.read.Initializer;
24 import io.fd.honeycomb.translate.read.Reader;
25 import io.fd.honeycomb.translate.read.registry.ModifiableReaderRegistryBuilder;
26 import io.fd.honeycomb.translate.read.registry.ReaderRegistry;
27 import io.fd.honeycomb.translate.read.registry.ReaderRegistryBuilder;
28 import io.fd.honeycomb.translate.util.AbstractSubtreeManagerRegistryBuilderBuilder;
29 import io.fd.honeycomb.translate.util.YangDAG;
30 import org.opendaylight.yangtools.concepts.Builder;
31 import org.opendaylight.yangtools.yang.binding.DataObject;
32 import org.opendaylight.yangtools.yang.binding.Identifiable;
33 import org.opendaylight.yangtools.yang.binding.Identifier;
34 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
38 import javax.annotation.Nonnull;
39 import javax.annotation.concurrent.NotThreadSafe;
40 import java.util.ArrayList;
41 import java.util.List;
43 import java.util.stream.Collectors;
45 import static com.google.common.base.Preconditions.checkArgument;
48 public final class CompositeReaderRegistryBuilder
49 extends AbstractSubtreeManagerRegistryBuilderBuilder<Reader<? extends DataObject, ? extends Builder<?>>, ReaderRegistry>
50 implements ModifiableReaderRegistryBuilder, ReaderRegistryBuilder {
52 private static final Logger LOG = LoggerFactory.getLogger(CompositeReaderRegistryBuilder.class);
54 public CompositeReaderRegistryBuilder(@Nonnull final YangDAG yangDAG) {
59 protected Reader<? extends DataObject, ? extends Builder<?>> getSubtreeHandler(@Nonnull final Set<InstanceIdentifier<?>> handledChildren,
60 @Nonnull final Reader<? extends DataObject, ? extends Builder<?>> reader) {
61 return reader instanceof Initializer
62 ? InitSubtreeReader.createForReader(handledChildren, (InitReader<?, ?>) reader)
63 : SubtreeReader.createForReader(handledChildren, reader);
67 protected Reader<? extends DataObject, ? extends Builder<?>> getWildcardedSubtreeHandler(@Nonnull Reader<? extends DataObject, ? extends Builder<?>> handler) {
68 throw new UnsupportedOperationException("Wildcarded readers are not supported");
72 public <D extends DataObject> void addStructuralReader(@Nonnull InstanceIdentifier<D> id,
73 @Nonnull Class<? extends Builder<D>> builderType) {
74 // prevent case to submit structural reader for list, which would cause fail because target setter consumes
75 // List<TargetType>, not Target type. If node is static list, addStructuralListReader should be used
76 checkArgument(!Identifiable.class.isAssignableFrom(id.getTargetType()), "Structural readers cannot be used for keyed nodes[node type %s], use addStructuralListReader()", id.getTargetType());
77 add(GenericReader.createReflexive(id, builderType));
81 public <D extends DataObject & Identifiable<K>, K extends Identifier<D>> void addStructuralListReader(@Nonnull InstanceIdentifier<D> id, @Nonnull Class<? extends Builder<D>> builderType, @Nonnull List<K> staticKeys) {
82 checkArgument(Identifiable.class.isAssignableFrom(id.getTargetType()), "Node %s is not keyed, use addStructuralReader()", id.getTargetType());
83 add(GenericListReader.createReflexive(id, builderType, staticKeys));
87 * Create {@link CompositeReaderRegistry} with Readers ordered according to submitted relationships.
89 * Note: The ordering only applies between nodes on the same level, inter-level and inter-subtree relationships are
93 public ReaderRegistry build() {
94 ImmutableMap<InstanceIdentifier<?>, Reader<? extends DataObject, ? extends Builder<?>>> mappedReaders =
96 LOG.debug("Building Reader registry with Readers: {}",
97 mappedReaders.keySet().stream()
98 .map(InstanceIdentifier::getTargetType)
99 .map(Class::getSimpleName)
100 .collect(Collectors.joining(", ")));
102 LOG.trace("Building Reader registry with Readers: {}", mappedReaders);
103 final List<InstanceIdentifier<?>> readerOrder = new ArrayList<>(mappedReaders.keySet());
105 // Wrap readers into composite readers recursively, collect roots and create registry
106 final TypeHierarchy typeHierarchy = TypeHierarchy.create(mappedReaders.keySet());
107 final List<Reader<? extends DataObject, ? extends Builder<?>>> orderedRootReaders =
108 typeHierarchy.getRoots().stream()
109 .map(rootId -> toCompositeReader(rootId, mappedReaders, typeHierarchy))
110 .collect(Collectors.toList());
112 // We are violating the ordering from mappedReaders, since we are forming a composite structure
113 // but at least order root writers
114 orderedRootReaders.sort((reader1, reader2) -> readerOrder.indexOf(reader1.getManagedDataObjectType())
115 - readerOrder.indexOf(reader2.getManagedDataObjectType()));
117 return new CompositeReaderRegistry(orderedRootReaders);
120 private Reader<? extends DataObject, ? extends Builder<?>> toCompositeReader(
121 final InstanceIdentifier<?> instanceIdentifier,
122 final ImmutableMap<InstanceIdentifier<?>, Reader<? extends DataObject, ? extends Builder<?>>> mappedReaders,
123 final TypeHierarchy typeHierarchy) {
125 // Order child readers according to the mappedReadersCollection
126 final ImmutableMap.Builder<Class<?>, Reader<?, ? extends Builder<?>>> childReadersMapB = ImmutableMap.builder();
127 for (InstanceIdentifier<?> childId : mappedReaders.keySet()) {
128 if (typeHierarchy.getDirectChildren(instanceIdentifier).contains(childId)) {
129 childReadersMapB.put(childId.getTargetType(), toCompositeReader(childId, mappedReaders, typeHierarchy));
133 final ImmutableMap<Class<?>, Reader<?, ? extends Builder<?>>> childReadersMap = childReadersMapB.build();
134 return childReadersMap.isEmpty()
135 ? mappedReaders.get(instanceIdentifier)
136 : CompositeReader.createForReader(mappedReaders.get(instanceIdentifier), childReadersMap);