A C D E G I J N O P Q R S T U

A

AbstractResultRankerFactory - Class in info.magnolia.periscope.rank

Abstract factory for ResultRanker bound to a User.

AbstractResultRankerFactory(ServerConfiguration) - Constructor for class info.magnolia.periscope.rank.AbstractResultRankerFactory

AbstractSearchResultSupplierDefinition - Class in info.magnolia.periscope.search

Partial supplier implementation with some default values.

AbstractSearchResultSupplierDefinition() - Constructor for class info.magnolia.periscope.search.AbstractSearchResultSupplierDefinition

addResults(Collection<SearchResult>) - Method in class info.magnolia.periscope.rank.NoopResultRanker

addResults(Collection<SearchResult>) - Method in interface info.magnolia.periscope.rank.ResultRanker

AppNavigationRequest - Class in info.magnolia.periscope.operation.request

Request to navigate to an app within Magnolia.

AppNavigationRequest() - Constructor for class info.magnolia.periscope.operation.request.AppNavigationRequest

C

cancel() - Method in class info.magnolia.periscope.search.SearchRunBatch

consider(String) - Method in class info.magnolia.periscope.sniff.QuerySnifferProcessor

construct(String, JcrSearchResultSupplierDefinition) - Method in class info.magnolia.periscope.search.jcr.JcrSearchResultSupplierStrategy

construct(String, RestSearchResultSupplierDefinition) - Method in class info.magnolia.periscope.search.rest.RestSearchResultSupplierStrategy

construct(String, D) - Method in interface info.magnolia.periscope.search.SearchResultSupplierStrategy

constructDateClause(SearchQuery) - Method in class info.magnolia.periscope.search.rest.RestSearchResultSupplier

constructEditorClause(SearchQuery) - Method in class info.magnolia.periscope.search.rest.RestSearchResultSupplier

constructTargetUrl(SearchQuery) - Method in class info.magnolia.periscope.search.rest.RestSearchResultSupplier

ContentNavigationRequest - Class in info.magnolia.periscope.operation.request

Request to navigate to content node within Magnolia.

ContentNavigationRequest() - Constructor for class info.magnolia.periscope.operation.request.ContentNavigationRequest

createRanker(User) - Method in class info.magnolia.periscope.rank.AbstractResultRankerFactory

createRanker(User) - Method in class info.magnolia.periscope.rank.NoopResultRankerFactory

createRanker(User) - Method in interface info.magnolia.periscope.rank.ResultRankerFactory

D

DEFAULT_NUMBER_OF_THREADS - Static variable in class info.magnolia.periscope.Periscope

doCreateRanker(User) - Method in class info.magnolia.periscope.rank.AbstractResultRankerFactory

E

EmptyPeriscopeTagsProvider - Class in info.magnolia.periscope.tag

A empty tags provider which is responsible to return null tags by default.

execute(OperationRequest) - Method in class info.magnolia.periscope.operation.request.OperationRequestProcessor

execute(Collection<? extends SearchResultSupplier>, Function<SearchResultSupplier, List<SupplierAwareSearchResult>>) - Method in class info.magnolia.periscope.search.SearchRunner

execute(Matcher) - Method in class info.magnolia.periscope.sniff.PatternCommandSniffer

executeOperation(OperationRequest) - Method in class info.magnolia.periscope.Periscope

ExternalNavigationRequest - Class in info.magnolia.periscope.operation.request

Request for navigating to an external URL.

ExternalNavigationRequest() - Constructor for class info.magnolia.periscope.operation.request.ExternalNavigationRequest

G

getAllTags() - Method in class info.magnolia.periscope.tag.EmptyPeriscopeTagsProvider

getName() - Method in class info.magnolia.periscope.search.jcr.JcrSearchResultSupplier

getName() - Method in class info.magnolia.periscope.search.rest.RestSearchResultSupplier

getPattern() - Method in class info.magnolia.periscope.sniff.PatternCommandSniffer

getResultLimit() - Method in class info.magnolia.periscope.search.AbstractSearchResultSupplierDefinition

getResultLimit() - Method in interface info.magnolia.periscope.search.SearchResultSupplierDefinition

getResultsPromises() - Method in class info.magnolia.periscope.search.SearchRunBatch

getResultSuppliers() - Method in class info.magnolia.periscope.Periscope

getStrategy() - Method in class info.magnolia.periscope.search.jcr.JcrSearchResultSupplierDefinition

getStrategy() - Method in class info.magnolia.periscope.search.rest.RestSearchResultSupplierDefinition

getStrategy() - Method in interface info.magnolia.periscope.search.SearchResultSupplierDefinition

getTagsProperty() - Method in class info.magnolia.periscope.tag.EmptyPeriscopeTagsProvider

getWorkspace() - Method in class info.magnolia.periscope.search.jcr.JcrSearchResultSupplier

I

info.magnolia.periscope - package info.magnolia.periscope

info.magnolia.periscope.operation - package info.magnolia.periscope.operation

info.magnolia.periscope.operation.request - package info.magnolia.periscope.operation.request

info.magnolia.periscope.rank - package info.magnolia.periscope.rank

info.magnolia.periscope.search - package info.magnolia.periscope.search

info.magnolia.periscope.search.jcr - package info.magnolia.periscope.search.jcr

info.magnolia.periscope.search.rest - package info.magnolia.periscope.search.rest

info.magnolia.periscope.sniff - package info.magnolia.periscope.sniff

info.magnolia.periscope.tag - package info.magnolia.periscope.tag

InternalNavigationRequest - Class in info.magnolia.periscope.operation.request

Request for navigating to a Magnolia-internal target, a path within a workspace (that is, the corresponding app).

InternalNavigationRequest() - Constructor for class info.magnolia.periscope.operation.request.InternalNavigationRequest

isCancelled() - Method in class info.magnolia.periscope.search.SearchRunBatch

isEnabled() - Method in class info.magnolia.periscope.search.AbstractSearchResultSupplierDefinition

isEnabled() - Method in interface info.magnolia.periscope.search.SearchResultSupplierDefinition

Defines if this ResultSupplier should be enabled when performing a Periscope search.

J

JcrSearchResultSupplier - Class in info.magnolia.periscope.search.jcr

A generic JCR Search result supplier which is composed of a workspace, node types and property and full-text search option}.

JcrSearchResultSupplier(String, JcrSearchResultSupplierDefinition, PeriscopeTagsProvider) - Constructor for class info.magnolia.periscope.search.jcr.JcrSearchResultSupplier

JcrSearchResultSupplierDefinition - Class in info.magnolia.periscope.search.jcr

A Search result supplier definition for JCR.

JcrSearchResultSupplierDefinition() - Constructor for class info.magnolia.periscope.search.jcr.JcrSearchResultSupplierDefinition

JcrSearchResultSupplierStrategy - Class in info.magnolia.periscope.search.jcr

Knows how to construct a JCR Search result supplier from JcrSearchResultSupplierDefinition.

JcrSearchResultSupplierStrategy() - Constructor for class info.magnolia.periscope.search.jcr.JcrSearchResultSupplierStrategy

N

newMetadataBuilder() - Method in class info.magnolia.periscope.operation.OperationDefinitionRegistry

newMetadataBuilder() - Method in class info.magnolia.periscope.search.SearchResultSupplierDefinitionRegistry

newMetadataBuilder() - Method in class info.magnolia.periscope.sniff.QuerySnifferDefinitionRegistry

NodeNavigationRequest - Class in info.magnolia.periscope.operation.request

Request to navigate to node within Magnolia.

NodeNavigationRequest() - Constructor for class info.magnolia.periscope.operation.request.NodeNavigationRequest

NoopResultRanker - Class in info.magnolia.periscope.rank

Neutral result ranker which will behave like a no-op.

NoopResultRanker() - Constructor for class info.magnolia.periscope.rank.NoopResultRanker

NoopResultRankerFactory - Class in info.magnolia.periscope.rank

Always returns a NoopResultRanker instance.

NoopResultRankerFactory() - Constructor for class info.magnolia.periscope.rank.NoopResultRankerFactory

O

onModificationEvent() - Method in interface info.magnolia.periscope.sniff.QuerySnifferDefinitionRegistry.Listener

OperationDefinition - Class in info.magnolia.periscope.operation

Definition mapping an operation request to an actual Operation.

OperationDefinition() - Constructor for class info.magnolia.periscope.operation.OperationDefinition

OperationDefinitionRegistry - Class in info.magnolia.periscope.operation

Registry for definitions mapping operation requests to Operations.

OperationDefinitionRegistry(ModuleRegistry) - Constructor for class info.magnolia.periscope.operation.OperationDefinitionRegistry

OperationRequestProcessor - Class in info.magnolia.periscope.operation.request

Processor executing Operations corresponding to requests, based on whatever is configured in the OperationDefinitionRegistry.

OperationRequestProcessor(OperationDefinitionRegistry) - Constructor for class info.magnolia.periscope.operation.request.OperationRequestProcessor

P

PatternCommandSniffer - Class in info.magnolia.periscope.sniff

Abstract sniff matching a given pattern and potentially delegating the actual execution.

PatternCommandSniffer() - Constructor for class info.magnolia.periscope.sniff.PatternCommandSniffer

Periscope - Class in info.magnolia.periscope

Main entry point of Periscope which encapsulates logic such as ResultRanker or QuerySnifferProcessor interactions as well as being responsible to fetch results via Search result suppliers.

Periscope.ResultsPromise - Class in info.magnolia.periscope

Wrapper for a list of search results, including information about the corresponding supplier.

PeriscopeModule - Class in info.magnolia.periscope

ModuleLifecycle implementation for Periscope.

PeriscopeModule(ConfigurationSourceFactory, SearchResultSupplierDefinitionRegistry, QuerySnifferDefinitionRegistry, OperationDefinitionRegistry, Periscope) - Constructor for class info.magnolia.periscope.PeriscopeModule

Q

QuerySnifferDefinitionRegistry - Class in info.magnolia.periscope.sniff

A registry for Periscope operation definition.

QuerySnifferDefinitionRegistry(ModuleRegistry) - Constructor for class info.magnolia.periscope.sniff.QuerySnifferDefinitionRegistry

QuerySnifferDefinitionRegistry.Listener - Interface in info.magnolia.periscope.sniff

Listener for registry.

QuerySnifferProcessor - Class in info.magnolia.periscope.sniff

Responsible for processing QuerySniffers.

QuerySnifferProcessor(QuerySnifferDefinitionRegistry) - Constructor for class info.magnolia.periscope.sniff.QuerySnifferProcessor

R

rank(String, Collection<SearchResult>) - Method in class info.magnolia.periscope.rank.NoopResultRanker

rank(String, Collection<SearchResult>) - Method in interface info.magnolia.periscope.rank.ResultRanker

register(DefinitionProvider<QuerySnifferDefinition>) - Method in class info.magnolia.periscope.sniff.QuerySnifferDefinitionRegistry

RestSearchResultSupplier - Class in info.magnolia.periscope.search.rest

A REST based Search result supplier which is responsible make the REST call itself.

RestSearchResultSupplierDefinition - Class in info.magnolia.periscope.search.rest

A Search result supplier definition for REST based results.

RestSearchResultSupplierDefinition() - Constructor for class info.magnolia.periscope.search.rest.RestSearchResultSupplierDefinition

RestSearchResultSupplierStrategy - Class in info.magnolia.periscope.search.rest

Knows how to construct a Rest based Search result supplier from RestSearchResultSupplierDefinition.

RestSearchResultSupplierStrategy() - Constructor for class info.magnolia.periscope.search.rest.RestSearchResultSupplierStrategy

resultPicked(SearchQuery, SupplierAwareSearchResult) - Method in class info.magnolia.periscope.Periscope

ResultRanker - Interface in info.magnolia.periscope.rank

Neural Network to rank given Results.

ResultRankerFactory - Interface in info.magnolia.periscope.rank

Factory for ResultRanker objects.

ResultsPromise() - Constructor for class info.magnolia.periscope.Periscope.ResultsPromise

S

search(SearchQuery, Collection<SearchResultSupplier>) - Method in class info.magnolia.periscope.Periscope

search(SearchQuery) - Method in class info.magnolia.periscope.search.jcr.JcrSearchResultSupplier

search(SearchQuery) - Method in class info.magnolia.periscope.search.rest.RestSearchResultSupplier

SearchResultSupplierDefinition - Interface in info.magnolia.periscope.search

Definitions for Search result suppliers.

SearchResultSupplierDefinitionRegistry - Class in info.magnolia.periscope.search

Registry for Periscope result suppliers.

SearchResultSupplierStrategy<S extends info.magnolia.periscope.search.SearchResultSupplier,D extends SearchResultSupplierDefinition> - Interface in info.magnolia.periscope.search

Knows how to construct SearchResult supplier.

SearchRunBatch - Class in info.magnolia.periscope.search

Representation of a search run execution.

SearchRunBatch(List<Periscope.ResultsPromise>) - Constructor for class info.magnolia.periscope.search.SearchRunBatch

SearchRunner - Class in info.magnolia.periscope.search

Runner for searches, managing proper locking to avoid accessing the same JCR workspace from different threads at the same time.

SearchRunner(int) - Constructor for class info.magnolia.periscope.search.SearchRunner

setEnabled(boolean) - Method in class info.magnolia.periscope.search.AbstractSearchResultSupplierDefinition

setResultLimit(int) - Method in class info.magnolia.periscope.search.AbstractSearchResultSupplierDefinition

shutdown() - Method in class info.magnolia.periscope.search.SearchRunner

Shuts down the executor service which is used for async operation execution.

sniff(String) - Method in class info.magnolia.periscope.sniff.PatternCommandSniffer

sniffQuery(String) - Method in class info.magnolia.periscope.Periscope

start(ModuleLifecycleContext) - Method in class info.magnolia.periscope.PeriscopeModule

stop(ModuleLifecycleContext) - Method in class info.magnolia.periscope.PeriscopeModule

SupplierAwareSearchResult - Class in info.magnolia.periscope

A Search result which is aware of its SearchResultSupplier.

T

trainRanking(String, SearchResult) - Method in class info.magnolia.periscope.rank.NoopResultRanker

trainRanking(String, SearchResult) - Method in interface info.magnolia.periscope.rank.ResultRanker

type() - Method in class info.magnolia.periscope.operation.OperationDefinitionRegistry

TYPE - Static variable in class info.magnolia.periscope.search.SearchResultSupplierDefinitionRegistry

type() - Method in class info.magnolia.periscope.search.SearchResultSupplierDefinitionRegistry

type() - Method in class info.magnolia.periscope.sniff.QuerySnifferDefinitionRegistry

U

unregisterAndRegister(Collection<DefinitionMetadata>, Collection<DefinitionProvider<QuerySnifferDefinition>>) - Method in class info.magnolia.periscope.sniff.QuerySnifferDefinitionRegistry

A C D E G I J N O P Q R S T U