org.carrot2.source.solr

Class SolrDocumentSourceDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.source.SearchEngineBaseDescriptor.AttributeBuilder

org.carrot2.source.SimpleSearchEngineDescriptor.AttributeBuilder

org.carrot2.source.xml.RemoteXmlSimpleSearchEngineBaseDescriptor.AttributeBuilder

org.carrot2.source.solr.SolrDocumentSourceDescriptor.AttributeBuilder

Enclosing class:

SolrDocumentSourceDescriptor

public static class SolrDocumentSourceDescriptor.AttributeBuilder
extends RemoteXmlSimpleSearchEngineBaseDescriptor.AttributeBuilder

Attribute map builder for the SolrDocumentSource component. You can use this builder as a type-safe alternative to populating the attribute map using attribute keys.

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Object>	map The attribute map populated by this builder.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AttributeBuilder(Map<String,Object> map) Creates a builder backed by the provided map.

Method Summary

Modifier and Type	Method and Description
List<Cluster>	clusters() If SolrDocumentSource.readClusters is true and clusters are present in the input XML, they will be deserialized and exposed to components further down the processing chain.
SolrDocumentSourceDescriptor.AttributeBuilder	clusters(org.carrot2.util.attribute.IObjectFactory<? extends List<Cluster>> value) If SolrDocumentSource.readClusters is true and clusters are present in the input XML, they will be deserialized and exposed to components further down the processing chain.
SolrDocumentSourceDescriptor.AttributeBuilder	clusters(List<Cluster> value) If SolrDocumentSource.readClusters is true and clusters are present in the input XML, they will be deserialized and exposed to components further down the processing chain.
SolrDocumentSourceDescriptor.AttributeBuilder	copyFields(boolean value) Copy Solr fields from the search result to Carrot2 Document instances (as fields).
SolrDocumentSourceDescriptor.AttributeBuilder	copyFields(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value) Copy Solr fields from the search result to Carrot2 Document instances (as fields).
SolrDocumentSourceDescriptor.AttributeBuilder	readClusters(boolean value) If clusters are present in the Solr output they will be read and exposed to components further down the processing chain.
SolrDocumentSourceDescriptor.AttributeBuilder	readClusters(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value) If clusters are present in the Solr output they will be read and exposed to components further down the processing chain.
SolrDocumentSourceDescriptor.AttributeBuilder	serviceUrlBase(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Solr service URL base.
SolrDocumentSourceDescriptor.AttributeBuilder	serviceUrlBase(String value) Solr service URL base.
SolrDocumentSourceDescriptor.AttributeBuilder	solrFilterQuery(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Filter query appended to SolrDocumentSource.serviceUrlBase.
SolrDocumentSourceDescriptor.AttributeBuilder	solrFilterQuery(String value) Filter query appended to SolrDocumentSource.serviceUrlBase.
SolrDocumentSourceDescriptor.AttributeBuilder	solrIdFieldName(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Document identifier field name (specified in Solr schema).
SolrDocumentSourceDescriptor.AttributeBuilder	solrIdFieldName(String value) Document identifier field name (specified in Solr schema).
SolrDocumentSourceDescriptor.AttributeBuilder	solrSummaryFieldName(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Summary field name.
SolrDocumentSourceDescriptor.AttributeBuilder	solrSummaryFieldName(String value) Summary field name.
SolrDocumentSourceDescriptor.AttributeBuilder	solrTitleFieldName(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Title field name.
SolrDocumentSourceDescriptor.AttributeBuilder	solrTitleFieldName(String value) Title field name.
SolrDocumentSourceDescriptor.AttributeBuilder	solrUrlFieldName(org.carrot2.util.attribute.IObjectFactory<? extends String> value) URL field name.
SolrDocumentSourceDescriptor.AttributeBuilder	solrUrlFieldName(String value) URL field name.
SolrDocumentSourceDescriptor.AttributeBuilder	solrXsltAdapter(Class<?> clazz) Provides a custom XSLT stylesheet for converting from Solr's output to an XML format parsed by Carrot2.
SolrDocumentSourceDescriptor.AttributeBuilder	solrXsltAdapter(org.carrot2.util.attribute.IObjectFactory<? extends IResource> value) Provides a custom XSLT stylesheet for converting from Solr's output to an XML format parsed by Carrot2.
SolrDocumentSourceDescriptor.AttributeBuilder	solrXsltAdapter(IResource value) Provides a custom XSLT stylesheet for converting from Solr's output to an XML format parsed by Carrot2.
SolrDocumentSourceDescriptor.AttributeBuilder	useHighlighterOutput(boolean value) If highlighter fragments are present in the Solr output they will be used (and preferred) over full field content.
SolrDocumentSourceDescriptor.AttributeBuilder	useHighlighterOutput(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value) If highlighter fragments are present in the Solr output they will be used (and preferred) over full field content.

Methods inherited from class org.carrot2.source.xml.RemoteXmlSimpleSearchEngineBaseDescriptor.AttributeBuilder

redirectStrategy, redirectStrategy, xmlDocumentSourceHelper

Methods inherited from class org.carrot2.source.SearchEngineBaseDescriptor.AttributeBuilder

compressed, documents, query, query, results, results, resultsTotal, start, start

Methods inherited from class java.lang.Object

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

Field Detail

map

public final Map<String,Object> map

The attribute map populated by this builder.

Constructor Detail

AttributeBuilder

protected AttributeBuilder(Map<String,Object> map)

Creates a builder backed by the provided map.

Method Detail

serviceUrlBase

public SolrDocumentSourceDescriptor.AttributeBuilder serviceUrlBase(String value)

Solr service URL base. The URL base can contain additional Solr parameters, for example: http://localhost:8983/solr/select?fq=timestemp:[NOW-24HOUR TO NOW]

See Also:

SolrDocumentSource.serviceUrlBase

serviceUrlBase

public SolrDocumentSourceDescriptor.AttributeBuilder serviceUrlBase(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

Solr service URL base. The URL base can contain additional Solr parameters, for example: http://localhost:8983/solr/select?fq=timestemp:[NOW-24HOUR TO NOW]

See Also:

SolrDocumentSource.serviceUrlBase

solrFilterQuery

public SolrDocumentSourceDescriptor.AttributeBuilder solrFilterQuery(String value)

Filter query appended to SolrDocumentSource.serviceUrlBase.

See Also:

SolrDocumentSource.solrFilterQuery

solrFilterQuery

public SolrDocumentSourceDescriptor.AttributeBuilder solrFilterQuery(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

Filter query appended to SolrDocumentSource.serviceUrlBase.

See Also:

SolrDocumentSource.solrFilterQuery

solrTitleFieldName

public SolrDocumentSourceDescriptor.AttributeBuilder solrTitleFieldName(String value)

Title field name. Name of the Solr field that will provide document titles.

See Also:

SolrDocumentSource.solrTitleFieldName

solrTitleFieldName

public SolrDocumentSourceDescriptor.AttributeBuilder solrTitleFieldName(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

Title field name. Name of the Solr field that will provide document titles.

See Also:

SolrDocumentSource.solrTitleFieldName

solrSummaryFieldName

public SolrDocumentSourceDescriptor.AttributeBuilder solrSummaryFieldName(String value)

Summary field name. Name of the Solr field that will provide document summary.

See Also:

SolrDocumentSource.solrSummaryFieldName

solrSummaryFieldName

public SolrDocumentSourceDescriptor.AttributeBuilder solrSummaryFieldName(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

Summary field name. Name of the Solr field that will provide document summary.

See Also:

SolrDocumentSource.solrSummaryFieldName

solrUrlFieldName

public SolrDocumentSourceDescriptor.AttributeBuilder solrUrlFieldName(String value)

URL field name. Name of the Solr field that will provide document URLs.

See Also:

SolrDocumentSource.solrUrlFieldName

solrUrlFieldName

public SolrDocumentSourceDescriptor.AttributeBuilder solrUrlFieldName(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

URL field name. Name of the Solr field that will provide document URLs.

See Also:

SolrDocumentSource.solrUrlFieldName

solrIdFieldName

public SolrDocumentSourceDescriptor.AttributeBuilder solrIdFieldName(String value)

Document identifier field name (specified in Solr schema). This field is necessary to connect Solr-side clusters or highlighter output to documents.

See Also:

SolrDocumentSource.solrIdFieldName

solrIdFieldName

public SolrDocumentSourceDescriptor.AttributeBuilder solrIdFieldName(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

Document identifier field name (specified in Solr schema). This field is necessary to connect Solr-side clusters or highlighter output to documents.

See Also:

SolrDocumentSource.solrIdFieldName

solrXsltAdapter

public SolrDocumentSourceDescriptor.AttributeBuilder solrXsltAdapter(IResource value)

Provides a custom XSLT stylesheet for converting from Solr's output to an XML format parsed by Carrot2. For performance reasons this attribute can be provided at initialization time only (no processing-time overrides).

See Also:

SolrDocumentSource.solrXsltAdapter

solrXsltAdapter

public SolrDocumentSourceDescriptor.AttributeBuilder solrXsltAdapter(Class<?> clazz)

Provides a custom XSLT stylesheet for converting from Solr's output to an XML format parsed by Carrot2. For performance reasons this attribute can be provided at initialization time only (no processing-time overrides). A class that extends org.carrot2.util.resource.IResource or appropriate IObjectFactory.

See Also:

SolrDocumentSource.solrXsltAdapter

solrXsltAdapter

public SolrDocumentSourceDescriptor.AttributeBuilder solrXsltAdapter(org.carrot2.util.attribute.IObjectFactory<? extends IResource> value)

Provides a custom XSLT stylesheet for converting from Solr's output to an XML format parsed by Carrot2. For performance reasons this attribute can be provided at initialization time only (no processing-time overrides).

See Also:

SolrDocumentSource.solrXsltAdapter

readClusters

public SolrDocumentSourceDescriptor.AttributeBuilder readClusters(boolean value)

If clusters are present in the Solr output they will be read and exposed to components further down the processing chain. Note that SolrDocumentSource.solrIdFieldName is required to match document references.

See Also:

SolrDocumentSource.readClusters

readClusters

public SolrDocumentSourceDescriptor.AttributeBuilder readClusters(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value)

If clusters are present in the Solr output they will be read and exposed to components further down the processing chain. Note that SolrDocumentSource.solrIdFieldName is required to match document references.

See Also:

SolrDocumentSource.readClusters

useHighlighterOutput

public SolrDocumentSourceDescriptor.AttributeBuilder useHighlighterOutput(boolean value)

If highlighter fragments are present in the Solr output they will be used (and preferred) over full field content. This may be used to decrease the memory required for clustering. In general if highlighter is used the contents of full fields won't be emitted from Solr though (because it makes little sense).

Setting this option to false will disable using the highlighter output entirely.

See Also:

SolrDocumentSource.useHighlighterOutput

useHighlighterOutput

public SolrDocumentSourceDescriptor.AttributeBuilder useHighlighterOutput(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value)

If highlighter fragments are present in the Solr output they will be used (and preferred) over full field content. This may be used to decrease the memory required for clustering. In general if highlighter is used the contents of full fields won't be emitted from Solr though (because it makes little sense).

Setting this option to false will disable using the highlighter output entirely.

See Also:

SolrDocumentSource.useHighlighterOutput

copyFields

public SolrDocumentSourceDescriptor.AttributeBuilder copyFields(boolean value)

Copy Solr fields from the search result to Carrot2 Document instances (as fields).

See Also:

SolrDocumentSource.copyFields

copyFields

public SolrDocumentSourceDescriptor.AttributeBuilder copyFields(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value)

Copy Solr fields from the search result to Carrot2 Document instances (as fields).

See Also:

SolrDocumentSource.copyFields

clusters

public SolrDocumentSourceDescriptor.AttributeBuilder clusters(List<Cluster> value)

If SolrDocumentSource.readClusters is true and clusters are present in the input XML, they will be deserialized and exposed to components further down the processing chain.

See Also:

SolrDocumentSource.clusters

clusters

public SolrDocumentSourceDescriptor.AttributeBuilder clusters(org.carrot2.util.attribute.IObjectFactory<? extends List<Cluster>> value)

If SolrDocumentSource.readClusters is true and clusters are present in the input XML, they will be deserialized and exposed to components further down the processing chain.

See Also:

SolrDocumentSource.clusters

clusters

public List<Cluster> clusters()

If SolrDocumentSource.readClusters is true and clusters are present in the input XML, they will be deserialized and exposed to components further down the processing chain.

See Also:

SolrDocumentSource.clusters