Package org.apache.solr.highlight

Class SolrFragmentsBuilder

java.lang.Object

org.apache.solr.highlight.HighlightingPluginBase

org.apache.solr.highlight.SolrFragmentsBuilder

All Implemented Interfaces:

AutoCloseable, SolrInfoBean, SolrMetricProducer, NamedListInitializedPlugin

Direct Known Subclasses:

ScoreOrderFragmentsBuilder, SimpleFragmentsBuilder

public abstract class SolrFragmentsBuilder
extends HighlightingPluginBase
implements SolrInfoBean, NamedListInitializedPlugin

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_POST_TAGS
static String	DEFAULT_PRE_TAGS

Fields inherited from class org.apache.solr.highlight.HighlightingPluginBase

defaults, metricNames, numRequests, solrMetricsContext

Constructor Summary

Constructors

Constructor	Description
SolrFragmentsBuilder()

Method Summary

Modifier and Type	Method	Description
protected abstract org.apache.lucene.search.vectorhighlight.FragmentsBuilder	getFragmentsBuilder(SolrParams params, String[] preTags, String[] postTags, org.apache.lucene.search.vectorhighlight.BoundaryScanner bs)
org.apache.lucene.search.vectorhighlight.FragmentsBuilder	getFragmentsBuilder(SolrParams params, org.apache.lucene.search.vectorhighlight.BoundaryScanner bs)	Return a FragmentsBuilder appropriate for this field.
protected char	getMultiValuedSeparatorChar(SolrParams params)
String[]	getPostTags(SolrParams params, String fieldName)
String[]	getPreTags(SolrParams params, String fieldName)

Methods inherited from class org.apache.solr.highlight.HighlightingPluginBase

getCategory, getDescription, getName, getSolrMetricsContext, init, initializeMetrics

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.util.plugin.NamedListInitializedPlugin

init

Methods inherited from interface org.apache.solr.core.SolrInfoBean

getCategory, getDescription, getName

Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer

close, getSolrMetricsContext, initializeMetrics

Field Detail

DEFAULT_PRE_TAGS

public static final String DEFAULT_PRE_TAGS

See Also:

Constant Field Values

DEFAULT_POST_TAGS

public static final String DEFAULT_POST_TAGS

See Also:

Constant Field Values

Constructor Detail

SolrFragmentsBuilder

public SolrFragmentsBuilder()

Method Detail

getFragmentsBuilder

public org.apache.lucene.search.vectorhighlight.FragmentsBuilder getFragmentsBuilder(SolrParams params,
                                                                                     org.apache.lucene.search.vectorhighlight.BoundaryScanner bs)

Return a FragmentsBuilder appropriate for this field.

Parameters:

params - The params controlling Highlighting

Returns:

An appropriate FragmentsBuilder.

getPreTags

public String[] getPreTags(SolrParams params,
                           String fieldName)

getPostTags

public String[] getPostTags(SolrParams params,
                            String fieldName)

getFragmentsBuilder

protected abstract org.apache.lucene.search.vectorhighlight.FragmentsBuilder getFragmentsBuilder(SolrParams params,
                                                                                                 String[] preTags,
                                                                                                 String[] postTags,
                                                                                                 org.apache.lucene.search.vectorhighlight.BoundaryScanner bs)

getMultiValuedSeparatorChar

protected char getMultiValuedSeparatorChar(SolrParams params)