Package org.codelibs.fess.app.web.api

Class ApiResult.ApiDocsResponse

java.lang.Object

org.codelibs.fess.app.web.api.ApiResult.ApiResponse

org.codelibs.fess.app.web.api.ApiResult.ApiDocsResponse

Enclosing class:

ApiResult

public static class ApiResult.ApiDocsResponse
extends ApiResult.ApiResponse

Represents an API response for search results, including document list, pagination, and facet information.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Map<String,Object>>	docs	The list of documents returned in the search results.
protected long	endRecordNumber	The ending record number for the current page of search results.
protected String	execTime	The execution time of the search query.
protected List<Map<String,Object>>	facetField	The list of facet fields and their values.
protected List<Map<String,Object>>	facetQuery	The list of facet queries and their counts.
protected String	highlightParams	Parameters for highlighting search results.
protected boolean	nextPage	Indicates if there is a next page of search results.
protected int	pageCount	The total number of pages in the search results.
protected int	pageNumber	The current page number of the search results.
protected List<String>	pageNumbers	The list of page numbers for pagination.
protected int	pageSize	The page size of the search results.
protected boolean	partial	Indicates if the search results are partial.
protected boolean	prevPage	Indicates if there is a previous page of search results.
protected String	queryId	The ID of the search query.
protected long	queryTime	The time taken for the search query in milliseconds.
protected long	recordCount	The total number of records found.
protected String	recordCountRelation	The relation of the record count (e.g., "eq" for exact, "gte" for greater than or equal to).
protected long	requestedTime	The time when the search request was made.
protected String	searchQuery	The search query string.
protected long	startRecordNumber	The starting record number for the current page of search results.

Fields inherited from class org.codelibs.fess.app.web.api.ApiResult.ApiResponse

status, version

Constructor Summary

Constructors

Constructor	Description
ApiDocsResponse()	Default constructor for ApiDocsResponse.

Method Summary

Modifier and Type	Method	Description
ApiResult.ApiDocsResponse	renderData(SearchRenderData data)	Populates this response with search render data.
ApiResult	result()	Returns a new ApiResult instance with this ApiResponse.

Methods inherited from class org.codelibs.fess.app.web.api.ApiResult.ApiResponse

status

Methods inherited from class java.lang.Object

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

Field Details

queryId

protected String queryId

The ID of the search query.

docs

protected List<Map<String,Object>> docs

The list of documents returned in the search results.

highlightParams

protected String highlightParams

Parameters for highlighting search results.

execTime

protected String execTime

The execution time of the search query.

pageSize

protected int pageSize

The page size of the search results.

pageNumber

protected int pageNumber

The current page number of the search results.

recordCount

protected long recordCount

The total number of records found.

recordCountRelation

protected String recordCountRelation

The relation of the record count (e.g., "eq" for exact, "gte" for greater than or equal to).

pageCount

protected int pageCount

The total number of pages in the search results.

nextPage

protected boolean nextPage

Indicates if there is a next page of search results.

prevPage

protected boolean prevPage

Indicates if there is a previous page of search results.

startRecordNumber

protected long startRecordNumber

The starting record number for the current page of search results.

endRecordNumber

protected long endRecordNumber

The ending record number for the current page of search results.

pageNumbers

protected List<String> pageNumbers

The list of page numbers for pagination.

partial

protected boolean partial

Indicates if the search results are partial.

queryTime

protected long queryTime

The time taken for the search query in milliseconds.

searchQuery

protected String searchQuery

The search query string.

requestedTime

protected long requestedTime

The time when the search request was made.

facetField

protected List<Map<String,Object>> facetField

The list of facet fields and their values.

facetQuery

protected List<Map<String,Object>> facetQuery

The list of facet queries and their counts.

Constructor Details

ApiDocsResponse

public ApiDocsResponse()

Default constructor for ApiDocsResponse.

Method Details

renderData

public ApiResult.ApiDocsResponse renderData(SearchRenderData data)

Populates this response with search render data.

Parameters:

data - The search render data to populate from.

Returns:

This ApiDocsResponse instance.

result

public ApiResult result()

Description copied from class: ApiResult.ApiResponse

Returns a new ApiResult instance with this ApiResponse.

Overrides:

result in class ApiResult.ApiResponse

Returns:

A new ApiResult instance.