summaryrefslogtreecommitdiffstats
path: root/infra/translate-impl/src/main/java/io/fd/honeycomb/translate/impl/read/GenericListReader.java
blob: d715dde264b3e6683a0b691a1938bc7b7de375b9 (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
/*
 * 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;

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

import com.google.common.annotations.Beta;
import io.fd.honeycomb.translate.read.ListReader;
import io.fd.honeycomb.translate.read.ReadContext;
import io.fd.honeycomb.translate.read.ReadFailedException;
import io.fd.honeycomb.translate.read.Reader;
import io.fd.honeycomb.translate.spi.read.ListReaderCustomizer;
import io.fd.honeycomb.translate.util.RWUtils;
import io.fd.honeycomb.translate.util.read.ReflexiveListReaderCustomizer;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nonnull;
import javax.annotation.concurrent.ThreadSafe;
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.Identifier;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Composite implementation of {@link ListReader} able to place the read result into parent builder object intended
 * for list node type.
 * <p/>
 * This reader checks if the IDs are wildcarded in which case it performs read of all list entries. In case the ID has a
 * key, it reads only the specified value.
 */
@Beta
@ThreadSafe
public class GenericListReader<C extends DataObject & Identifiable<K>, K extends Identifier<C>, B extends Builder<C>>
        extends GenericReader<C, B> implements ListReader<C, K, B> {

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

    /**
     * Create new {@link GenericListReader}
     *
     * @param managedDataObjectType Class object for managed data type. Must come from a list node type.
     * @param customizer            Customizer instance to customize this generic reader
     */
    public GenericListReader(@Nonnull final InstanceIdentifier<C> managedDataObjectType,
                             @Nonnull final ListReaderCustomizer<C, K, B> customizer) {
        super(managedDataObjectType, customizer);
    }

    @Override
    @Nonnull
    public List<C> readList(@Nonnull final InstanceIdentifier<C> id,
                            @Nonnull final ReadContext ctx) throws ReadFailedException {
        LOG.trace("{}: Reading all list entries", this);
        final List<K> allIds = getAllIds(id, ctx);
        LOG.debug("{}: Reading list entries for: {}", this, allIds);

        final ArrayList<C> allEntries = new ArrayList<>(allIds.size());
        for (K key : allIds) {
            final InstanceIdentifier.IdentifiableItem<C, K> currentBdItem = RWUtils.getCurrentIdItem(id, key);
            final InstanceIdentifier<C> keyedId = RWUtils.replaceLastInId(id, currentBdItem);
            final Optional<C> read = readCurrent(keyedId, ctx);
            if (read.isPresent()) {
                final DataObject singleItem = read.get();
                checkArgument(getManagedDataObjectType().getTargetType().isAssignableFrom(singleItem.getClass()));
                allEntries.add(getManagedDataObjectType().getTargetType().cast(singleItem));
            }
        }
        return allEntries;
    }

    @Override
    public List<K> getAllIds(@Nonnull final InstanceIdentifier<C> id, @Nonnull final ReadContext ctx)
            throws ReadFailedException {
        LOG.trace("{}: Getting all list ids", this);
        final List<K> allIds = ((ListReaderCustomizer<C, K, B>) customizer).getAllIds(id, ctx);
        LOG.debug("{}: All list ids: {}", this, allIds);
        return allIds;
    }

    @Override
    public void merge(@Nonnull final Builder<? extends DataObject> builder, @Nonnull final List<C> readData) {
        ((ListReaderCustomizer<C, K, B>) customizer).merge(builder, readData);
    }

    public static <C extends DataObject & Identifiable<K>,K extends Identifier<C>, B extends Builder<C>> Reader<C, B> createReflexive(
            final InstanceIdentifier<C> id, Class<B> builderClass,
            final List<K> staticKeys) {
        return new GenericListReader<>(id, new ReflexiveListReaderCustomizer<>(id.getTargetType(), builderClass, staticKeys));
    }
}