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

Class OakSolrNodeStateConfiguration

java.lang.Object

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

All Implemented Interfaces:

OakSolrConfiguration, SolrServerConfigurationProvider<EmbeddedSolrServerProvider>

Direct Known Subclasses:

FixedNodeStateConfiguration, UpToDateNodeStateConfiguration

public abstract class OakSolrNodeStateConfiguration
extends Object
implements OakSolrConfiguration, SolrServerConfigurationProvider<EmbeddedSolrServerProvider>

An OakSolrConfiguration specified via a given NodeState. For each of the supported properties a default is provided if either the property doesn't exist in the node or if the value is null or empty String.

Subclasses of this should at least provide the NodeState which holds the configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OakSolrNodeStateConfiguration.Properties Properties that may be retrieved from the configuration NodeState.

Constructor Summary

Constructors

Constructor and Description
OakSolrNodeStateConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
String	getCatchAllField() Provide a field name that is used as the default "catch all" field for searching over all the data
CommitPolicy	getCommitPolicy() Provide the commit policy to be used by a given SolrServer
protected abstract org.apache.jackrabbit.oak.spi.state.NodeState	getConfigurationNodeState() get the NodeState which contains the properties for the Oak - Solr configuration.
String	getFieldForPathRestriction(org.apache.jackrabbit.oak.spi.query.Filter.PathRestriction pathRestriction) Provide a field name to search over for the given Filter.PathRestriction
String	getFieldForPropertyRestriction(org.apache.jackrabbit.oak.spi.query.Filter.PropertyRestriction propertyRestriction) Provide a field name to search over for the given Filter.PropertyRestriction
String	getFieldNameFor(org.apache.jackrabbit.oak.api.Type<?> propertyType) Provide a field name to be used for indexing / searching a certain Type
Collection<String>	getIgnoredProperties() Provide the names of the properties that should be neither indexed nor searched by the Solr index
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
SolrServerConfiguration<EmbeddedSolrServerProvider>	getSolrServerConfiguration() Provide a SolrServerConfiguration to be used to initialize a specific SolrServer implementation.
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OakSolrNodeStateConfiguration

public OakSolrNodeStateConfiguration()

Method Detail

getConfigurationNodeState

protected abstract org.apache.jackrabbit.oak.spi.state.NodeState getConfigurationNodeState()

get the NodeState which contains the properties for the Oak - Solr configuration.

Returns:

a (possibly non-existent) node state for the Solr configuration

getFieldNameFor

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

Description copied from interface: OakSolrConfiguration

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

Specified by:

getFieldNameFor in interface OakSolrConfiguration

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

@Nonnull
public String getPathField()

Description copied from interface: OakSolrConfiguration

Provide the field name for indexing / searching paths

Specified by:

getPathField in interface OakSolrConfiguration

Returns:

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

getFieldForPathRestriction

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

Description copied from interface: OakSolrConfiguration

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

Specified by:

getFieldForPathRestriction in interface OakSolrConfiguration

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.

getCatchAllField

public String getCatchAllField()

Description copied from interface: OakSolrConfiguration

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

Specified by:

getCatchAllField in interface OakSolrConfiguration

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.

getFieldForPropertyRestriction

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

Description copied from interface: OakSolrConfiguration

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

Specified by:

getFieldForPropertyRestriction in interface OakSolrConfiguration

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

@Nonnull
public CommitPolicy getCommitPolicy()

Description copied from interface: OakSolrConfiguration

Provide the commit policy to be used by a given SolrServer

Specified by:

getCommitPolicy in interface OakSolrConfiguration

Returns:

a CommitPolicy

getRows

public int getRows()

Description copied from interface: OakSolrConfiguration

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

Specified by:

getRows in interface OakSolrConfiguration

Returns:

the number of rows to fetch

useForPropertyRestrictions

public boolean useForPropertyRestrictions()

Description copied from interface: OakSolrConfiguration

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

Specified by:

useForPropertyRestrictions in interface OakSolrConfiguration

Returns:

true if SolrQueryIndex should be used for Filter.PropertyRestrictions

useForPrimaryTypes

public boolean useForPrimaryTypes()

Description copied from interface: OakSolrConfiguration

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

Specified by:

useForPrimaryTypes in interface OakSolrConfiguration

Returns:

true if SolrQueryIndex should be used for filtering by primary types

useForPathRestrictions

public boolean useForPathRestrictions()

Description copied from interface: OakSolrConfiguration

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

Specified by:

useForPathRestrictions in interface OakSolrConfiguration

Returns:

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

getIgnoredProperties

@Nonnull
public Collection<String> getIgnoredProperties()

Description copied from interface: OakSolrConfiguration

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

Specified by:

getIgnoredProperties in interface OakSolrConfiguration

Returns:

a Collection of property names for properties to be ignored

getUsedProperties

@Nonnull
public Collection<String> getUsedProperties()

Description copied from interface: OakSolrConfiguration

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

Specified by:

getUsedProperties in interface OakSolrConfiguration

Returns:

a Collection of property names for properties to be ignored

getSolrServerConfiguration

@Nonnull
public SolrServerConfiguration<EmbeddedSolrServerProvider> getSolrServerConfiguration()

Description copied from interface: SolrServerConfigurationProvider

Provide a SolrServerConfiguration to be used to initialize a specific SolrServer implementation.

Specified by:

getSolrServerConfiguration in interface SolrServerConfigurationProvider<EmbeddedSolrServerProvider>

Returns:

the SolrServerConfiguration holding the configuration parameters