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

Class DefaultSolrConfiguration

java.lang.Object

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

All Implemented Interfaces:

OakSolrConfiguration

public class DefaultSolrConfiguration
extends Object
implements OakSolrConfiguration

Default OakSolrConfiguration

Constructor Summary

Constructors

Constructor and Description
DefaultSolrConfiguration()

Method Summary

Methods

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.
String	getCatchAllField() Provide a field name that is used as the default "catch all" field for searching over all the data
String	getCollapsedPathField() Provide the name of the field to be used for indexing the collapsed path of each node when OakSolrConfiguration.collapseJcrContentNodes() is set to true.
CommitPolicy	getCommitPolicy() Provide the commit policy to be used with the underlying Solr instance
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 collection of 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
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
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

DefaultSolrConfiguration

public DefaultSolrConfiguration()

Method Detail

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:

a String representing the Solr field to be used for the given Type.

getPathField

public String getPathField()

Description copied from interface: OakSolrConfiguration

Provide the field name for indexing / searching paths

Specified by:

getPathField in interface OakSolrConfiguration

Returns:

a String representing the Solr field to be used for paths.

getFieldForPathRestriction

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

Returns:

the field name as a String to be used by Solr for the given restriction

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 field name as a String to be used by Solr for the given restriction

getCommitPolicy

public CommitPolicy getCommitPolicy()

Description copied from interface: OakSolrConfiguration

Provide the commit policy to be used with the underlying Solr instance

Specified by:

getCommitPolicy in interface OakSolrConfiguration

Returns:

a CommitPolicy

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:

a String representing the Solr field to be used as "catch all" field

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:

an int for the setting of Solr rows parameter

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

public Collection<String> getIgnoredProperties()

Description copied from interface: OakSolrConfiguration

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

Specified by:

getIgnoredProperties in interface OakSolrConfiguration

Returns:

a Collection of names of 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

collapseJcrContentNodes

public boolean collapseJcrContentNodes()

Description copied from interface: OakSolrConfiguration

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.

Specified by:

collapseJcrContentNodes in interface OakSolrConfiguration

Returns:

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

getCollapsedPathField

@Nonnull
public String getCollapsedPathField()

Description copied from interface: OakSolrConfiguration

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

Specified by:

getCollapsedPathField in interface OakSolrConfiguration

Returns:

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

getPathDepthField

@Nonnull
public String getPathDepthField()

Description copied from interface: OakSolrConfiguration

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

Specified by:

getPathDepthField in interface OakSolrConfiguration

Returns:

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