Package org.apache.maven.index

Class AbstractSearchRequest

    • Field Detail

      • UNDEFINED

        public static final int UNDEFINED
        Constant for denoting undefined value for result count.
        See Also:
        Constant Field Values

      • query

        private org.apache.lucene.search.Query query

      • count

        private int count
        The maximum count of results expected to have delivered, actually count of items (AIs). More precisely, with this setting we LIMIT the number of Lucene Documents for total set of hits to be processed. If set to anything other than UNDEFINED, search will stop upon processing this count of AIs (that correspond to Lucene Document).

      • artifactInfoFilter

        private ArtifactInfoFilter artifactInfoFilter
        The filter to be used while executing the search request.

      • artifactInfoPostprocessor

        private ArtifactInfoPostprocessor artifactInfoPostprocessor
        The postprocessor to apply to hits while returning the,

      • matchHighlightRequests

        private java.util.List<MatchHighlightRequest> matchHighlightRequests
        The highlighting requests, if any.

      • luceneExplain

        private boolean luceneExplain
        Should Lucene Explanations be added to resulting ArtifactInfo's attributes (keyed as org.apache.lucene.search.Explanation.class.getName())? Warning: calculating these are costly operation, and should not be used in production systems (maybe on some "debug" like UI or so).

    • Constructor Detail

      • AbstractSearchRequest

        public AbstractSearchRequest​(org.apache.lucene.search.Query query)

      • AbstractSearchRequest

        public AbstractSearchRequest​(org.apache.lucene.search.Query query,
                             java.util.List<IndexingContext> contexts)

    • Method Detail

      • getQuery

        public org.apache.lucene.search.Query getQuery()

      • setQuery

        public void setQuery​(org.apache.lucene.search.Query query)

      • setContexts

        public void setContexts​(java.util.List<IndexingContext> contexts)

      • getCount

        public int getCount()
        Returns the "count" of wanted results. See UNDEFINED and count.
        Returns:

      • setCount

        public void setCount​(int count)
        Sets the "count" of wanted results. See UNDEFINED and count.
        Parameters:
        count -

      • isHitLimited

        public boolean isHitLimited()
        Deprecated.
        always returns false, since 4.1.0 there is no notion of hit limit
        Returns true if hits are limited.
        Returns:

      • getResultHitLimit

        public int getResultHitLimit()
        Deprecated.
        always returns -1 (no hit limit), since 4.1.0 there is no notion of hit limit
        Gets the hit limit. Since 4.1.0 does nothing, always returns -1 (was "no hit limit").
        Returns:

      • setResultHitLimit

        public void setResultHitLimit​(int resultHitLimit)
        Deprecated.
        does nothing, since 4.1.0 there is no notion of hit limit
        Sets the hit limit. Since 4.1.0 does nothing.
        Parameters:
        resultHitLimit -

      • setArtifactInfoFilter

        public void setArtifactInfoFilter​(ArtifactInfoFilter artifactInfoFilter)

      • setArtifactInfoPostprocessor

        public void setArtifactInfoPostprocessor​(ArtifactInfoPostprocessor artifactInfoPostprocessor)

      • setMatchHighlightRequests

        public void setMatchHighlightRequests​(java.util.List<MatchHighlightRequest> matchHighlightRequests)

      • isLuceneExplain

        public boolean isLuceneExplain()

      • setLuceneExplain

        public void setLuceneExplain​(boolean luceneExplain)