ome.services.search

Class FullText

java.lang.Object

ome.services.search.SearchAction

ome.services.search.FullText

All Implemented Interfaces:

Serializable, Executor.Work

Direct Known Subclasses:

SomeMustNone

public class FullText
extends SearchAction

Search based on Lucene's Query class. Takes a Google-like search string and returns fully formed objects via Hibernate Search.

Since:

3.0-Beta3

Author:

Josh Moore, josh at glencoesoftware.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_PROJECTIONS
static String	TOTAL_SIZE

Fields inherited from class ome.services.search.SearchAction

chainedList, values

Constructor Summary

Constructors

Constructor and Description
FullText(SearchValues values, String query, Class<? extends org.apache.lucene.analysis.Analyzer> analyzer) Creates a new instance; Passes the query directly on to the Lucene parser.
FullText(SearchValues values, String fields, String from, String to, String dateType, String query, Class<? extends org.apache.lucene.analysis.Analyzer> analyzer) Constructs a new instance; Builds a Lucence query with the provided arguments and passes it on the Lucene parser

Method Summary

Methods

Modifier and Type	Method and Description
Object	doWork(org.hibernate.Session s, ServiceFactory sf) Work method.
Object[]	getProjections(IObject object)
Float	getScore(IObject object)
Integer	getTotalSize(IObject object)
protected void	initializeQuery(org.hibernate.search.FullTextQuery ftQuery) Allows settings offset and limit on the query.

Methods inherited from class ome.services.search.SearchAction

annotatedBetween, annotatedBetween, annotatedBy, annotatedBy, chainedSearch, copyOfValues, createdOrModified, createdOrModified, description, ids, ids, notNullOrLikeOrEqual, notNullOrLikeOrEqual, orderByAscending, orderByPath, ownerOrGroup, ownerOrGroup

Methods inherited from class java.lang.Object

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

Field Detail

ALL_PROJECTIONS

public static final String ALL_PROJECTIONS

See Also:

Constant Field Values

TOTAL_SIZE

public static final String TOTAL_SIZE

See Also:

Constant Field Values

Constructor Detail

FullText

public FullText(SearchValues values,
        String fields,
        String from,
        String to,
        String dateType,
        String query,
        Class<? extends org.apache.lucene.analysis.Analyzer> analyzer)

Constructs a new instance; Builds a Lucence query with the provided arguments and passes it on the Lucene parser

Parameters:

values -

fields - Comma separated field names (name, description, etc.)

from - Date range from in form YYYYMMDD

to - Date range to in form YYYYMMDD

dateType - Type of date Search.DATE_TYPE_ACQUISITION or Search.DATE_TYPE_IMPORT

query - The terms to search for

analyzer -

FullText

public FullText(SearchValues values,
        String query,
        Class<? extends org.apache.lucene.analysis.Analyzer> analyzer)

Creates a new instance; Passes the query directly on to the Lucene parser.

Parameters:

values -

query -

analyzer -

Method Detail

initializeQuery

protected void initializeQuery(org.hibernate.search.FullTextQuery ftQuery)

Allows settings offset and limit on the query. The default implementation calls setProjection with SCORE and ID, which MUST BE the first two projection values. Any overriding method may add further projections but must start with these two.

Parameters:

ftQuery -

doWork

@Transactional(readOnly=true)
public Object doWork(org.hibernate.Session s,
                          ServiceFactory sf)

Description copied from interface: Executor.Work

Work method. Must return all results coming from Hibernate via the Object return method.

Parameters:

s - non null.

sf - non null.

Returns:

Any results which will be used by non-wrapped code.

getScore

public Float getScore(IObject object)

getTotalSize

public Integer getTotalSize(IObject object)

getProjections

public Object[] getProjections(IObject object)