A C D E F G H I O P Q R S T U V

A

addFilterQuery(String) - Method in class org.craftercms.search.service.impl.SolrQuery

addParam(String, String) - Method in class org.craftercms.search.service.impl.QueryParams

addParam(String, String...) - Method in class org.craftercms.search.service.impl.QueryParams

AdminRestApiConstants - Class in org.craftercms.search.rest.v2

Created by alfonsovasquez on 2/6/17.

AdminService - Interface in org.craftercms.search.service

Created by alfonsovasquez on 2/3/17.

AdminService.IndexDeleteMode - Enum in org.craftercms.search.service

C

commit() - Method in interface org.craftercms.search.service.SearchService

Commits any pending changes made to the search engine's default index.

commit(String) - Method in interface org.craftercms.search.service.SearchService

Commits any pending changes made to the search engine's default index.

createIndex(String) - Method in interface org.craftercms.search.service.AdminService

CreateIndexRequest - Class in org.craftercms.search.rest.v2.requests

Created by alfonsovasquez on 2/6/17.

CreateIndexRequest() - Constructor for class org.craftercms.search.rest.v2.requests.CreateIndexRequest

CreateIndexRequest(String) - Constructor for class org.craftercms.search.rest.v2.requests.CreateIndexRequest

createQuery() - Method in interface org.craftercms.search.service.QueryFactory

createQuery(Map<String, String[]>) - Method in interface org.craftercms.search.service.QueryFactory

D

delete(String, String) - Method in interface org.craftercms.search.service.SearchService

Deletes the search engine's index data of an XML document.

delete(String, String, String) - Method in interface org.craftercms.search.service.SearchService

Deletes the search engine's index data of an XML document.

deleteIndex(String, AdminService.IndexDeleteMode) - Method in interface org.craftercms.search.service.AdminService

DeleteIndexRequest - Class in org.craftercms.search.rest.v2.requests

Created by alfonsovasquez on 2/6/17.

DeleteIndexRequest() - Constructor for class org.craftercms.search.rest.v2.requests.DeleteIndexRequest

DISABLE_ADDITIONAL_FILTERS_PARAM - Static variable in class org.craftercms.search.service.impl.QueryParams

DOCUMENTS_KEY - Static variable in class org.craftercms.search.utils.SearchResultUtils

E

escapeChars(String, String) - Static method in class org.craftercms.search.utils.SolrQueryUtils

Escapes the characters from chars in the str parameter.

escapeUserSearchQuery(String) - Static method in class org.craftercms.search.utils.SolrQueryUtils

Escapes characters in a user search query (the search terms the user entered).

F

FIELDS_TO_RETURN - Static variable in class org.craftercms.search.service.impl.SolrQuery

FILTER_QUERY_PARAM - Static variable in class org.craftercms.search.service.impl.SolrQuery

G

getDeleteMode() - Method in class org.craftercms.search.rest.v2.requests.DeleteIndexRequest

getDocuments(Map<String, Object>) - Static method in class org.craftercms.search.utils.SearchResultUtils

Extract the documents from the specified result.

getFieldsToReturn() - Method in class org.craftercms.search.service.impl.SolrQuery

getFieldsToReturn() - Method in interface org.craftercms.search.service.Query

Returns the fields that should be returned.

getFilterQueries() - Method in class org.craftercms.search.service.impl.SolrQuery

getHighlightFields() - Method in class org.craftercms.search.service.impl.SolrQuery

getHighlightSnippets() - Method in class org.craftercms.search.service.impl.SolrQuery

getHighlightSnippetSize() - Method in class org.craftercms.search.service.impl.SolrQuery

getId() - Method in class org.craftercms.search.rest.v2.requests.CreateIndexRequest

getIndexId() - Method in exception org.craftercms.search.exception.SearchException

getIndexInfo(String) - Method in interface org.craftercms.search.service.AdminService

getNumResults() - Method in class org.craftercms.search.service.impl.SolrQuery

getNumResults() - Method in interface org.craftercms.search.service.Query

Returns the number of results to return.

getOffset() - Method in class org.craftercms.search.service.impl.SolrQuery

getOffset() - Method in interface org.craftercms.search.service.Query

Returns the offset of the results.

getParam(String) - Method in class org.craftercms.search.service.impl.QueryParams

getParams() - Method in class org.craftercms.search.service.impl.QueryParams

getQuery() - Method in class org.craftercms.search.service.impl.SolrQuery

getQuery() - Method in interface org.craftercms.search.service.Query

Returns the actual query.

getRows() - Method in class org.craftercms.search.service.impl.SolrQuery

getSingleValue(String) - Method in class org.craftercms.search.service.impl.QueryParams

getStart() - Method in class org.craftercms.search.service.impl.SolrQuery

H

hasParam(String) - Method in class org.craftercms.search.service.impl.QueryParams

HIGHLIGHT_FIELDS_PARAM - Static variable in class org.craftercms.search.service.impl.SolrQuery

HIGHLIGHT_PARAM - Static variable in class org.craftercms.search.service.impl.SolrQuery

HIGHLIGHT_SNIPPET_SIZE_PARAM - Static variable in class org.craftercms.search.service.impl.SolrQuery

HIGHLIGHT_SNIPPETS_PARAM - Static variable in class org.craftercms.search.service.impl.SolrQuery

I

indexId - Variable in exception org.craftercms.search.exception.SearchException

IndexNotFoundException - Exception in org.craftercms.search.exception

Created by alfonsovasquez on 2/14/17.

IndexNotFoundException(String) - Constructor for exception org.craftercms.search.exception.IndexNotFoundException

isDisableAdditionalFilters() - Method in class org.craftercms.search.service.impl.QueryParams

isDisableAdditionalFilters() - Method in interface org.craftercms.search.service.Query

Returns true if the additional Crafter Search filters should be disabled on query execution.

isHighlight() - Method in class org.craftercms.search.service.impl.SolrQuery

O

org.craftercms.search.exception - package org.craftercms.search.exception

org.craftercms.search.rest.v1 - package org.craftercms.search.rest.v1

org.craftercms.search.rest.v2 - package org.craftercms.search.rest.v2

org.craftercms.search.rest.v2.requests - package org.craftercms.search.rest.v2.requests

org.craftercms.search.service - package org.craftercms.search.service

org.craftercms.search.service.impl - package org.craftercms.search.service.impl

org.craftercms.search.utils - package org.craftercms.search.utils

P

PARAM_CONTENT - Static variable in class org.craftercms.search.rest.v2.SearchRestApiConstants

PARAM_DELETE_MODE - Static variable in class org.craftercms.search.rest.v2.AdminRestApiConstants

PARAM_FILE - Static variable in class org.craftercms.search.rest.v1.SearchRestApiConstants

PARAM_ID - Static variable in class org.craftercms.search.rest.v1.SearchRestApiConstants

PARAM_ID - Static variable in class org.craftercms.search.rest.v2.SearchRestApiConstants

PARAM_IGNORE_ROOT_IN_FIELD_NAMES - Static variable in class org.craftercms.search.rest.v1.SearchRestApiConstants

PARAM_IGNORE_ROOT_IN_FIELD_NAMES - Static variable in class org.craftercms.search.rest.v2.SearchRestApiConstants

PARAM_INDEX_ID - Static variable in class org.craftercms.search.rest.v1.SearchRestApiConstants

PARAM_INDEX_ID - Static variable in class org.craftercms.search.rest.v2.SearchRestApiConstants

PARAM_SITE - Static variable in class org.craftercms.search.rest.v1.SearchRestApiConstants

PARAM_SITE - Static variable in class org.craftercms.search.rest.v2.SearchRestApiConstants

PATH_VAR_ID - Static variable in class org.craftercms.search.rest.v2.AdminRestApiConstants

Q

Query - Interface in org.craftercms.search.service

Base query that is passed to SearchService.search(Query).

QUERY_PARAM - Static variable in class org.craftercms.search.service.impl.SolrQuery

QueryFactory<T extends Query> - Interface in org.craftercms.search.service

Factory for creating specific types of Querys

QueryParams - Class in org.craftercms.search.service.impl

Simple Query represented as a map of query parameters.

QueryParams() - Constructor for class org.craftercms.search.service.impl.QueryParams

QueryParams(Map<String, String[]>) - Constructor for class org.craftercms.search.service.impl.QueryParams

R

RESPONSE_KEY - Static variable in class org.craftercms.search.utils.SearchResultUtils

ROWS_PARAM - Static variable in class org.craftercms.search.service.impl.SolrQuery

S

search(T) - Method in interface org.craftercms.search.service.SearchService

Does a full-text search and returns a Map model.

search(String, T) - Method in interface org.craftercms.search.service.SearchService

Does a full-text search and returns a Map model.

SearchException - Exception in org.craftercms.search.exception

Thrown when an error occurs in the SearchService.

SearchException(String) - Constructor for exception org.craftercms.search.exception.SearchException

SearchException(String, Throwable) - Constructor for exception org.craftercms.search.exception.SearchException

SearchException(String, String) - Constructor for exception org.craftercms.search.exception.SearchException

SearchException(String, String, Throwable) - Constructor for exception org.craftercms.search.exception.SearchException

SearchRestApiConstants - Class in org.craftercms.search.rest.v1

Search API REST constants used by both server and client (API v1).

SearchRestApiConstants - Class in org.craftercms.search.rest.v2

Search API REST constants used by both server and client.

SearchResultUtils - Class in org.craftercms.search.utils

Utility methods for handling search results

SearchResultUtils() - Constructor for class org.craftercms.search.utils.SearchResultUtils

SearchServerException - Exception in org.craftercms.search.exception

Exception thrown when the search engine is not available.

SearchServerException(String) - Constructor for exception org.craftercms.search.exception.SearchServerException

SearchServerException(String, Throwable) - Constructor for exception org.craftercms.search.exception.SearchServerException

SearchServerException(String, String) - Constructor for exception org.craftercms.search.exception.SearchServerException

SearchServerException(String, String, Throwable) - Constructor for exception org.craftercms.search.exception.SearchServerException

SearchService<T extends Query> - Interface in org.craftercms.search.service

Provides a basic interface to a search engine, like Solr.

setDeleteMode(AdminService.IndexDeleteMode) - Method in class org.craftercms.search.rest.v2.requests.DeleteIndexRequest

setDisableAdditionalFilters(boolean) - Method in class org.craftercms.search.service.impl.QueryParams

setDisableAdditionalFilters(boolean) - Method in interface org.craftercms.search.service.Query

Sets if the additional Crafter Search filters should be disabled on query execution.

setFieldsToReturn(String...) - Method in class org.craftercms.search.service.impl.SolrQuery

setFieldsToReturn(String...) - Method in interface org.craftercms.search.service.Query

Sets the fields that should be returned.

setFilterQueries(String...) - Method in class org.craftercms.search.service.impl.SolrQuery

setHighlight(boolean) - Method in class org.craftercms.search.service.impl.SolrQuery

setHighlightFields(String...) - Method in class org.craftercms.search.service.impl.SolrQuery

setHighlightSnippets(int) - Method in class org.craftercms.search.service.impl.SolrQuery

setHighlightSnippetSize(int) - Method in class org.craftercms.search.service.impl.SolrQuery

setId(String) - Method in class org.craftercms.search.rest.v2.requests.CreateIndexRequest

setNumResults(int) - Method in class org.craftercms.search.service.impl.SolrQuery

setNumResults(int) - Method in interface org.craftercms.search.service.Query

Sets the number of results to return.

setOffset(int) - Method in class org.craftercms.search.service.impl.SolrQuery

setOffset(int) - Method in interface org.craftercms.search.service.Query

Sets the offset of the results.

setParam(String, String) - Method in class org.craftercms.search.service.impl.QueryParams

setQuery(String) - Method in class org.craftercms.search.service.impl.SolrQuery

setQuery(String) - Method in interface org.craftercms.search.service.Query

Sets the actual query.

setRows(int) - Method in class org.craftercms.search.service.impl.SolrQuery

setStart(int) - Method in class org.craftercms.search.service.impl.SolrQuery

SolrQuery - Class in org.craftercms.search.service.impl

Search query for Solr.

SolrQuery() - Constructor for class org.craftercms.search.service.impl.SolrQuery

SolrQuery(Map<String, String[]>) - Constructor for class org.craftercms.search.service.impl.SolrQuery

SolrQueryUtils - Class in org.craftercms.search.utils

Utility methods for Solr queries.

START_PARAM - Static variable in class org.craftercms.search.service.impl.SolrQuery

T

toString() - Method in class org.craftercms.search.service.impl.QueryParams

toUrlQueryString() - Method in class org.craftercms.search.service.impl.QueryParams

toUrlQueryString() - Method in interface org.craftercms.search.service.Query

Converts this query to an URL query string.

U

update(String, String, String, boolean) - Method in interface org.craftercms.search.service.SearchService

Updates the search engine's index data of an XML document.

update(String, String, String, String, boolean) - Method in interface org.craftercms.search.service.SearchService

Updates the search engine's index data of an XML document.

updateContent(String, String, File) - Method in interface org.craftercms.search.service.SearchService

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

updateContent(String, String, String, File) - Method in interface org.craftercms.search.service.SearchService

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

updateContent(String, String, File, Map<String, List<String>>) - Method in interface org.craftercms.search.service.SearchService

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

updateContent(String, String, String, File, Map<String, List<String>>) - Method in interface org.craftercms.search.service.SearchService

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

updateContent(String, String, Content) - Method in interface org.craftercms.search.service.SearchService

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

updateContent(String, String, String, Content) - Method in interface org.craftercms.search.service.SearchService

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

updateContent(String, String, Content, Map<String, List<String>>) - Method in interface org.craftercms.search.service.SearchService

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

updateContent(String, String, String, Content, Map<String, List<String>>) - Method in interface org.craftercms.search.service.SearchService

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

URL_COMMIT - Static variable in class org.craftercms.search.rest.v1.SearchRestApiConstants

URL_COMMIT - Static variable in class org.craftercms.search.rest.v2.SearchRestApiConstants

URL_CREATE_INDEX - Static variable in class org.craftercms.search.rest.v2.AdminRestApiConstants

URL_DELETE - Static variable in class org.craftercms.search.rest.v1.SearchRestApiConstants

URL_DELETE - Static variable in class org.craftercms.search.rest.v2.SearchRestApiConstants

URL_DELETE_INDEX - Static variable in class org.craftercms.search.rest.v2.AdminRestApiConstants

URL_GET_INDEX_INFO - Static variable in class org.craftercms.search.rest.v2.AdminRestApiConstants

URL_PARTIAL_DOCUMENT_UPDATE - Static variable in class org.craftercms.search.rest.v1.SearchRestApiConstants

URL_ROOT - Static variable in class org.craftercms.search.rest.v1.SearchRestApiConstants

URL_ROOT - Static variable in class org.craftercms.search.rest.v2.AdminRestApiConstants

URL_ROOT - Static variable in class org.craftercms.search.rest.v2.SearchRestApiConstants

URL_SEARCH - Static variable in class org.craftercms.search.rest.v1.SearchRestApiConstants

URL_SEARCH - Static variable in class org.craftercms.search.rest.v2.SearchRestApiConstants

URL_UPDATE - Static variable in class org.craftercms.search.rest.v1.SearchRestApiConstants

URL_UPDATE - Static variable in class org.craftercms.search.rest.v2.SearchRestApiConstants

URL_UPDATE_CONTENT - Static variable in class org.craftercms.search.rest.v2.SearchRestApiConstants

URL_UPDATE_DOCUMENT - Static variable in class org.craftercms.search.rest.v1.SearchRestApiConstants

URL_UPDATE_FILE - Static variable in class org.craftercms.search.rest.v1.SearchRestApiConstants

USER_SEARCH_QUERY_ILLEGAL_CHARS - Static variable in class org.craftercms.search.utils.SolrQueryUtils

V

valueOf(String) - Static method in enum org.craftercms.search.service.AdminService.IndexDeleteMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.craftercms.search.service.AdminService.IndexDeleteMode

Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H I O P Q R S T U V