01: package org.apache.lucene.index;
02:
03: /**
04: * Licensed to the Apache Software Foundation (ASF) under one or more
05: * contributor license agreements. See the NOTICE file distributed with
06: * this work for additional information regarding copyright ownership.
07: * The ASF licenses this file to You under the Apache License, Version 2.0
08: * (the "License"); you may not use this file except in compliance with
09: * the License. You may obtain a copy of the License at
10: *
11: * http://www.apache.org/licenses/LICENSE-2.0
12: *
13: * Unless required by applicable law or agreed to in writing, software
14: * distributed under the License is distributed on an "AS IS" BASIS,
15: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16: * See the License for the specific language governing permissions and
17: * limitations under the License.
18: */
19:
20: /** Extends <code>TermFreqVector</code> to provide additional information about
21: * positions in which each of the terms is found. A TermPositionVector not necessarily
22: * contains both positions and offsets, but at least one of these arrays exists.
23: */
24: public interface TermPositionVector extends TermFreqVector {
25:
26: /** Returns an array of positions in which the term is found.
27: * Terms are identified by the index at which its number appears in the
28: * term String array obtained from the <code>indexOf</code> method.
29: * May return null if positions have not been stored.
30: */
31: public int[] getTermPositions(int index);
32:
33: /**
34: * Returns an array of TermVectorOffsetInfo in which the term is found.
35: * May return null if offsets have not been stored.
36: *
37: * @see org.apache.lucene.analysis.Token
38: *
39: * @param index The position in the array to get the offsets from
40: * @return An array of TermVectorOffsetInfo objects or the empty list
41: */
42: public TermVectorOffsetInfo[] getOffsets(int index);
43: }
|