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.engine;
18:
19: import org.compass.core.CompassQuery.SortDirection;
20: import org.compass.core.CompassQuery.SortImplicitType;
21: import org.compass.core.CompassQuery.SortPropertyType;
22:
23: /**
24: *
25: * @author kimchy
26: *
27: */
28: public interface SearchEngineQuery {
29:
30: public static interface SearchEngineSpanQuery extends
31: SearchEngineQuery {
32:
33: }
34:
35: SearchEngineQuery setBoost(float boost);
36:
37: SearchEngineQuery addSort(String propertyName);
38:
39: SearchEngineQuery addSort(String propertyName,
40: SortDirection direction);
41:
42: SearchEngineQuery addSort(String propertyName, SortPropertyType type);
43:
44: SearchEngineQuery addSort(String propertyName,
45: SortPropertyType type, SortDirection direction);
46:
47: SearchEngineQuery addSort(SortImplicitType implicitType);
48:
49: SearchEngineQuery addSort(SortImplicitType implicitType,
50: SortDirection direction);
51:
52: SearchEngineQuery setSubIndexes(String[] subindexes);
53:
54: SearchEngineQuery setAliases(String[] aliases);
55:
56: SearchEngineQuery setFilter(SearchEngineQueryFilter filter);
57:
58: SearchEngineQuery rewrite();
59:
60: boolean isSuggested();
61:
62: SearchEngineHits hits() throws SearchEngineException;
63:
64: long count();
65:
66: Object clone() throws CloneNotSupportedException;
67: }
|