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