summaryrefslogtreecommitdiffstats
path: root/infra/translate-impl/src/main/java/io/fd/honeycomb/translate/impl/read/registry/CompositeReaderRegistryBuilder.java
blob: dd6a838c632631453a6b16859f091d45e7e8915a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/*
 * Copyright (c) 2016 Cisco and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.fd.honeycomb.translate.impl.read.registry;

import com.google.common.collect.ImmutableMap;
import io.fd.honeycomb.translate.impl.read.GenericReader;
import io.fd.honeycomb.translate.read.InitReader;
import io.fd.honeycomb.translate.read.Initializer;
import io.fd.honeycomb.translate.read.Reader;
import io.fd.honeycomb.translate.read.registry.ModifiableReaderRegistryBuilder;
import io.fd.honeycomb.translate.read.registry.ReaderRegistry;
import io.fd.honeycomb.translate.read.registry.ReaderRegistryBuilder;
import io.fd.honeycomb.translate.util.AbstractSubtreeManagerRegistryBuilderBuilder;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import javax.annotation.Nonnull;
import javax.annotation.concurrent.NotThreadSafe;

import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.Identifiable;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static com.google.common.base.Preconditions.checkArgument;

@NotThreadSafe
public final class CompositeReaderRegistryBuilder
        extends AbstractSubtreeManagerRegistryBuilderBuilder<Reader<? extends DataObject, ? extends Builder<?>>, ReaderRegistry>
        implements ModifiableReaderRegistryBuilder, ReaderRegistryBuilder {

    private static final Logger LOG = LoggerFactory.getLogger(CompositeReaderRegistryBuilder.class);

    @Override
    protected Reader<? extends DataObject, ? extends Builder<?>> getSubtreeHandler(@Nonnull final Set<InstanceIdentifier<?>> handledChildren,
                                                                                   @Nonnull final Reader<? extends DataObject, ? extends Builder<?>> reader) {
        return reader instanceof Initializer
                ? InitSubtreeReader.createForReader(handledChildren, (InitReader<?, ?>) reader)
                : SubtreeReader.createForReader(handledChildren, reader);
    }

    @Override
    public <D extends DataObject> void addStructuralReader(@Nonnull InstanceIdentifier<D> id,
                                                           @Nonnull Class<? extends Builder<D>> builderType) {
        // TODO https://jira.fd.io/browse/HONEYCOMB-344 provide variant of this method for list nodes
        // prevent case to submit structural reader for list, which would cause fail because target setter consumes
        // List<TargetType>, not Target type. If node is static, customizer that handles it should return static list
        // of IDs.
        checkArgument(!Identifiable.class.isAssignableFrom(id.getTargetType()), "Structural readers cannot be used for keyed nodes[node type %s]", id.getTargetType());
        add(GenericReader.createReflexive(id, builderType));
    }

    /**
     * Create {@link CompositeReaderRegistry} with Readers ordered according to submitted relationships.
     * <p/>
     * Note: The ordering only applies between nodes on the same level, inter-level and inter-subtree relationships are
     * ignored.
     */
    @Override
    public ReaderRegistry build() {
        ImmutableMap<InstanceIdentifier<?>, Reader<? extends DataObject, ? extends Builder<?>>> mappedReaders =
                getMappedHandlers();
        LOG.debug("Building Reader registry with Readers: {}",
                mappedReaders.keySet().stream()
                        .map(InstanceIdentifier::getTargetType)
                        .map(Class::getSimpleName)
                        .collect(Collectors.joining(", ")));

        LOG.trace("Building Reader registry with Readers: {}", mappedReaders);
        final List<InstanceIdentifier<?>> readerOrder = new ArrayList<>(mappedReaders.keySet());

        // Wrap readers into composite readers recursively, collect roots and create registry
        final TypeHierarchy typeHierarchy = TypeHierarchy.create(mappedReaders.keySet());
        final List<Reader<? extends DataObject, ? extends Builder<?>>> orderedRootReaders =
                typeHierarchy.getRoots().stream()
                        .map(rootId -> toCompositeReader(rootId, mappedReaders, typeHierarchy))
                        .collect(Collectors.toList());

        // We are violating the ordering from mappedReaders, since we are forming a composite structure
        // but at least order root writers
        orderedRootReaders.sort((reader1, reader2) -> readerOrder.indexOf(reader1.getManagedDataObjectType())
                - readerOrder.indexOf(reader2.getManagedDataObjectType()));

        return new CompositeReaderRegistry(orderedRootReaders);
    }

    private Reader<? extends DataObject, ? extends Builder<?>> toCompositeReader(
            final InstanceIdentifier<?> instanceIdentifier,
            final ImmutableMap<InstanceIdentifier<?>, Reader<? extends DataObject, ? extends Builder<?>>> mappedReaders,
            final TypeHierarchy typeHierarchy) {

        // Order child readers according to the mappedReadersCollection
        final ImmutableMap.Builder<Class<?>, Reader<?, ? extends Builder<?>>> childReadersMapB = ImmutableMap.builder();
        for (InstanceIdentifier<?> childId : mappedReaders.keySet()) {
            if (typeHierarchy.getDirectChildren(instanceIdentifier).contains(childId)) {
                childReadersMapB.put(childId.getTargetType(), toCompositeReader(childId, mappedReaders, typeHierarchy));
            }
        }

        final ImmutableMap<Class<?>, Reader<?, ? extends Builder<?>>> childReadersMap = childReadersMapB.build();
        return childReadersMap.isEmpty()
                ? mappedReaders.get(instanceIdentifier)
                : CompositeReader.createForReader(mappedReaders.get(instanceIdentifier), childReadersMap);
    }
}