GroupedSearchRequest (Maven :: Indexer Core 5.1.1 API)

java.lang.Object
- org.apache.maven.index.AbstractSearchRequest
- - org.apache.maven.index.GroupedSearchRequest

```
public class GroupedSearchRequest
extends AbstractSearchRequest
```
A grouped search request. This kinds of request is not pageable, since order of incoming hits are not defined, hence paging between Document hits makes no sense, would produce unpredictable (and probably not meaningful) results.

See Also:
Indexer.searchGrouped(GroupedSearchRequest)

Field Summary
- Fields inherited from class org.apache.maven.index.AbstractSearchRequest
  UNDEFINED

Constructor Summary

Constructors
Constructor and Description
`GroupedSearchRequest(org.apache.lucene.search.Query query, Grouping grouping)`
`GroupedSearchRequest(org.apache.lucene.search.Query query, Grouping grouping, Comparator<String> groupKeyComparator)`
`GroupedSearchRequest(org.apache.lucene.search.Query query, Grouping grouping, Comparator<String> groupKeyComparator, IndexingContext context)`
`GroupedSearchRequest(org.apache.lucene.search.Query query, Grouping grouping, IndexingContext context)`

Method Summary

Methods
Modifier and Type	Method and Description
`Grouping`	`getGrouping()`
`Comparator<String>`	`getGroupKeyComparator()`
`void`	`setGrouping(Grouping grouping)`
`void`	`setGroupKeyComparator(Comparator<String> groupKeyComparator)`

Methods inherited from class org.apache.maven.index.AbstractSearchRequest
getArtifactInfoFilter, getArtifactInfoPostprocessor, getContexts, getCount, getMatchHighlightRequests, getQuery, getResultHitLimit, isHitLimited, isLuceneExplain, setArtifactInfoFilter, setArtifactInfoPostprocessor, setContexts, setCount, setLuceneExplain, setMatchHighlightRequests, setQuery, setResultHitLimit

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupedSearchRequest

public GroupedSearchRequest(org.apache.lucene.search.Query query,
                    Grouping grouping)

GroupedSearchRequest

public GroupedSearchRequest(org.apache.lucene.search.Query query,
                    Grouping grouping,
                    Comparator<String> groupKeyComparator)

GroupedSearchRequest

public GroupedSearchRequest(org.apache.lucene.search.Query query,
                    Grouping grouping,
                    IndexingContext context)

GroupedSearchRequest

public GroupedSearchRequest(org.apache.lucene.search.Query query,
                    Grouping grouping,
                    Comparator<String> groupKeyComparator,
                    IndexingContext context)

Method Detail

getGrouping
```
public Grouping getGrouping()
```

setGrouping

public void setGrouping(Grouping grouping)

getGroupKeyComparator

public Comparator<String> getGroupKeyComparator()

setGroupKeyComparator

public void setGroupKeyComparator(Comparator<String> groupKeyComparator)

Class GroupedSearchRequest

Field Summary

Fields inherited from class org.apache.maven.index.AbstractSearchRequest

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.index.AbstractSearchRequest

Methods inherited from class java.lang.Object

Constructor Detail

GroupedSearchRequest

GroupedSearchRequest

GroupedSearchRequest

GroupedSearchRequest

Method Detail

getGrouping

setGrouping

getGroupKeyComparator

setGroupKeyComparator