Package org.codelibs.fess.api.json

Class SearchApiManager.RequestParameter

java.lang.Object

org.codelibs.fess.entity.SearchRequestParams

org.codelibs.fess.api.json.SearchApiManager.RequestParameter

Enclosing class:

SearchApiManager

protected static class SearchApiManager.RequestParameter
extends SearchRequestParams

The request parameters for suggest API.

Nested Class Summary

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

SearchRequestParams.SearchRequestType

Field Summary

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

Modifier	Constructor	Description
protected	RequestParameter(jakarta.servlet.http.HttpServletRequest request, String query, String[] tags, String[] fields, int num)	Constructor for RequestParameter.

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.
protected int	getNum()	Gets the maximum number of suggestions to return.
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.
protected String[]	getSuggestFields()	Gets the suggest fields for the request.
String[]	getTags()	Gets the tags for filtering suggestions.
SearchRequestParams.SearchRequestType	getType()	Returns the search request type.
protected static SearchApiManager.RequestParameter	parse(jakarta.servlet.http.HttpServletRequest request)	Parses the HTTP request to create a RequestParameter object.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

RequestParameter

protected RequestParameter(jakarta.servlet.http.HttpServletRequest request,
 String query,
 String[] tags,
 String[] fields,
 int num)

Constructor for RequestParameter.

Parameters:

request - The HTTP servlet request

query - The search query string

tags - Array of tags to filter suggestions

fields - Array of fields to search in for suggestions

num - The maximum number of suggestions to return

Method Details

parse

protected static SearchApiManager.RequestParameter parse(jakarta.servlet.http.HttpServletRequest request)

Parses the HTTP request to create a RequestParameter object.

Parameters:

request - The HTTP servlet request containing the parameters

Returns:

A new RequestParameter object with parsed values

getQuery

public String getQuery()

Description copied from class: SearchRequestParams

Returns the query.

Specified by:

getQuery in class SearchRequestParams

Returns:

The query.

getSuggestFields

protected String[] getSuggestFields()

Gets the suggest fields for the request.

Returns:

Array of field names to search in for suggestions

getNum

protected int getNum()

Gets the maximum number of suggestions to return.

Returns:

The maximum number of suggestions

getFields

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

Description copied from class: SearchRequestParams

Returns the fields.

Specified by:

getFields in class SearchRequestParams

Returns:

The fields.

getConditions

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

Description copied from class: SearchRequestParams

Returns the conditions.

Specified by:

getConditions in class SearchRequestParams

Returns:

The conditions.

getTags

public String[] getTags()

Gets the tags for filtering suggestions.

Returns:

Array of tags used to filter suggestions

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.

getSort

public String getSort()

Description copied from class: SearchRequestParams

Returns the sort.

Specified by:

getSort in class SearchRequestParams

Returns:

The sort.

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.

getExtraQueries

public String[] getExtraQueries()

Description copied from class: SearchRequestParams

Returns the extra queries.

Specified by:

getExtraQueries in class SearchRequestParams

Returns:

The extra queries.

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.

getHighlightInfo

public HighlightInfo getHighlightInfo()

Description copied from class: SearchRequestParams

Returns the highlight info.

Specified by:

getHighlightInfo in class SearchRequestParams

Returns:

The highlight info.