Index (Opencast :: elasticsearch-api 19-SNAPSHOT API)

A C G I L O S V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

add(T) - Method in interface org.opencastproject.elasticsearch.api.SearchTerms: Adds a term to this list of terms.
addLocalizedValue(Language, T) - Method in interface org.opencastproject.elasticsearch.api.SearchMetadata: Adds value to the list of language neutral values.
addToText() - Method in interface org.opencastproject.elasticsearch.api.SearchMetadata: Returns true if the values should be added to the user facing fulltext search index.
addValue(T) - Method in interface org.opencastproject.elasticsearch.api.SearchMetadata: Adds value to the list of language neutral values.
All - Enum constant in enum class org.opencastproject.elasticsearch.api.SearchTerms.Quantifier
Any - Enum constant in enum class org.opencastproject.elasticsearch.api.SearchTerms.Quantifier

C

clear() - Method in interface org.opencastproject.elasticsearch.api.SearchIndex: Clears the search index.
clear() - Method in interface org.opencastproject.elasticsearch.api.SearchMetadata: Removes all values currently in the metadata container.
contains(T) - Method in interface org.opencastproject.elasticsearch.api.SearchTerms: Returns true if term is contained in the list of terms.

G

getDescription() - Method in interface org.opencastproject.elasticsearch.api.Language: Returns the name of this language in its own language, e.g English for English Deutsch for German Français for French
getDescription(Language) - Method in interface org.opencastproject.elasticsearch.api.Language: Returns the name of this language in the specified language, e.g given that language was German, this method would return: Englisch for English Deutsch for German Französisch for French
getDocumentCount() - Method in interface org.opencastproject.elasticsearch.api.SearchResult: Returns the total number of items in the search result.
getFields() - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns the fields that should be returned by the query.
getFilter() - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns the filter expression.
getHitCount() - Method in interface org.opencastproject.elasticsearch.api.SearchResult: Returns the total number of appearances of the search criteria in the search result, spread over getDocumentCount number of documents.
getIdentifier() - Method in interface org.opencastproject.elasticsearch.api.Language: Returns the language's identifier, which corresponds to the locales name for this language.
getIndexVersion() - Method in interface org.opencastproject.elasticsearch.api.SearchIndex: Returns the index's version number.
getItems() - Method in interface org.opencastproject.elasticsearch.api.SearchResult: Returns the individual items of this search result.
getLimit() - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns the number of results that are returned, starting at the offset returned by getOffset().
getLimit() - Method in interface org.opencastproject.elasticsearch.api.SearchResult: Returns the limit of this search results or -1 if no limit has been specified.
getLocale() - Method in interface org.opencastproject.elasticsearch.api.Language: Returns the locale that is associated with the language.
getLocalizedValues() - Method in interface org.opencastproject.elasticsearch.api.SearchMetadata: Returns the values for this metadata item, mapped to their respective languages.
getName() - Method in interface org.opencastproject.elasticsearch.api.SearchMetadata: Returns the name of this metadata item.
getOffset() - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns the starting offset within the search result or 0 if no offset was specified.
getOffset() - Method in interface org.opencastproject.elasticsearch.api.SearchResult: Get the offset within the search result or -1 if no limit has been specified.
getPage() - Method in interface org.opencastproject.elasticsearch.api.SearchResult: Returns the page of the current result items within the complete search result.
getPageSize() - Method in interface org.opencastproject.elasticsearch.api.SearchResult: Returns the number of items in this search result, possibly limited with respect to the total number of result items by offset and limit.
getQuantifier() - Method in interface org.opencastproject.elasticsearch.api.SearchTerms: Returns this group's quantifier.
getQueryString() - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns the search text or null if no text was specified.
getRelevance() - Method in interface org.opencastproject.elasticsearch.api.SearchResultItem: Returns the relevance of this hit with respect to the search terms.
getSearchTime() - Method in interface org.opencastproject.elasticsearch.api.SearchResult: Returns the search time in milliseconds.
getSortOrder(String) - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns the sort order of a field.
getSortOrders() - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns all the known sort orders.
getSource() - Method in interface org.opencastproject.elasticsearch.api.SearchResultItem: Returns the source of this search result.
getTerms() - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns the search terms or an empty collection if no terms were specified.
getTerms() - Method in interface org.opencastproject.elasticsearch.api.SearchTerms: Returns the terms.
getTypes() - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns the document types or or an empty array if no types were specified.
getValue() - Method in interface org.opencastproject.elasticsearch.api.SearchMetadata: Returns the first value of the available values or null if no value is available.
getValues() - Method in interface org.opencastproject.elasticsearch.api.SearchMetadata: Returns a list of all all non-localized values.

I

INDEX_VERSION - Static variable in interface org.opencastproject.elasticsearch.api.SearchIndex: Version of this index
isFuzzySearch() - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns true if the current search operation should be performed using fuzzy searching.
isLocalized() - Method in interface org.opencastproject.elasticsearch.api.SearchMetadata: Returns true if this metadata item has been localized.

L

Language - Interface in org.opencastproject.elasticsearch.api: A Language consists of a language identifier, e.g.

O

org.opencastproject.elasticsearch.api - package org.opencastproject.elasticsearch.api

S

SearchIndex - Interface in org.opencastproject.elasticsearch.api
SearchIndexException - Exception Class in org.opencastproject.elasticsearch.api: Exception that is thrown if service level error states occur when working with a search index.
SearchIndexException(String) - Constructor for exception class org.opencastproject.elasticsearch.api.SearchIndexException: Creates a new search index exception with the given message.
SearchIndexException(String, Throwable) - Constructor for exception class org.opencastproject.elasticsearch.api.SearchIndexException: Creates a new search index exception with the given message and root cause.
SearchIndexException(Throwable) - Constructor for exception class org.opencastproject.elasticsearch.api.SearchIndexException: Creates a new search index exception with the given root cause.
SearchMetadata<T> - Interface in org.opencastproject.elasticsearch.api: Resource metadata models a piece of metadata that describes one aspect of a resource, e. g. the title.
SearchQuery - Interface in org.opencastproject.elasticsearch.api: Interface for the implementation of search queries.
SearchResult<T> - Interface in org.opencastproject.elasticsearch.api: A result as returned by a search operation.
SearchResultItem<T> - Interface in org.opencastproject.elasticsearch.api: The search result is what is delivered by the search function.
SearchTerms<T> - Interface in org.opencastproject.elasticsearch.api: Interface for a data structure that is wrapping a group of search terms.
SearchTerms.Quantifier - Enum Class in org.opencastproject.elasticsearch.api: The search quantifier
setAddToText(boolean) - Method in interface org.opencastproject.elasticsearch.api.SearchMetadata: Adds the metadata values to the user facing fulltext index.
size() - Method in interface org.opencastproject.elasticsearch.api.SearchTerms: Returns the number of terms.

V

valueOf(String) - Static method in enum class org.opencastproject.elasticsearch.api.SearchTerms.Quantifier: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.opencastproject.elasticsearch.api.SearchTerms.Quantifier: Returns an array containing the constants of this enum class, in the order they are declared.

W

withField(String) - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Adds a field that needs to be returned by the query.
withFields(String...) - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Adds the fields that need to be returned by the query.
withFilter(String) - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns documents that match the search query and the text filter.
withLimit(int) - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Sets the number of results that are returned.
withOffset(int) - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Sets the starting offset.
withSortOrder(String, SortCriterion.Order) - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Sort the result set by the field and the given order.
withText(boolean, String) - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns documents that contain the given text.
withText(boolean, SearchTerms.Quantifier, String...) - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns documents that contain the given text.
withText(String) - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Returns documents that contain the given text.
withTypes(String...) - Method in interface org.opencastproject.elasticsearch.api.SearchQuery: Return documents of the given types.

A C G I L O S V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form