Package org.apache.maven.index
Class AbstractSearchRequest
- java.lang.Object
-
- org.apache.maven.index.AbstractSearchRequest
-
- Direct Known Subclasses:
AbstractSearchPageableRequest
,FlatSearchRequest
,GroupedSearchRequest
public class AbstractSearchRequest extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description private ArtifactInfoFilter
artifactInfoFilter
The filter to be used while executing the search request.private ArtifactInfoPostprocessor
artifactInfoPostprocessor
The postprocessor to apply to hits while returning the,private java.util.List<IndexingContext>
contexts
private int
count
The maximum count of results expected to have delivered, actually count of items (AIs).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).private java.util.List<MatchHighlightRequest>
matchHighlightRequests
The highlighting requests, if any.private org.apache.lucene.search.Query
query
static int
UNDEFINED
Constant for denoting undefined value for result count.
-
Constructor Summary
Constructors Constructor Description AbstractSearchRequest(org.apache.lucene.search.Query query)
AbstractSearchRequest(org.apache.lucene.search.Query query, java.util.List<IndexingContext> contexts)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ArtifactInfoFilter
getArtifactInfoFilter()
ArtifactInfoPostprocessor
getArtifactInfoPostprocessor()
java.util.List<IndexingContext>
getContexts()
int
getCount()
Returns the "count" of wanted results.java.util.List<MatchHighlightRequest>
getMatchHighlightRequests()
org.apache.lucene.search.Query
getQuery()
int
getResultHitLimit()
Deprecated.always returns -1 (no hit limit), since 4.1.0 there is no notion of hit limitboolean
isHitLimited()
Deprecated.always returns false, since 4.1.0 there is no notion of hit limitboolean
isLuceneExplain()
void
setArtifactInfoFilter(ArtifactInfoFilter artifactInfoFilter)
void
setArtifactInfoPostprocessor(ArtifactInfoPostprocessor artifactInfoPostprocessor)
void
setContexts(java.util.List<IndexingContext> contexts)
void
setCount(int count)
Sets the "count" of wanted results.void
setLuceneExplain(boolean luceneExplain)
void
setMatchHighlightRequests(java.util.List<MatchHighlightRequest> matchHighlightRequests)
void
setQuery(org.apache.lucene.search.Query query)
void
setResultHitLimit(int resultHitLimit)
Deprecated.does nothing, since 4.1.0 there is no notion of hit limit
-
-
-
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
-
contexts
private java.util.List<IndexingContext> contexts
-
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 thanUNDEFINED
, 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)
-
getContexts
public java.util.List<IndexingContext> getContexts()
-
setContexts
public void setContexts(java.util.List<IndexingContext> contexts)
-
getCount
public int getCount()
- Returns:
-
setCount
public void setCount(int count)
- Parameters:
count
-
-
isHitLimited
public boolean isHitLimited()
Deprecated.always returns false, since 4.1.0 there is no notion of hit limitReturns 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 limitGets 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 limitSets the hit limit. Since 4.1.0 does nothing.- Parameters:
resultHitLimit
-
-
getArtifactInfoFilter
public ArtifactInfoFilter getArtifactInfoFilter()
-
setArtifactInfoFilter
public void setArtifactInfoFilter(ArtifactInfoFilter artifactInfoFilter)
-
getArtifactInfoPostprocessor
public ArtifactInfoPostprocessor getArtifactInfoPostprocessor()
-
setArtifactInfoPostprocessor
public void setArtifactInfoPostprocessor(ArtifactInfoPostprocessor artifactInfoPostprocessor)
-
getMatchHighlightRequests
public java.util.List<MatchHighlightRequest> getMatchHighlightRequests()
-
setMatchHighlightRequests
public void setMatchHighlightRequests(java.util.List<MatchHighlightRequest> matchHighlightRequests)
-
isLuceneExplain
public boolean isLuceneExplain()
-
setLuceneExplain
public void setLuceneExplain(boolean luceneExplain)
-
-