org.hibernate.hql.lucene

Class LuceneQueryParsingResult

java.lang.Object

org.hibernate.hql.lucene.LuceneQueryParsingResult

public class LuceneQueryParsingResult
extends Object

The result of walking a query parse tree, representing an equivalent Lucene query.

Author:

Gunnar Morling

Constructor Summary

Constructors

Constructor and Description
LuceneQueryParsingResult(org.apache.lucene.search.Query query, String targetEntityName, Class<?> targetEntity, List<String> projections, org.apache.lucene.search.Sort sort)

Method Summary

Modifier and Type	Method and Description
List<String>	getProjections() Returns the projections of the parsed query, represented as dot paths in case of references to fields of embedded entities, e.g.
org.apache.lucene.search.Query	getQuery() Returns the Lucene query created while walking the parse tree.
org.apache.lucene.search.Sort	getSort() Returns the optional Lucene sort specification.
Class<?>	getTargetEntity() Returns the entity type of the parsed query as derived from the queried entity name via the configured EntityNamesResolver.
String	getTargetEntityName() Returns the original entity name as given in the query
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LuceneQueryParsingResult

public LuceneQueryParsingResult(org.apache.lucene.search.Query query,
                                String targetEntityName,
                                Class<?> targetEntity,
                                List<String> projections,
                                org.apache.lucene.search.Sort sort)

Method Detail

getQuery

public org.apache.lucene.search.Query getQuery()

Returns the Lucene query created while walking the parse tree.

Returns:

the Lucene query created while walking the parse tree

getTargetEntityName

public String getTargetEntityName()

Returns the original entity name as given in the query

Returns:

the entity name of the query

getTargetEntity

public Class<?> getTargetEntity()

Returns the entity type of the parsed query as derived from the queried entity name via the configured EntityNamesResolver.

Returns:

the entity type of the parsed query

getProjections

public List<String> getProjections()

Returns the projections of the parsed query, represented as dot paths in case of references to fields of embedded entities, e.g. ["foo", "bar.qaz"].

Returns:

a list with the projections of the parsed query; an empty list will be returned if no the query has no projections

getSort

public org.apache.lucene.search.Sort getSort()

Returns the optional Lucene sort specification.

Returns:

the Sort object or null if the query string does not specify sorting

toString

public String toString()

Overrides:

toString in class Object