Interface ExcerptProvider

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Name REP_EXCERPT
      Name of the rep:excerpt function.
    • Field Detail

      • REP_EXCERPT

        static final Name REP_EXCERPT
        Name of the rep:excerpt function.
    • Method Detail

      • init

        void init​(org.apache.lucene.search.Query query,
                  SearchIndex index)
           throws IOException
        Initializes this excerpt provider.
        Parameters:
        query - excerpts will be based on this query.
        index - provides access to the search index.
        Throws:
        IOException - if an error occurs while initializing this excerpt provider.
      • getExcerpt

        String getExcerpt​(NodeId id,
                          int maxFragments,
                          int maxFragmentSize)
                   throws IOException
        Returns the XML excerpt for the node with id.
        Parameters:
        id - a node id.
        maxFragments - the maximum number of fragments to create.
        maxFragmentSize - the maximum number of characters in a fragment.
        Returns:
        the XML excerpt or null if there is no node with id.
        Throws:
        IOException - if an error occurs while creating the excerpt.