Package org.codelibs.fess.entity

Class SearchRenderData

java.lang.Object
org.codelibs.fess.entity.SearchRenderData
Direct Known Subclasses:
AdminSearchlistAction.WebRenderData, SearchAction.WebRenderData
public class SearchRenderData extends Object
Data container for search results rendering. This class holds all the data needed to render search results in the UI, including the actual search results, pagination information, facet data, execution timing, and highlighting parameters.

  • Field Details

    • documentItems

      protected List<Map<String,Object>> documentItems
      List of search result documents.

    • facetResponse

      protected FacetResponse facetResponse
      Facet response containing aggregated search facets.

    • appendHighlightParams

      protected String appendHighlightParams
      Additional highlight parameters to append to URLs.

    • execTime

      protected String execTime
      Formatted execution time for the search request.

    • pageSize

      protected int pageSize
      Number of results per page.

    • currentPageNumber

      protected int currentPageNumber
      Current page number being displayed.

    • allRecordCount

      protected long allRecordCount
      Total number of records matching the search query.

    • allRecordCountRelation

      protected String allRecordCountRelation
      Relation type for the record count (e.g., "eq", "gte").

    • allPageCount

      protected int allPageCount
      Total number of pages based on record count and page size.

    • existNextPage

      protected boolean existNextPage
      Flag indicating whether a next page exists.

    • existPrevPage

      protected boolean existPrevPage
      Flag indicating whether a previous page exists.

    • currentStartRecordNumber

      protected long currentStartRecordNumber
      Starting record number for the current page.

    • currentEndRecordNumber

      protected long currentEndRecordNumber
      Ending record number for the current page.

    • pageNumberList

      protected List<String> pageNumberList
      List of page numbers for pagination navigation.

    • partialResults

      protected boolean partialResults
      Flag indicating whether the results are partial due to timeout or other issues.

    • searchQuery

      protected String searchQuery
      The actual search query executed against the search engine.

    • queryTime

      protected long queryTime
      Time taken to execute the search query in milliseconds.

    • requestedTime

      protected long requestedTime
      Timestamp when the search request was made.

    • queryId

      protected String queryId
      Unique identifier for this search query session.

  • Constructor Details

    • SearchRenderData

      public SearchRenderData()
      Default constructor for creating a new SearchRenderData instance.

  • Method Details

    • setDocumentItems

      public void setDocumentItems(List<Map<String,Object>> documentItems)
      Sets the list of search result documents.
      Parameters:
      documentItems - The list of search result documents

    • setFacetResponse

      public void setFacetResponse(FacetResponse facetResponse)
      Sets the facet response containing aggregated search facets.
      Parameters:
      facetResponse - The facet response

    • setAppendHighlightParams

      public void setAppendHighlightParams(String appendHighlightParams)
      Sets additional highlight parameters to append to URLs.
      Parameters:
      appendHighlightParams - The highlight parameters string

    • setExecTime

      public void setExecTime(String execTime)
      Sets the formatted execution time for the search request.
      Parameters:
      execTime - The formatted execution time string

    • setPageSize

      public void setPageSize(int pageSize)
      Sets the number of results per page.
      Parameters:
      pageSize - The page size

    • setCurrentPageNumber

      public void setCurrentPageNumber(int currentPageNumber)
      Sets the current page number being displayed.
      Parameters:
      currentPageNumber - The current page number

    • setAllRecordCount

      public void setAllRecordCount(long allRecordCount)
      Sets the total number of records matching the search query.
      Parameters:
      allRecordCount - The total record count

    • setAllRecordCountRelation

      public void setAllRecordCountRelation(String allRecordCountRelation)
      Sets the relation type for the record count (e.g., "eq", "gte").
      Parameters:
      allRecordCountRelation - The record count relation

    • setAllPageCount

      public void setAllPageCount(int allPageCount)
      Sets the total number of pages based on record count and page size.
      Parameters:
      allPageCount - The total page count

    • setExistNextPage

      public void setExistNextPage(boolean existNextPage)
      Sets whether a next page exists.
      Parameters:
      existNextPage - true if a next page exists

    • setExistPrevPage

      public void setExistPrevPage(boolean existPrevPage)
      Sets whether a previous page exists.
      Parameters:
      existPrevPage - true if a previous page exists

    • setCurrentStartRecordNumber

      public void setCurrentStartRecordNumber(long currentStartRecordNumber)
      Sets the starting record number for the current page.
      Parameters:
      currentStartRecordNumber - The starting record number

    • setCurrentEndRecordNumber

      public void setCurrentEndRecordNumber(long currentEndRecordNumber)
      Sets the ending record number for the current page.
      Parameters:
      currentEndRecordNumber - The ending record number

    • setPageNumberList

      public void setPageNumberList(List<String> pageNumberList)
      Sets the list of page numbers for pagination navigation.
      Parameters:
      pageNumberList - The page number list

    • setPartialResults

      public void setPartialResults(boolean partialResults)
      Sets whether the results are partial due to timeout or other issues.
      Parameters:
      partialResults - true if results are partial

    • setQueryTime

      public void setQueryTime(long queryTime)
      Sets the time taken to execute the search query in milliseconds.
      Parameters:
      queryTime - The query execution time in milliseconds

    • setSearchQuery

      public void setSearchQuery(String searchQuery)
      Sets the actual search query executed against the search engine.
      Parameters:
      searchQuery - The search query string

    • setRequestedTime

      public void setRequestedTime(long requestedTime)
      Sets the timestamp when the search request was made.
      Parameters:
      requestedTime - The request timestamp

    • setQueryId

      public void setQueryId(String queryId)
      Sets the unique identifier for this search query session.
      Parameters:
      queryId - The query identifier

    • getDocumentItems

      public List<Map<String,Object>> getDocumentItems()
      Gets the list of search result documents.
      Returns:
      The list of search result documents

    • getFacetResponse

      public FacetResponse getFacetResponse()
      Gets the facet response containing aggregated search facets.
      Returns:
      The facet response

    • getAppendHighlightParams

      public String getAppendHighlightParams()
      Gets additional highlight parameters to append to URLs.
      Returns:
      The highlight parameters string

    • getExecTime

      public String getExecTime()
      Gets the formatted execution time for the search request.
      Returns:
      The formatted execution time string

    • getPageSize

      public int getPageSize()
      Gets the number of results per page.
      Returns:
      The page size

    • getCurrentPageNumber

      public int getCurrentPageNumber()
      Gets the current page number being displayed.
      Returns:
      The current page number

    • getAllRecordCount

      public long getAllRecordCount()
      Gets the total number of records matching the search query.
      Returns:
      The total record count

    • getAllRecordCountRelation

      public String getAllRecordCountRelation()
      Gets the relation type for the record count (e.g., "eq", "gte").
      Returns:
      The record count relation

    • getAllPageCount

      public int getAllPageCount()
      Gets the total number of pages based on record count and page size.
      Returns:
      The total page count

    • isExistNextPage

      public boolean isExistNextPage()
      Checks whether a next page exists.
      Returns:
      true if a next page exists

    • isExistPrevPage

      public boolean isExistPrevPage()
      Checks whether a previous page exists.
      Returns:
      true if a previous page exists

    • getCurrentStartRecordNumber

      public long getCurrentStartRecordNumber()
      Gets the starting record number for the current page.
      Returns:
      The starting record number

    • getCurrentEndRecordNumber

      public long getCurrentEndRecordNumber()
      Gets the ending record number for the current page.
      Returns:
      The ending record number

    • getPageNumberList

      public List<String> getPageNumberList()
      Gets the list of page numbers for pagination navigation.
      Returns:
      The page number list

    • isPartialResults

      public boolean isPartialResults()
      Checks whether the results are partial due to timeout or other issues.
      Returns:
      true if results are partial

    • getSearchQuery

      public String getSearchQuery()
      Gets the actual search query executed against the search engine.
      Returns:
      The search query string

    • getQueryTime

      public long getQueryTime()
      Gets the time taken to execute the search query in milliseconds.
      Returns:
      The query execution time in milliseconds

    • getRequestedTime

      public long getRequestedTime()
      Gets the timestamp when the search request was made.
      Returns:
      The request timestamp

    • getQueryId

      public String getQueryId()
      Gets the unique identifier for this search query session.
      Returns:
      The query identifier

    • toString

      public String toString()
      Overrides:
      toString in class Object