01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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 org.compass.core;
18:
19: /**
20: * Holds a term within the index, its frequency and the property name
21: * it is associated with.
22: *
23: * @author kimchy
24: * @see org.compass.core.CompassSession#termFreqsBuilder(String[])
25: * @see org.compass.core.CompassTermFreqsBuilder
26: */
27: public interface CompassTermFreq {
28:
29: /**
30: * Returns the property name this term is associated with
31: */
32: String getPropertyName();
33:
34: /**
35: * Returns the term value (of the property name).
36: */
37: String getTerm();
38:
39: /**
40: * Returns the term frequency within the index.
41: */
42: float getFreq();
43: }
|