Package org.codelibs.fess.app.web.base

Class SearchForm

java.lang.Object

org.codelibs.fess.entity.SearchRequestParams

org.codelibs.fess.app.web.base.SearchForm

public class SearchForm
extends SearchRequestParams

Base search form class that extends SearchRequestParams. Provides form fields and methods for handling search requests in the web interface. Contains validation constraints and convenience methods for parameter processing.

Nested Class Summary

Nested classes/interfaces inherited from class org.codelibs.fess.entity.SearchRequestParams

SearchRequestParams.SearchRequestType

Field Summary

Fields

Modifier and Type	Field	Description
Map<String,String[]>	as	Map of advanced search conditions.
String[]	ex_q	Array of additional query strings to exclude from search.
Map<String,String[]>	fields	Map of additional search fields with their values.
String[]	lang	Array of language codes to filter search results.
Integer	num	The number of search results to return per page.
Integer	offset	The offset for search results.
Integer	pn	The page number for pagination.
@Size(max=1000) String	q	The main search query string.
@Size(max=1000) String	sdh	Similar document hash for finding related documents.
@Size(max=1000) String	sort	The sort parameter for search results.
Integer	start	The starting position for search results pagination.
@Size(max=100) String	track_total_hits	Parameter to control tracking of total hits in search results.

Fields inherited from class org.codelibs.fess.entity.SearchRequestParams

AS_EPQ, AS_FILETYPE, AS_NQ, AS_OCCURRENCE, AS_OQ, AS_Q, AS_SITESEARCH, AS_TIMESTAMP

Constructor Summary

Constructors

Constructor	Description
SearchForm()	Default constructor for SearchForm.

Method Summary

Modifier and Type	Method	Description
Object	getAttribute(String name)	Returns the attribute.
Map<String,String[]>	getConditions()	Returns the conditions.
String[]	getExtraQueries()	Returns the extra queries.
FacetInfo	getFacetInfo()	Returns the facet info.
Map<String,String[]>	getFields()	Returns the fields.
GeoInfo	getGeoInfo()	Returns the geo info.
HighlightInfo	getHighlightInfo()	Returns the highlight info.
String[]	getLanguages()	Returns the languages.
Locale	getLocale()	Returns the locale.
int	getOffset()	Returns the offset.
int	getPageSize()	Returns the page size.
String	getQuery()	Returns the query.
String	getSimilarDocHash()	Returns the similar document hash.
String	getSort()	Returns the sort.
int	getStartPosition()	Returns the start position.
String	getTrackTotalHits()	Returns the track total hits.
SearchRequestParams.SearchRequestType	getType()	Returns the search request type.

Methods inherited from class org.codelibs.fess.entity.SearchRequestParams

createFacetInfo, createGeoInfo, getMinScore, getParamValueArray, getResponseFields, hasConditionQuery, isEmptyArray, simplifyArray

Methods inherited from class java.lang.Object

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

Field Details

fields

public Map<String,String[]> fields

Map of additional search fields with their values.

as

public Map<String,String[]> as

Map of advanced search conditions.

q

@Size(max=1000)
public @Size(max=1000) String q

The main search query string.

sort

@Size(max=1000)
public @Size(max=1000) String sort

The sort parameter for search results.

num

@ValidateTypeFailure
public Integer num

The number of search results to return per page.

lang

public String[] lang

Array of language codes to filter search results.

ex_q

public String[] ex_q

Array of additional query strings to exclude from search.

start

@ValidateTypeFailure
public Integer start

The starting position for search results pagination.

offset

@ValidateTypeFailure
public Integer offset

The offset for search results.

pn

@ValidateTypeFailure
public Integer pn

The page number for pagination.

sdh

@Size(max=1000)
public @Size(max=1000) String sdh

Similar document hash for finding related documents.

track_total_hits

@Size(max=100)
public @Size(max=100) String track_total_hits

Parameter to control tracking of total hits in search results.

Constructor Details

SearchForm

public SearchForm()

Default constructor for SearchForm.

Method Details

getStartPosition

public int getStartPosition()

Description copied from class: SearchRequestParams

Returns the start position.

Specified by:

getStartPosition in class SearchRequestParams

Returns:

The start position.

getOffset

public int getOffset()

Description copied from class: SearchRequestParams

Returns the offset.

Specified by:

getOffset in class SearchRequestParams

Returns:

The offset.

getPageSize

public int getPageSize()

Description copied from class: SearchRequestParams

Returns the page size.

Specified by:

getPageSize in class SearchRequestParams

Returns:

The page size.

getQuery

public String getQuery()

Description copied from class: SearchRequestParams

Returns the query.

Specified by:

getQuery in class SearchRequestParams

Returns:

The query.

getExtraQueries

public String[] getExtraQueries()

Description copied from class: SearchRequestParams

Returns the extra queries.

Specified by:

getExtraQueries in class SearchRequestParams

Returns:

The extra queries.

getFields

public Map<String,String[]> getFields()

Description copied from class: SearchRequestParams

Returns the fields.

Specified by:

getFields in class SearchRequestParams

Returns:

The fields.

getLanguages

public String[] getLanguages()

Description copied from class: SearchRequestParams

Returns the languages.

Specified by:

getLanguages in class SearchRequestParams

Returns:

The languages.

getGeoInfo

public GeoInfo getGeoInfo()

Description copied from class: SearchRequestParams

Returns the geo info.

Specified by:

getGeoInfo in class SearchRequestParams

Returns:

The geo info.

getFacetInfo

public FacetInfo getFacetInfo()

Description copied from class: SearchRequestParams

Returns the facet info.

Specified by:

getFacetInfo in class SearchRequestParams

Returns:

The facet info.

getHighlightInfo

public HighlightInfo getHighlightInfo()

Description copied from class: SearchRequestParams

Returns the highlight info.

Specified by:

getHighlightInfo in class SearchRequestParams

Returns:

The highlight info.

getSort

public String getSort()

Description copied from class: SearchRequestParams

Returns the sort.

Specified by:

getSort in class SearchRequestParams

Returns:

The sort.

getAttribute

public Object getAttribute(String name)

Description copied from class: SearchRequestParams

Returns the attribute.

Specified by:

getAttribute in class SearchRequestParams

Parameters:

name - The name of the attribute.

Returns:

The attribute.

getLocale

public Locale getLocale()

Description copied from class: SearchRequestParams

Returns the locale.

Specified by:

getLocale in class SearchRequestParams

Returns:

The locale.

getType

public SearchRequestParams.SearchRequestType getType()

Description copied from class: SearchRequestParams

Returns the search request type.

Specified by:

getType in class SearchRequestParams

Returns:

The search request type.

getSimilarDocHash

public String getSimilarDocHash()

Description copied from class: SearchRequestParams

Returns the similar document hash.

Specified by:

getSimilarDocHash in class SearchRequestParams

Returns:

The similar document hash.

getConditions

public Map<String,String[]> getConditions()

Description copied from class: SearchRequestParams

Returns the conditions.

Specified by:

getConditions in class SearchRequestParams

Returns:

The conditions.

getTrackTotalHits

public String getTrackTotalHits()

Description copied from class: SearchRequestParams

Returns the track total hits.

Overrides:

getTrackTotalHits in class SearchRequestParams

Returns:

The track total hits.