3adda713db981c992b3f030c7f5b5a553d81bc3e
[hc2vpp.git] /
1 /*
2  * Copyright (c) 2016 Cisco and/or its affiliates.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 package io.fd.honeycomb.v3po.translate.util.read.registry;
18
19 import com.google.common.collect.ImmutableMap;
20 import io.fd.honeycomb.v3po.translate.read.Reader;
21 import io.fd.honeycomb.v3po.translate.read.registry.ModifiableReaderRegistryBuilder;
22 import io.fd.honeycomb.v3po.translate.read.registry.ReaderRegistry;
23 import io.fd.honeycomb.v3po.translate.read.registry.ReaderRegistryBuilder;
24 import io.fd.honeycomb.v3po.translate.util.AbstractSubtreeManagerRegistryBuilderBuilder;
25 import io.fd.honeycomb.v3po.translate.util.read.ReflexiveReader;
26 import java.util.ArrayList;
27 import java.util.List;
28 import java.util.Set;
29 import java.util.stream.Collectors;
30 import javax.annotation.Nonnull;
31 import javax.annotation.concurrent.NotThreadSafe;
32 import org.opendaylight.yangtools.concepts.Builder;
33 import org.opendaylight.yangtools.yang.binding.DataObject;
34 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
37
38 @NotThreadSafe
39 public final class CompositeReaderRegistryBuilder
40         extends AbstractSubtreeManagerRegistryBuilderBuilder<Reader<? extends DataObject, ? extends Builder<?>>, ReaderRegistry>
41         implements ModifiableReaderRegistryBuilder, ReaderRegistryBuilder {
42
43     private static final Logger LOG = LoggerFactory.getLogger(CompositeReaderRegistryBuilder.class);
44
45     @Override
46     protected Reader<? extends DataObject, ? extends Builder<?>> getSubtreeHandler(@Nonnull final Set<InstanceIdentifier<?>> handledChildren,
47                                                                                    @Nonnull final Reader<? extends DataObject, ? extends Builder<?>> reader) {
48         return SubtreeReader.createForReader(handledChildren, reader);
49     }
50
51     @Override
52     public <D extends DataObject> void addStructuralReader(@Nonnull InstanceIdentifier<D> id,
53                                                            @Nonnull Class<? extends Builder<D>> builderType) {
54         add(new ReflexiveReader<>(id, builderType));
55     }
56
57     /**
58      * Create {@link CompositeReaderRegistry} with Readers ordered according to submitted relationships.
59      * <p/>
60      * Note: The ordering only applies between nodes on the same level, inter-level and inter-subtree relationships are
61      * ignored.
62      */
63     @Override
64     public ReaderRegistry build() {
65         ImmutableMap<InstanceIdentifier<?>, Reader<? extends DataObject, ? extends Builder<?>>> mappedReaders =
66                 getMappedHandlers();
67         LOG.debug("Building Reader registry with Readers: {}",
68                 mappedReaders.keySet().stream()
69                         .map(InstanceIdentifier::getTargetType)
70                         .map(Class::getSimpleName)
71                         .collect(Collectors.joining(", ")));
72
73         LOG.trace("Building Reader registry with Readers: {}", mappedReaders);
74         final List<InstanceIdentifier<?>> readerOrder = new ArrayList<>(mappedReaders.keySet());
75
76         // Wrap readers into composite readers recursively, collect roots and create registry
77         final TypeHierarchy typeHierarchy = TypeHierarchy.create(mappedReaders.keySet());
78         final List<Reader<? extends DataObject, ? extends Builder<?>>> orderedRootReaders =
79                 typeHierarchy.getRoots().stream()
80                         .map(rootId -> toCompositeReader(rootId, mappedReaders, typeHierarchy))
81                         .collect(Collectors.toList());
82
83         // We are violating the ordering from mappedReaders, since we are forming a composite structure
84         // but at least order root writers
85         orderedRootReaders.sort((reader1, reader2) -> readerOrder.indexOf(reader1.getManagedDataObjectType())
86                 - readerOrder.indexOf(reader2.getManagedDataObjectType()));
87
88         return new CompositeReaderRegistry(orderedRootReaders);
89     }
90
91     private Reader<? extends DataObject, ? extends Builder<?>> toCompositeReader(
92             final InstanceIdentifier<?> instanceIdentifier,
93             final ImmutableMap<InstanceIdentifier<?>, Reader<? extends DataObject, ? extends Builder<?>>> mappedReaders,
94             final TypeHierarchy typeHierarchy) {
95
96         // Order child readers according to the mappedReadersCollection
97         final ImmutableMap.Builder<Class<?>, Reader<?, ? extends Builder<?>>> childReadersMapB = ImmutableMap.builder();
98         for (InstanceIdentifier<?> childId : mappedReaders.keySet()) {
99             if (typeHierarchy.getDirectChildren(instanceIdentifier).contains(childId)) {
100                 childReadersMapB.put(childId.getTargetType(), toCompositeReader(childId, mappedReaders, typeHierarchy));
101             }
102         }
103
104         final ImmutableMap<Class<?>, Reader<?, ? extends Builder<?>>> childReadersMap = childReadersMapB.build();
105         return childReadersMap.isEmpty()
106                 ? mappedReaders.get(instanceIdentifier)
107                 : CompositeReader.createForReader(mappedReaders.get(instanceIdentifier), childReadersMap);
108     }
109 }