org.apache.jackrabbit.oak.plugins.index.solr.configuration

Interface OakSolrConfiguration

All Known Implementing Classes:

DefaultSolrConfiguration, OakSolrNodeStateConfiguration

public interface OakSolrConfiguration

A Solr configuration holding all the possible customizable parameters that can be leveraged for an Oak search index.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OakSolrConfiguration.CommitPolicy Enum for describing Solr commit policy used in a certain instance

Method Summary

Modifier and Type	Method and Description
boolean	collapseJcrContentNodes() Make all nodes / documents matching a query that are descendants of a 'jcr:content' node collapse into such a node.
@Nullable String	getCatchAllField() Provide a field name that is used as the default "catch all" field for searching over all the data
@NotNull String	getCollapsedPathField() Provide the name of the field to be used for indexing the collapsed path of each node when collapseJcrContentNodes() is set to true.
@NotNull OakSolrConfiguration.CommitPolicy	getCommitPolicy() Provide the commit policy to be used by a given SolrServer
@Nullable String	getFieldForPathRestriction(org.apache.jackrabbit.oak.spi.query.Filter.PathRestriction pathRestriction) Provide a field name to search over for the given Filter.PathRestriction
@Nullable String	getFieldForPropertyRestriction(org.apache.jackrabbit.oak.spi.query.Filter.PropertyRestriction propertyRestriction) Provide a field name to search over for the given Filter.PropertyRestriction
@Nullable String	getFieldNameFor(org.apache.jackrabbit.oak.api.Type<?> propertyType) Provide a field name to be used for indexing / searching a certain Type
@NotNull Collection<String>	getIgnoredProperties() Provide the names of the properties that should be neither indexed nor searched by the Solr index
String	getPathDepthField() Provide the name of the field containing information about the depth of a certain path / node
@NotNull String	getPathField() Provide the field name for indexing / searching paths
int	getRows() Provide the number of documents (rows) to be fetched for each Solr query
@NotNull Collection<String>	getUsedProperties() Provide the names of the properties that should be indexed and searched by the Solr index
boolean	useForPathRestrictions() Define if the Solr index should be used to filter by path restrictions
boolean	useForPrimaryTypes() Define if the Solr index should be used to filter by primary types
boolean	useForPropertyRestrictions() Define if the Solr index should be used to address property restrictions

Method Detail

getFieldNameFor

@Nullable
@Nullable String getFieldNameFor(org.apache.jackrabbit.oak.api.Type<?> propertyType)

Provide a field name to be used for indexing / searching a certain Type

Parameters:

propertyType - the Type to be indexed / searched

Returns:

the name of the Solr field to be used for the given Type, or null if no specific field has been configured to handle the given Type.

getPathField

@NotNull
@NotNull String getPathField()

Provide the field name for indexing / searching paths

Returns:

the name of the Solr field to be used for indexing and searching on paths (exact matching).

getFieldForPathRestriction

@Nullable
@Nullable String getFieldForPathRestriction(org.apache.jackrabbit.oak.spi.query.Filter.PathRestriction pathRestriction)

Provide a field name to search over for the given Filter.PathRestriction

Parameters:

pathRestriction - the Filter.PathRestriction used for filtering search results or null if no specific field has been configured for it.

Returns:

the name of the Solr field to be used for the given PathRestriction.

getFieldForPropertyRestriction

@Nullable
@Nullable String getFieldForPropertyRestriction(org.apache.jackrabbit.oak.spi.query.Filter.PropertyRestriction propertyRestriction)

Provide a field name to search over for the given Filter.PropertyRestriction

Parameters:

propertyRestriction - the Filter.PropertyRestriction used for filtering search results

Returns:

the name of the Solr field to be used for the given PropertyRestriction or null if no specific field has been configured for it.

getCommitPolicy

@NotNull
@NotNull OakSolrConfiguration.CommitPolicy getCommitPolicy()

Provide the commit policy to be used by a given SolrServer

Returns:

a OakSolrConfiguration.CommitPolicy

getCatchAllField

@Nullable
@Nullable String getCatchAllField()

Provide a field name that is used as the default "catch all" field for searching over all the data

Returns:

the name of the Solr field to be used as "catch all" field, or null if no specific field has been configured for it.

getRows

int getRows()

Provide the number of documents (rows) to be fetched for each Solr query

Returns:

the number of rows to fetch

useForPropertyRestrictions

boolean useForPropertyRestrictions()

Define if the Solr index should be used to address property restrictions

Returns:

true if SolrQueryIndex should be used for Filter.PropertyRestrictions

useForPrimaryTypes

boolean useForPrimaryTypes()

Define if the Solr index should be used to filter by primary types

Returns:

true if SolrQueryIndex should be used for filtering by primary types

useForPathRestrictions

boolean useForPathRestrictions()

Define if the Solr index should be used to filter by path restrictions

Returns:

true if SolrQueryIndex should be used for filtering by Filter.PathRestrictions

getIgnoredProperties

@NotNull
@NotNull Collection<String> getIgnoredProperties()

Provide the names of the properties that should be neither indexed nor searched by the Solr index

Returns:

a Collection of property names for properties to be ignored

getUsedProperties

@NotNull
@NotNull Collection<String> getUsedProperties()

Provide the names of the properties that should be indexed and searched by the Solr index

Returns:

a Collection of property names for properties to be ignored

collapseJcrContentNodes

boolean collapseJcrContentNodes()

Make all nodes / documents matching a query that are descendants of a 'jcr:content' node collapse into such a node. That will result in resultsets being tipically much more compact in cases where most / all of the matching nodes match such a hierarchy.

Returns:

true if only the 'jcr:content' node should be returned for all its the matching descendants, false otherwise

getCollapsedPathField

@NotNull
@NotNull String getCollapsedPathField()

Provide the name of the field to be used for indexing the collapsed path of each node when collapseJcrContentNodes() is set to true.

Returns:

the name of the Solr field to be used for indexing and searching on collapsed paths.

getPathDepthField

String getPathDepthField()

Provide the name of the field containing information about the depth of a certain path / node

Returns:

the name of the Solr field to be used for indexing and searching on path depth.