infra/translate-impl/src/main/java/io/fd/honeycomb/translate/impl/read/registry/CompositeReaderRegistryBuilder.java

   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.translate.impl.read.registry;
  18
  19 import com.google.common.base.Preconditions;
  20 import com.google.common.collect.ImmutableMap;
  21 import io.fd.honeycomb.translate.impl.read.GenericListReader;
  22 import io.fd.honeycomb.translate.impl.read.GenericReader;
  23 import io.fd.honeycomb.translate.read.InitReader;
  24 import io.fd.honeycomb.translate.read.Initializer;
  25 import io.fd.honeycomb.translate.read.Reader;
  26 import io.fd.honeycomb.translate.read.registry.ModifiableReaderRegistryBuilder;
  27 import io.fd.honeycomb.translate.read.registry.ReaderRegistry;
  28 import io.fd.honeycomb.translate.read.registry.ReaderRegistryBuilder;
  29 import io.fd.honeycomb.translate.util.AbstractSubtreeManagerRegistryBuilderBuilder;
  30 import io.fd.honeycomb.translate.util.YangDAG;
  31 import org.opendaylight.yangtools.concepts.Builder;
  32 import org.opendaylight.yangtools.yang.binding.DataObject;
  33 import org.opendaylight.yangtools.yang.binding.Identifiable;
  34 import org.opendaylight.yangtools.yang.binding.Identifier;
  35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 import javax.annotation.Nonnull;
  40 import javax.annotation.concurrent.NotThreadSafe;
  41 import java.util.ArrayList;
  42 import java.util.List;
  43 import java.util.Set;
  44 import java.util.stream.Collectors;
  45
  46 import static com.google.common.base.Preconditions.checkArgument;
  47
  48 @NotThreadSafe
  49 public final class CompositeReaderRegistryBuilder
  50         extends AbstractSubtreeManagerRegistryBuilderBuilder<Reader<? extends DataObject, ? extends Builder<?>>, ReaderRegistry>
  51         implements ModifiableReaderRegistryBuilder, ReaderRegistryBuilder {
  52
  53     private static final Logger LOG = LoggerFactory.getLogger(CompositeReaderRegistryBuilder.class);
  54
  55     public CompositeReaderRegistryBuilder(@Nonnull final YangDAG yangDAG) {
  56         super(yangDAG);
  57     }
  58
  59     @Override
  60     protected Reader<? extends DataObject, ? extends Builder<?>> getSubtreeHandler(@Nonnull final Set<InstanceIdentifier<?>> handledChildren,
  61                                                                                    @Nonnull final Reader<? extends DataObject, ? extends Builder<?>> reader) {
  62         return reader instanceof Initializer
  63                 ? InitSubtreeReader.createForReader(handledChildren, (InitReader<?, ?>) reader)
  64                 : SubtreeReader.createForReader(handledChildren, reader);
  65     }
  66
  67     @Override
  68     protected Reader<? extends DataObject, ? extends Builder<?>> getWildcardedSubtreeHandler(@Nonnull Reader<? extends DataObject, ? extends Builder<?>> handler) {
  69         throw new UnsupportedOperationException("Wildcarded readers are not supported");
  70     }
  71
  72     @Override
  73     public <D extends DataObject> void addStructuralReader(@Nonnull InstanceIdentifier<D> id,
  74                                                            @Nonnull Class<? extends Builder<D>> builderType) {
  75         // prevent case to submit structural reader for list, which would cause fail because target setter consumes
  76         // List<TargetType>, not Target type. If node is static list, addStructuralListReader should be used
  77         checkArgument(!Identifiable.class.isAssignableFrom(id.getTargetType()), "Structural readers cannot be used for keyed nodes[node type %s], use addStructuralListReader()", id.getTargetType());
  78         add(GenericReader.createReflexive(id, builderType));
  79     }
  80
  81     @Override
  82     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) {
  83         checkArgument(Identifiable.class.isAssignableFrom(id.getTargetType()), "Node %s is not keyed, use addStructuralReader()", id.getTargetType());
  84         add(GenericListReader.createReflexive(id, builderType, staticKeys));
  85     }
  86
  87     /**
  88      * Create {@link CompositeReaderRegistry} with Readers ordered according to submitted relationships.
  89      * <p/>
  90      * Note: The ordering only applies between nodes on the same level, inter-level and inter-subtree relationships are
  91      * ignored.
  92      */
  93     @Override
  94     public ReaderRegistry build() {
  95         ImmutableMap<InstanceIdentifier<?>, Reader<? extends DataObject, ? extends Builder<?>>> mappedReaders =
  96                 getMappedHandlers();
  97         LOG.debug("Building Reader registry with Readers: {}",
  98                 mappedReaders.keySet().stream()
  99                         .map(InstanceIdentifier::getTargetType)
 100                         .map(Class::getSimpleName)
 101                         .collect(Collectors.joining(", ")));
 102
 103         LOG.trace("Building Reader registry with Readers: {}", mappedReaders);
 104         final List<InstanceIdentifier<?>> readerOrder = new ArrayList<>(mappedReaders.keySet());
 105
 106         // Wrap readers into composite readers recursively, collect roots and create registry
 107         final TypeHierarchy typeHierarchy = TypeHierarchy.create(mappedReaders.keySet());
 108         final List<Reader<? extends DataObject, ? extends Builder<?>>> orderedRootReaders =
 109                 typeHierarchy.getRoots().stream()
 110                         .map(rootId -> toCompositeReader(rootId, mappedReaders, typeHierarchy))
 111                         .collect(Collectors.toList());
 112
 113         // We are violating the ordering from mappedReaders, since we are forming a composite structure
 114         // but at least order root writers
 115         orderedRootReaders.sort((reader1, reader2) -> readerOrder.indexOf(reader1.getManagedDataObjectType())
 116                 - readerOrder.indexOf(reader2.getManagedDataObjectType()));
 117
 118         return new CompositeReaderRegistry(orderedRootReaders);
 119     }
 120
 121     private Reader<? extends DataObject, ? extends Builder<?>> toCompositeReader(
 122             final InstanceIdentifier<?> instanceIdentifier,
 123             final ImmutableMap<InstanceIdentifier<?>, Reader<? extends DataObject, ? extends Builder<?>>> mappedReaders,
 124             final TypeHierarchy typeHierarchy) {
 125
 126         // Order child readers according to the mappedReadersCollection
 127         final ImmutableMap.Builder<Class<?>, Reader<?, ? extends Builder<?>>> childReadersMapB = ImmutableMap.builder();
 128         for (InstanceIdentifier<?> childId : mappedReaders.keySet()) {
 129             if (typeHierarchy.getDirectChildren(instanceIdentifier).contains(childId)) {
 130                 childReadersMapB.put(childId.getTargetType(), toCompositeReader(childId, mappedReaders, typeHierarchy));
 131             }
 132         }
 133
 134         final ImmutableMap<Class<?>, Reader<?, ? extends Builder<?>>> childReadersMap = childReadersMapB.build();
 135
 136         if (childReadersMap.isEmpty()) {
 137             return mappedReaders.get(instanceIdentifier);
 138         } else {
 139             final Reader<?, ?> reader = Preconditions.checkNotNull(mappedReaders.get(instanceIdentifier),
 140                     "Missing reader for %s", instanceIdentifier);
 141             return CompositeReader.createForReader(reader, childReadersMap);
 142         }
 143     }
 144 }