summaryrefslogtreecommitdiff
path: root/core/src/main/java/org/elasticsearch/index/shard/FilterDocValuesProducer.java
blob: 149915458ee827bfe0a7732f1b868d6d420498d1 (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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you 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 org.elasticsearch.index.shard;

import org.apache.lucene.codecs.DocValuesProducer;
import org.apache.lucene.index.BinaryDocValues;
import org.apache.lucene.index.FieldInfo;
import org.apache.lucene.index.NumericDocValues;
import org.apache.lucene.index.SortedDocValues;
import org.apache.lucene.index.SortedNumericDocValues;
import org.apache.lucene.index.SortedSetDocValues;
import org.apache.lucene.util.Accountable;
import org.apache.lucene.util.Bits;

import java.io.IOException;
import java.util.Collection;
import java.util.Collections;

// TODO: move this to lucene's FilterCodecReader

/** 
 * Base class for filtering DocValuesProducer implementations.
 * <p>
 * NOTE: just like with DocValuesProducer, the default {@link #getMergeInstance()} 
 * is unoptimized. overriding this method when possible can improve performance.
 */
class FilterDocValuesProducer extends DocValuesProducer {
    /** The underlying Producer instance. */
    protected final DocValuesProducer in;
    
    /**
     * Creates a new FilterDocValuesProducer
     * @param in the underlying producer.
     */
    FilterDocValuesProducer(DocValuesProducer in) {
        this.in = in;
    }

    @Override
    public void close() throws IOException {
        in.close();
    }

    @Override
    public long ramBytesUsed() {
        return in.ramBytesUsed();
    }

    @Override
    public Collection<Accountable> getChildResources() {
        return in.getChildResources();
    }

    @Override
    public NumericDocValues getNumeric(FieldInfo field) throws IOException {
        return in.getNumeric(field);
    }

    @Override
    public BinaryDocValues getBinary(FieldInfo field) throws IOException {
        return in.getBinary(field);
    }

    @Override
    public SortedDocValues getSorted(FieldInfo field) throws IOException {
        return in.getSorted(field);
    }

    @Override
    public SortedNumericDocValues getSortedNumeric(FieldInfo field) throws IOException {
        return in.getSortedNumeric(field);
    }

    @Override
    public SortedSetDocValues getSortedSet(FieldInfo field) throws IOException {
        return in.getSortedSet(field);
    }

    @Override
    public Bits getDocsWithField(FieldInfo field) throws IOException {
        return in.getDocsWithField(field);
    }

    @Override
    public void checkIntegrity() throws IOException {
        in.checkIntegrity();
    }
    
    // TODO: move this out somewhere else (and can fix all these null producers in lucene?) 
    // we shouldn't need nullness for any reason.
    
    public static final DocValuesProducer EMPTY = new DocValuesProducer() {

        @Override
        public void close() throws IOException {}

        @Override
        public long ramBytesUsed() {
            return 0;
        }

        @Override
        public Collection<Accountable> getChildResources() {
            return Collections.emptyList();
        }
        
        @Override
        public NumericDocValues getNumeric(FieldInfo field) throws IOException {
            throw new IllegalStateException(); // we don't have any docvalues
        }

        @Override
        public BinaryDocValues getBinary(FieldInfo field) throws IOException {
            throw new IllegalStateException(); // we don't have any docvalues
        }

        @Override
        public SortedDocValues getSorted(FieldInfo field) throws IOException {
            throw new IllegalStateException(); // we don't have any docvalues
        }

        @Override
        public SortedNumericDocValues getSortedNumeric(FieldInfo field) throws IOException {
            throw new IllegalStateException(); // we don't have any docvalues
        }

        @Override
        public SortedSetDocValues getSortedSet(FieldInfo field) throws IOException {
            throw new IllegalStateException(); // we don't have any docvalues
        }

        @Override
        public Bits getDocsWithField(FieldInfo field) throws IOException {
            throw new IllegalStateException(); // we don't have any docvalues
        }

        @Override
        public void checkIntegrity() throws IOException {}
    };
}