|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FullTextQuery
The base interface for lucene powered searches. This extends the JPA Query interface
Field Summary |
---|
Fields inherited from interface org.hibernate.search.ProjectionConstants |
---|
BOOST, DOCUMENT, DOCUMENT_ID, EXPLANATION, ID, OBJECT_CLASS, SCORE, THIS |
Method Summary | |
---|---|
void |
disableFullTextFilter(java.lang.String name)
Disable a given filter by its name |
FullTextFilter |
enableFullTextFilter(java.lang.String name)
Enable a given filter by its name. |
org.apache.lucene.search.Explanation |
explain(int documentId)
Return the Lucene Explanation
object describing the score computation for the matching object/document
in the current query |
int |
getResultSize()
Returns the number of hits for this search Caution: The number of results might be slightly different from getResultList().size() because getResultList()
may be not in sync with the database at the time of query. |
FullTextQuery |
setCriteriaQuery(org.hibernate.Criteria criteria)
Defines the Database Query used to load the Lucene results. |
FullTextQuery |
setFilter(org.apache.lucene.search.Filter filter)
Allows to use lucene filters. |
FullTextQuery |
setProjection(java.lang.String... fields)
Defines the Lucene field names projected and returned in a query result Each field is converted back to it's object representation, an Object[] being returned for each "row" (similar to an HQL or a Criteria API projection). |
FullTextQuery |
setResultTransformer(org.hibernate.transform.ResultTransformer transformer)
defines a result transformer used during projection |
FullTextQuery |
setSort(org.apache.lucene.search.Sort sort)
Allows to let lucene sort the results. |
Methods inherited from interface javax.persistence.Query |
---|
executeUpdate, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, getResultList, getSingleResult, isBound, setFirstResult, setFlushMode, setHint, setLockMode, setMaxResults, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, unwrap |
Method Detail |
---|
FullTextQuery setSort(org.apache.lucene.search.Sort sort)
sort
- The lucene sort object.
FullTextQuery setFilter(org.apache.lucene.search.Filter filter)
filter
- The lucene filter.
int getResultSize()
getResultList().size()
because getResultList()
may be not in sync with the database at the time of query.
FullTextQuery setCriteriaQuery(org.hibernate.Criteria criteria)
FullTextQuery setProjection(java.lang.String... fields)
TwoWayFieldBridge
Unless notified in their JavaDoc, all built-in bridges are two-way. All @DocumentId fields are projectable by design.
If the projected field is not a projectable field, null is returned in the object[]
FullTextFilter enableFullTextFilter(java.lang.String name)
void disableFullTextFilter(java.lang.String name)
FullTextQuery setResultTransformer(org.hibernate.transform.ResultTransformer transformer)
org.apache.lucene.search.Explanation explain(int documentId)
Explanation
object describing the score computation for the matching object/document
in the current query
documentId
- Lucene Document id to be explain. This is NOT the object id
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |