01: /**
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */package org.apache.solr.search.function;
17:
18: import org.apache.lucene.index.IndexReader;
19: import org.apache.solr.search.function.DocValues;
20:
21: import java.io.IOException;
22: import java.io.Serializable;
23:
24: /**
25: * Instantiates {@link org.apache.solr.search.function.DocValues} for a particular reader.
26: * <br>
27: * Often used when creating a {@link FunctionQuery}.
28: *
29: * @author yonik
30: * @version $Id: ValueSource.java 472574 2006-11-08 18:25:52Z yonik $
31: */
32: public abstract class ValueSource implements Serializable {
33:
34: public abstract DocValues getValues(IndexReader reader)
35: throws IOException;
36:
37: public abstract boolean equals(Object o);
38:
39: public abstract int hashCode();
40:
41: /** description of field, used in explain() */
42: public abstract String description();
43:
44: public String toString() {
45: return getClass().getName() + ":" + description();
46: }
47:
48: }
|