/
QueryContextBuilder.java
58 lines (55 loc) · 2.24 KB
/
QueryContextBuilder.java
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
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat, Inc. and/or its affiliates or third-party contributors as
* indicated by the @author tags or express copyright attribution
* statements applied by the authors. All third-party contributions are
* distributed under license by Red Hat, Inc.
*
* This copyrighted material is made available to anyone wishing to use, modify,
* copy, or redistribute it subject to the terms and conditions of the GNU
* Lesser General Public License, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
* Boston, MA 02110-1301 USA
*/
package org.hibernate.search.query.dsl;
/**
* Query builder that needs contextualization:
* A query builder should know which entity or analyzer it relies on.
*
* <code>
* QueryBuilder builder =
* searchFactory.buildQueryBuilder()
* .forEntity(Customer.class)
* .overridesForField("profession", "acronym-analyzer")
* .get();
* </code>
*
* overridesForField is optional (and usually not needed). This method overrides the
* underlying analyzer (for a given field) used to build queries.
*
* @author Emmanuel Bernard
*/
public interface QueryContextBuilder {
//TODO make a forEntities
/**
* Creates an entity context which can be used to obtain a {@link QueryBuilder}.
* </p>
* Note that the passed entity type is used to verify field names, transparently apply analyzers and field bridges
* etc. The query result list, however, is not automatically restricted to the given type. Instead a type filter
* must be applied when creating the full text query in order to restrict the query result to certain entity types.
*
* @param entityType entity type used for meta data retrieval during query creation
* @return an entity context
*/
EntityContext forEntity(Class<?> entityType);
}