Package org.apache.solr.handler.component

Class AlfrescoSolrHighlighter

  • All Implemented Interfaces:
    org.apache.solr.util.plugin.PluginInfoInitialized
    public class AlfrescoSolrHighlighter
extends org.apache.solr.highlight.DefaultSolrHighlighter
implements org.apache.solr.util.plugin.PluginInfoInitialized
    Author:
    Andy

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.solr.highlight.DefaultSolrHighlighter

        org.apache.solr.highlight.DefaultSolrHighlighter.FvhContainer

    • Field Summary

      • Fields inherited from class org.apache.solr.highlight.DefaultSolrHighlighter

        boundaryScanners, encoders, formatters, fragListBuilders, fragmenters, fragmentsBuilders, solrCore

      • Fields inherited from class org.apache.solr.highlight.SolrHighlighter

        DEFAULT_MAX_CHARS, DEFAULT_PHRASE_LIMIT

    • Constructor Summary

      Constructors 
      Constructor Description
      AlfrescoSolrHighlighter​(org.apache.solr.core.SolrCore solrCore)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected Object alternateField​(org.apache.lucene.document.Document doc, String fieldName, org.apache.solr.request.SolrQueryRequest req)
      Returns the alternate highlight object for this field -- a String[] by default.
      org.apache.solr.common.util.NamedList<Object> doHighlighting​(org.apache.solr.search.DocList docs, org.apache.lucene.search.Query query, org.apache.solr.request.SolrQueryRequest req, String[] defaultFields)
      Generates a list of Highlighted query fragments for each item in a list of documents, or returns null if highlighting is disabled.
      protected Object doHighlightingByHighlighter​(org.apache.lucene.document.Document doc, int docId, org.apache.solr.schema.SchemaField schemaField, org.apache.lucene.search.Query query, org.apache.lucene.index.IndexReader reader, org.apache.solr.request.SolrQueryRequest req)
      Highlights and returns the highlight object for this field -- a String[] by default.
      protected org.apache.lucene.search.highlight.Highlighter getHighlighter​(org.apache.lucene.search.Query query, String requestFieldname, org.apache.solr.request.SolrQueryRequest request)
      Return a Highlighter appropriate for this field.
      protected org.apache.lucene.search.highlight.Scorer getQueryScorer​(org.apache.lucene.search.Query query, String requestFieldname, org.apache.solr.request.SolrQueryRequest request)
      Return a Scorer suitable for this Query and field.
      protected org.apache.lucene.search.highlight.QueryScorer getSpanQueryScorer​(org.apache.lucene.search.Query query, String requestFieldname, org.apache.lucene.analysis.TokenStream tokenStream, org.apache.solr.request.SolrQueryRequest request)
      Return a QueryScorer suitable for this Query and field.

      • Methods inherited from class org.apache.solr.highlight.DefaultSolrHighlighter

        alternateField, createAnalyzerTStream, doHighlightingByFastVectorHighlighter, doHighlightingOfField, getBoundaryScanner, getDocPrefetchFieldNames, getEncoder, getFieldValues, getFormatter, getFragListBuilder, getFragmenter, getFragmentsBuilder, getMaxSnippets, getPhraseHighlighter, getResponseForFragments, getSolrFragmentsBuilder, init, isMergeContiguousFragments, useFastVectorHighlighter

      • Methods inherited from class org.apache.solr.highlight.SolrHighlighter

        emptyArray, getHighlightFields, isHighlightingEnabled

      • Methods inherited from interface org.apache.solr.util.plugin.PluginInfoInitialized

        init

    • Constructor Detail

      • AlfrescoSolrHighlighter

        public AlfrescoSolrHighlighter​(org.apache.solr.core.SolrCore solrCore)

    • Method Detail

      • getHighlighter

        protected org.apache.lucene.search.highlight.Highlighter getHighlighter​(org.apache.lucene.search.Query query,
                                                                        String requestFieldname,
                                                                        org.apache.solr.request.SolrQueryRequest request)
        Return a Highlighter appropriate for this field.
        Overrides:
        getHighlighter in class org.apache.solr.highlight.DefaultSolrHighlighter
        Parameters:
        query - The current Query
        requestFieldname - The name of the field
        request - The current SolrQueryRequest

      • getSpanQueryScorer

        protected org.apache.lucene.search.highlight.QueryScorer getSpanQueryScorer​(org.apache.lucene.search.Query query,
                                                                            String requestFieldname,
                                                                            org.apache.lucene.analysis.TokenStream tokenStream,
                                                                            org.apache.solr.request.SolrQueryRequest request)
        Return a QueryScorer suitable for this Query and field.
        Overrides:
        getSpanQueryScorer in class org.apache.solr.highlight.DefaultSolrHighlighter
        Parameters:
        query - The current query
        tokenStream - document text CachingTokenStream
        requestFieldname - The name of the field
        request - The SolrQueryRequest

      • getQueryScorer

        protected org.apache.lucene.search.highlight.Scorer getQueryScorer​(org.apache.lucene.search.Query query,
                                                                   String requestFieldname,
                                                                   org.apache.solr.request.SolrQueryRequest request)
        Return a Scorer suitable for this Query and field.
        Overrides:
        getQueryScorer in class org.apache.solr.highlight.DefaultSolrHighlighter
        Parameters:
        query - The current query
        requestFieldname - The name of the field
        request - The SolrQueryRequest

      • doHighlighting

        public org.apache.solr.common.util.NamedList<Object> doHighlighting​(org.apache.solr.search.DocList docs,
                                                                    org.apache.lucene.search.Query query,
                                                                    org.apache.solr.request.SolrQueryRequest req,
                                                                    String[] defaultFields)
                                                             throws IOException
        Generates a list of Highlighted query fragments for each item in a list of documents, or returns null if highlighting is disabled.
        Overrides:
        doHighlighting in class org.apache.solr.highlight.DefaultSolrHighlighter
        Parameters:
        docs - query results
        query - the query
        req - the current request
        defaultFields - default list of fields to summarize
        Returns:
        NamedList containing a NamedList for each document, which in turns contains sets (field, summary) pairs.
        Throws:
        IOException

      • doHighlightingByHighlighter

        protected Object doHighlightingByHighlighter​(org.apache.lucene.document.Document doc,
                                             int docId,
                                             org.apache.solr.schema.SchemaField schemaField,
                                             org.apache.lucene.search.Query query,
                                             org.apache.lucene.index.IndexReader reader,
                                             org.apache.solr.request.SolrQueryRequest req)
                                      throws IOException
        Highlights and returns the highlight object for this field -- a String[] by default. Null if none.
        Overrides:
        doHighlightingByHighlighter in class org.apache.solr.highlight.DefaultSolrHighlighter
        Throws:
        IOException

      • alternateField

        protected Object alternateField​(org.apache.lucene.document.Document doc,
                                String fieldName,
                                org.apache.solr.request.SolrQueryRequest req)
        Returns the alternate highlight object for this field -- a String[] by default. Null if none.