java.lang.Object
- com.funnelback.publicui.search.model.padre.ResultPacket

```
public class ResultPacket
extends java.lang.Object
```
A PADRE result packet, containing search results.

Since:

11.0

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ResultPacket.Schema
Constants for the PADRE XML result packet tags.

Field Summary

Fields
Modifier and Type	Field	Description
`private java.util.List<BestBet>`	`bestBets`	List of best bets matching the query.
`java.util.Map<java.lang.String,GeoBoundingBox>`	`boundingBoxes`	Bounding boxes for Geospatial metadata classes
`private java.lang.String`	`collection`	ID of the collection being searched.
`private ContextualNavigation`	`contextualNavigation`	Contextual navigation suggestions.
`private java.util.Map<CoolerWeighting,java.lang.String>`	`coolerNames`	A `Map` of long names for cooler ranking variables, keyed by the cooler variable short names + id.
`private java.util.Map<CoolerWeighting,java.lang.Float>`	`coolerWeights`	A `Map` of floats that describe the cooler ranking weights.
`private java.util.Map<java.lang.String,DateCount>`	`dateCounts`	Date counts (Used in faceted navigation)
`private Details`	`details`	Details about the index and PADRE version.
`private java.util.Map<java.lang.String,java.lang.Long>`	`documentsPerCollection`	A map containing the number of documents each collection contributed to the result set.
`private java.util.Map<java.lang.String,java.lang.Integer>`	`entityList`	List of prominent entities.
`private Error`	`error`	Error occurred during the search, if any.
`private java.util.List<java.lang.String>`	`excludeScopes`	Scopes (URL prefixes, not Gscopes) excluded via the `scope` query processor option.
`private java.util.Map<CoolerWeighting,java.lang.String>`	`explainTypes`	A `Map` of Strings that describes how to calculate the potential improvement for ranking on each feature when the content optimiser is used.
`private java.util.Map<java.lang.String,java.lang.Integer>`	`gScopeCounts`	GScope counts (Used in faceted navigation)
`private java.util.List<java.lang.String>`	`includeScopes`	Scopes (URL prefixes, not Gscope) included via the `scope` query processor option.
`private java.util.List<IndexedTermCounts>`	`indexedTermCounts`	A list containing the counts of term occurrences in a metadata class.
`private java.util.Map<java.lang.String,Range>`	`metadataRanges`	Metadata ranges.
`private java.util.Map<java.lang.String,java.lang.Double>`	`metadataSums`	A map of the numeric metadata to total of that numeric metadata in the result set
`private java.lang.Float[]`	`origin`	Origin of the search, for geographical searches.
`private java.lang.Integer`	`padreElapsedTime`	Time spent by PADRE processing the query, in milliseconds
`private java.lang.Float`	`phlusterElapsedTime`	Time spent by PADRE processing contextual navigation, in seconds.
`private java.util.List<QSup>`	`qSups`	List of additional queries for the Query Blending system.
`private java.lang.String`	`query`	Original query terms
`private java.lang.String`	`queryAsProcessed`	Query terms as processed by PADRE.
`private java.lang.String`	`queryCleaned`	The query, cleaned from any operator or constraint that was automatically added by the faceted navigation system.
`private java.lang.String`	`queryHighlightRegex`	Regular expression to use to highlight query terms in titles, summaries or metadata.
`private java.lang.String`	`queryProcessorCodes`	Indicates how the query was internally processed by PADRE.
`private java.lang.String`	`queryRaw`	Query terms as provided to PADRE by the user.
`private java.lang.String`	`querySystemRaw`	System-generated query terms as provided to PADRE.
`private java.util.List<Result>`	`results`	List of results.
`private ResultsSummary`	`resultsSummary`	Summary counts and data about the results (How many documents matched, which page is currently returned, etc.).
`private java.util.Map<java.lang.String,java.util.List<RMCItemResult>>`	`rmcItemResults`	Metadata counts (Used in faceted navigation) including top n results for each count.
`private java.util.Map<java.lang.String,java.lang.Integer>`	`rmcs`	Metadata counts (Used in faceted navigation).
`private Spell`	`spell`	Spelling suggestions.
`private com.google.common.collect.SetMultimap<java.lang.String,java.lang.String>`	`stemmedEquivs`	A `SetMultimap` of Strings that describes the results of stemming on the query.
`private java.util.List<java.lang.String>`	`stopWords`	A `List` of stop words used by the query processor.
`private java.util.List<SumByGroup>`	`sumByGroups`	A list containing the sum of a numeric metadata class grouped by another metadata class
`private java.util.Map<java.lang.String,java.lang.String>`	`svgs`	Contains SVG data returned by PADRE, for example an SVG representation of the syntax tree.
`private java.util.List<TierBar>`	`tierBars`	List of tier bars
`private java.util.List<UniqueByGroup>`	`uniqueCountsByGroups`	A list containing the count of unique values for a metadata class grouped by another metadata class.
`private java.util.Map<java.lang.String,java.lang.Integer>`	`urlCounts`	URL counts (Used in faceted navigation).

Constructor Summary

Constructors
Constructor Description

ResultPacket()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<BestBet>`	`getBestBets()`	List of best bets matching the query.
`java.util.Map<java.lang.String,GeoBoundingBox>`	`getBoundingBoxes()`	Bounding boxes for Geospatial metadata classes
`java.lang.String`	`getCollection()`	ID of the collection being searched.
`ContextualNavigation`	`getContextualNavigation()`	Contextual navigation suggestions.
`java.util.Map<CoolerWeighting,java.lang.String>`	`getCoolerNames()`	A `Map` of long names for cooler ranking variables, keyed by the cooler variable short names + id.
`java.util.Map<CoolerWeighting,java.lang.Float>`	`getCoolerWeights()`	A `Map` of floats that describe the cooler ranking weights.
`java.util.Map<java.lang.String,DateCount>`	`getDateCounts()`	Date counts (Used in faceted navigation)
`Details`	`getDetails()`	Details about the index and PADRE version.
`java.util.Map<java.lang.String,java.lang.Long>`	`getDocumentsPerCollection()`	A map containing the number of documents each collection contributed to the result set.
`java.util.Map<java.lang.String,java.lang.Integer>`	`getEntityList()`	List of prominent entities.
`Error`	`getError()`	Error occurred during the search, if any.
`java.util.List<java.lang.String>`	`getExcludeScopes()`	Scopes (URL prefixes, not Gscopes) excluded via the `scope` query processor option.
`java.util.Map<CoolerWeighting,java.lang.String>`	`getExplainTypes()`	A `Map` of Strings that describes how to calculate the potential improvement for ranking on each feature when the content optimiser is used.
`java.util.Map<java.lang.String,java.lang.Integer>`	`getGScopeCounts()`	GScope counts (Used in faceted navigation)
`java.util.List<java.lang.String>`	`getIncludeScopes()`	Scopes (URL prefixes, not Gscope) included via the `scope` query processor option.
`java.util.List<IndexedTermCounts>`	`getIndexedTermCounts()`	A list containing the counts of term occurrences in a metadata class.
`java.util.Map<java.lang.String,Range>`	`getMetadataRanges()`	Metadata ranges.
`java.util.Map<java.lang.String,java.lang.Double>`	`getMetadataSums()`	A map of the numeric metadata to total of that numeric metadata in the result set
`java.lang.Float[]`	`getOrigin()`	Origin of the search, for geographical searches.
`java.lang.Integer`	`getPadreElapsedTime()`	Time spent by PADRE processing the query, in milliseconds
`java.lang.Float`	`getPhlusterElapsedTime()`	Time spent by PADRE processing contextual navigation, in seconds.
`java.util.List<QSup>`	`getQSups()`	List of additional queries for the Query Blending system.
`java.lang.String`	`getQuery()`	Original query terms
`java.lang.String`	`getQueryAsProcessed()`	Query terms as processed by PADRE.
`java.lang.String`	`getQueryCleaned()`	The query, cleaned from any operator or constraint that was automatically added by the faceted navigation system.
`java.lang.String`	`getQueryHighlightRegex()`	Regular expression to use to highlight query terms in titles, summaries or metadata.
`java.lang.String`	`getQueryProcessorCodes()`	Indicates how the query was internally processed by PADRE.
`java.lang.String`	`getQueryRaw()`	Query terms as provided to PADRE by the user.
`java.lang.String`	`getQuerySystemRaw()`	System-generated query terms as provided to PADRE.
`java.util.List<Result>`	`getResults()`	List of results.
`ResultsSummary`	`getResultsSummary()`	Summary counts and data about the results (How many documents matched, which page is currently returned, etc.).
`java.util.List<ResultType>`	`getResultsWithTierBars()`	Get the results and the tier bars mixed together.
`java.util.Map<java.lang.String,java.util.List<RMCItemResult>>`	`getRmcItemResults()`	Metadata counts (Used in faceted navigation) including top n results for each count.
`java.util.Map<java.lang.String,java.lang.Integer>`	`getRmcs()`	Metadata counts (Used in faceted navigation).
`Spell`	`getSpell()`	Spelling suggestions.
`com.google.common.collect.SetMultimap<java.lang.String,java.lang.String>`	`getStemmedEquivs()`	A `SetMultimap` of Strings that describes the results of stemming on the query.
`java.util.List<java.lang.String>`	`getStopWords()`	A `List` of stop words used by the query processor.
`java.util.List<SumByGroup>`	`getSumByGroups()`	A list containing the sum of a numeric metadata class grouped by another metadata class
`java.util.Map<java.lang.String,java.lang.String>`	`getSvgs()`	Contains SVG data returned by PADRE, for example an SVG representation of the syntax tree.
`java.util.List<TierBar>`	`getTierBars()`	List of tier bars
`java.util.List<UniqueByGroup>`	`getUniqueCountsByGroups()`	A list containing the count of unique values for a metadata class grouped by another metadata class.
`java.util.Map<java.lang.String,java.lang.Integer>`	`getUrlCounts()`	URL counts (Used in faceted navigation).
`boolean`	`hasResults()`	Test if the packet contains results.
`void`	`setCollection(java.lang.String collection)`	ID of the collection being searched.
`void`	`setContextualNavigation(ContextualNavigation contextualNavigation)`	Contextual navigation suggestions.
`void`	`setDetails(Details details)`	Details about the index and PADRE version.
`void`	`setError(Error error)`	Error occurred during the search, if any.
`void`	`setOrigin(java.lang.Float[] origin)`	Origin of the search, for geographical searches.
`void`	`setPadreElapsedTime(java.lang.Integer padreElapsedTime)`	Time spent by PADRE processing the query, in milliseconds
`void`	`setPhlusterElapsedTime(java.lang.Float phlusterElapsedTime)`	Time spent by PADRE processing contextual navigation, in seconds.
`void`	`setQuery(java.lang.String query)`	Original query terms
`void`	`setQueryAsProcessed(java.lang.String queryAsProcessed)`	Query terms as processed by PADRE.
`void`	`setQueryCleaned(java.lang.String queryCleaned)`	The query, cleaned from any operator or constraint that was automatically added by the faceted navigation system.
`void`	`setQueryHighlightRegex(java.lang.String queryHighlightRegex)`	Regular expression to use to highlight query terms in titles, summaries or metadata.
`void`	`setQueryProcessorCodes(java.lang.String queryProcessorCodes)`	Indicates how the query was internally processed by PADRE.
`void`	`setQueryRaw(java.lang.String queryRaw)`	Query terms as provided to PADRE by the user.
`void`	`setQuerySystemRaw(java.lang.String querySystemRaw)`	System-generated query terms as provided to PADRE.
`void`	`setResultsSummary(ResultsSummary resultsSummary)`	Summary counts and data about the results (How many documents matched, which page is currently returned, etc.).
`void`	`setSpell(Spell spell)`	Spelling suggestions.

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

- Field Detail
  - details
```
private Details details
```
    Details about the index and PADRE version.
  - query
```
private java.lang.String query
```
    Original query terms
  - queryAsProcessed
```
private java.lang.String queryAsProcessed
```
    Query terms as processed by PADRE.
    
    This could be different from the query if the initial query contained character that PADRE ignores of if a query transformation was applied by PADRE.
  - queryRaw
```
private java.lang.String queryRaw
```
    Query terms as provided to PADRE by the user.
    
    The query at this point has been encoded to UTF8, possibly there may have been percent decoding if query processor option udcq is used. The value is otherwise unmodified.
  - querySystemRaw
```
private java.lang.String querySystemRaw
```
    System-generated query terms as provided to PADRE.
    
    The query separately provided by the system using the processor option or CGI parameter s. This value has been UTF8 encoded, otherwise it is unchanged. It is ultimately preprocessed and concatenated to the preprocessed user query and parsed.
  - queryCleaned
```
private java.lang.String queryCleaned
```
    The query, cleaned from any operator or constraint that was automatically added by the faceted navigation system.
  - collection
```
private java.lang.String collection
```
    ID of the collection being searched.
  - qSups
```
private final java.util.List<QSup> qSups
```
    List of additional queries for the Query Blending system.
    
    Warning: When accessing this field from a template or a hook script you must use the following syntax: QSups, instead of qSups due to the Javabeans naming conventions.
    
    See Also:
    
    blending.cfg
  - resultsSummary
```
private ResultsSummary resultsSummary
```
    Summary counts and data about the results (How many documents matched, which page is currently returned, etc.).
  - spell
```
private Spell spell
```
    Spelling suggestions.
  - bestBets
```
private final java.util.List<BestBet> bestBets
```
    List of best bets matching the query.
  - results
```
private final java.util.List<Result> results
```
    List of results.
  - tierBars
```
private final java.util.List<TierBar> tierBars
```
    List of tier bars
  - error
```
private Error error
```
    Error occurred during the search, if any.
  - padreElapsedTime
```
private java.lang.Integer padreElapsedTime
```
    Time spent by PADRE processing the query, in milliseconds
  - phlusterElapsedTime
```
private java.lang.Float phlusterElapsedTime
```
    Time spent by PADRE processing contextual navigation, in seconds.
  - queryProcessorCodes
```
private java.lang.String queryProcessorCodes
```
    Indicates how the query was internally processed by PADRE.
  - contextualNavigation
```
private ContextualNavigation contextualNavigation
```
    Contextual navigation suggestions.
  - rmcs
```
private final java.util.Map<java.lang.String,java.lang.Integer> rmcs
```
    Metadata counts (Used in faceted navigation).
    
    The key is the tuple metadata_class:value and the value is the count.
    
    Examples:
    
    a:mozart => 12
    
    a:beethoven => 6
    
    -a: => 10 (i.e. items with no a metadata)
  - rmcItemResults
```
private final java.util.Map<java.lang.String,java.util.List<RMCItemResult>> rmcItemResults
```
    Metadata counts (Used in faceted navigation) including top n results for each count.
    
    The key is the couple of metadata_class:value. The value is a list of the first n results that would be returned if the metadata constraint was applied.
    
    The key is the same one as the rmcs map.
    
    Examples:
    
    a:shakespeare =>
    
    Romeo and Juliet
    
    Cleopatra
    
    ...
    
    a:voltaire =>
    
    Zadig
    
    ...
    Since:
    
    11.2
  - metadataRanges
```
private final java.util.Map<java.lang.String,Range> metadataRanges
```
    Metadata ranges.
    
    The key is the metadata_class and the value is a DoubleRange object with maximum and minimum values.
    
    Example:
    
    P => Range(100.0, 400.0)
  - boundingBoxes
```
public java.util.Map<java.lang.String,GeoBoundingBox> boundingBoxes
```
    Bounding boxes for Geospatial metadata classes
    
    The key is the metadata_class and the value is the bounding box for the coordinates for that class that appeared in the results (up to the DAAT limit).
  - urlCounts
```
private final java.util.Map<java.lang.String,java.lang.Integer> urlCounts
```
    URL counts (Used in faceted navigation).
    
    The key is the URL itself and the value is the count. If the URL starts with http://, it's omitted.
    
    Examples:
    
    www.example.com/about => 12
    
    www.example.com/contact => 6
    
    https://secure.example.com/login => 5
  - gScopeCounts
```
private final java.util.Map<java.lang.String,java.lang.Integer> gScopeCounts
```
    GScope counts (Used in faceted navigation)
    
    The key is the GScope number and the value is the count.
    
    Warning: When accessing this field from a template or a hook script you must use the following syntax: GScopeCounts, instead of gScopeCounts due to the Javabeans naming conventions.
  - dateCounts
```
private final java.util.Map<java.lang.String,DateCount> dateCounts
```
    Date counts (Used in faceted navigation)
    
    The key is a tuple metadata_class:value, with the value being a year or a label, e.g. d:2003 or d:Yesterday.
    
    Since:
    
    12.0
  - queryHighlightRegex
```
private java.lang.String queryHighlightRegex
```
    Regular expression to use to highlight query terms in titles, summaries or metadata.
    
    PADRE provides the regular expression to use depending on the query terms and other factors.
  - origin
```
private java.lang.Float[] origin
```
    Origin of the search, for geographical searches.
    
    The first slot contains the latitude, the second slot contains the longitude.
  - entityList
```
private final java.util.Map<java.lang.String,java.lang.Integer> entityList
```
    List of prominent entities.
    
    See the experimental -fluent query processor option.
  - includeScopes
```
private final java.util.List<java.lang.String> includeScopes
```
    Scopes (URL prefixes, not Gscope) included via the scope query processor option.
  - excludeScopes
```
private final java.util.List<java.lang.String> excludeScopes
```
    Scopes (URL prefixes, not Gscopes) excluded via the scope query processor option.
  - coolerWeights
```
private final java.util.Map<CoolerWeighting,java.lang.Float> coolerWeights
```
    A Map of floats that describe the cooler ranking weights. Weights are identified by the cooler variable short name + id, and the map is only populated when explain mode is on.
  - explainTypes
```
private final java.util.Map<CoolerWeighting,java.lang.String> explainTypes
```
    A Map of Strings that describes how to calculate the potential improvement for ranking on each feature when the content optimiser is used.
    
    Ranking features are identified by the cooler variable short name + id, and the map is only populated when explain mode is on.
  - stopWords
```
private final java.util.List<java.lang.String> stopWords
```
    A List of stop words used by the query processor. Only populated when explain mode is on.
  - stemmedEquivs
```
private com.google.common.collect.SetMultimap<java.lang.String,java.lang.String> stemmedEquivs
```
    A SetMultimap of Strings that describes the results of stemming on the query. Only populated when explain mode is on. The map keys are content terms, and the value(s) are the query terms that the key matches.
  - coolerNames
```
private java.util.Map<CoolerWeighting,java.lang.String> coolerNames
```
    A Map of long names for cooler ranking variables, keyed by the cooler variable short names + id. Only populated when explain mode is on.
  - svgs
```
private java.util.Map<java.lang.String,java.lang.String> svgs
```
    Contains SVG data returned by PADRE, for example an SVG representation of the syntax tree.
    
    The value contains the actual SVG XML string which can be directly used in an HTML source for browsers that supports it.
    
    Since:
    
    12.0
  - uniqueCountsByGroups
```
private java.util.List<UniqueByGroup> uniqueCountsByGroups
```
    A list containing the count of unique values for a metadata class grouped by another metadata class.
    
    Each element of the list is the result of the count of unique values of metadata 'X' grouped by metadata 'Y'.
    
    Since:
    
    15.8
  - sumByGroups
```
private java.util.List<SumByGroup> sumByGroups
```
    A list containing the sum of a numeric metadata class grouped by another metadata class
    
    Each element of the list is the result of the sum of metadata 'X' grouped by metadata 'Y'
  - indexedTermCounts
```
private java.util.List<IndexedTermCounts> indexedTermCounts
```
    A list containing the counts of term occurrences in a metadata class.
    
    See query processor option -countIndexedTerms.
    
    Since:
    
    15.10
  - documentsPerCollection
```
private java.util.Map<java.lang.String,java.lang.Long> documentsPerCollection
```
    A map containing the number of documents each collection contributed to the result set.
    
    The key is the collection name and the value is the number of documents that collection contributed
  - metadataSums
```
private java.util.Map<java.lang.String,java.lang.Double> metadataSums
```
    A map of the numeric metadata to total of that numeric metadata in the result set
    
    The key is the metadata class. The value is the sum.
- Constructor Detail
  - ResultPacket
```
public ResultPacket()
```
- Method Detail
  - hasResults
```
public boolean hasResults()
```
    Test if the packet contains results.
    
    Returns:
    
    true if the packet contains at least one Result.
  - getResultsWithTierBars
```
public java.util.List<ResultType> getResultsWithTierBars()
```
    Get the results and the tier bars mixed together.
    
    This is a convenience method if you need to iterate over the result set and display tier bars.
    
    Returns:
    
    A list containing both Result and TierBar, in the order returned by PADRE.
  - getDetails
```
public Details getDetails()
```
    Details about the index and PADRE version.
  - setDetails
```
public void setDetails(Details details)
```
    Details about the index and PADRE version.
  - getQuery
```
public java.lang.String getQuery()
```
    Original query terms
  - setQuery
```
public void setQuery(java.lang.String query)
```
    Original query terms
  - getQueryAsProcessed
```
public java.lang.String getQueryAsProcessed()
```
    Query terms as processed by PADRE.
    
    This could be different from the query if the initial query contained character that PADRE ignores of if a query transformation was applied by PADRE.
  - setQueryAsProcessed
```
public void setQueryAsProcessed(java.lang.String queryAsProcessed)
```
    Query terms as processed by PADRE.
    
    This could be different from the query if the initial query contained character that PADRE ignores of if a query transformation was applied by PADRE.
  - getQueryRaw
```
public java.lang.String getQueryRaw()
```
    Query terms as provided to PADRE by the user.
    
    The query at this point has been encoded to UTF8, possibly there may have been percent decoding if query processor option udcq is used. The value is otherwise unmodified.
  - setQueryRaw
```
public void setQueryRaw(java.lang.String queryRaw)
```
    Query terms as provided to PADRE by the user.
    
    The query at this point has been encoded to UTF8, possibly there may have been percent decoding if query processor option udcq is used. The value is otherwise unmodified.
  - getQuerySystemRaw
```
public java.lang.String getQuerySystemRaw()
```
    System-generated query terms as provided to PADRE.
    
    The query separately provided by the system using the processor option or CGI parameter s. This value has been UTF8 encoded, otherwise it is unchanged. It is ultimately preprocessed and concatenated to the preprocessed user query and parsed.
  - setQuerySystemRaw
```
public void setQuerySystemRaw(java.lang.String querySystemRaw)
```
    System-generated query terms as provided to PADRE.
    
    The query separately provided by the system using the processor option or CGI parameter s. This value has been UTF8 encoded, otherwise it is unchanged. It is ultimately preprocessed and concatenated to the preprocessed user query and parsed.
  - getQueryCleaned
```
public java.lang.String getQueryCleaned()
```
    The query, cleaned from any operator or constraint that was automatically added by the faceted navigation system.
  - setQueryCleaned
```
public void setQueryCleaned(java.lang.String queryCleaned)
```
    The query, cleaned from any operator or constraint that was automatically added by the faceted navigation system.
  - getCollection
```
public java.lang.String getCollection()
```
    ID of the collection being searched.
  - setCollection
```
public void setCollection(java.lang.String collection)
```
    ID of the collection being searched.
  - getQSups
```
public java.util.List<QSup> getQSups()
```
    List of additional queries for the Query Blending system.
    
    Warning: When accessing this field from a template or a hook script you must use the following syntax: QSups, instead of qSups due to the Javabeans naming conventions.
    
    See Also:
    
    blending.cfg
  - getResultsSummary
```
public ResultsSummary getResultsSummary()
```
    Summary counts and data about the results (How many documents matched, which page is currently returned, etc.).
  - setResultsSummary
```
public void setResultsSummary(ResultsSummary resultsSummary)
```
    Summary counts and data about the results (How many documents matched, which page is currently returned, etc.).
  - getSpell
```
public Spell getSpell()
```
    Spelling suggestions.
  - setSpell
```
public void setSpell(Spell spell)
```
    Spelling suggestions.
  - getBestBets
```
public java.util.List<BestBet> getBestBets()
```
    List of best bets matching the query.
  - getResults
```
public java.util.List<Result> getResults()
```
    List of results.
  - getTierBars
```
public java.util.List<TierBar> getTierBars()
```
    List of tier bars
  - getError
```
public Error getError()
```
    Error occurred during the search, if any.
  - setError
```
public void setError(Error error)
```
    Error occurred during the search, if any.
  - getPadreElapsedTime
```
public java.lang.Integer getPadreElapsedTime()
```
    Time spent by PADRE processing the query, in milliseconds
  - setPadreElapsedTime
```
public void setPadreElapsedTime(java.lang.Integer padreElapsedTime)
```
    Time spent by PADRE processing the query, in milliseconds
  - getPhlusterElapsedTime
```
public java.lang.Float getPhlusterElapsedTime()
```
    Time spent by PADRE processing contextual navigation, in seconds.
  - setPhlusterElapsedTime
```
public void setPhlusterElapsedTime(java.lang.Float phlusterElapsedTime)
```
    Time spent by PADRE processing contextual navigation, in seconds.
  - getQueryProcessorCodes
```
public java.lang.String getQueryProcessorCodes()
```
    Indicates how the query was internally processed by PADRE.
  - setQueryProcessorCodes
```
public void setQueryProcessorCodes(java.lang.String queryProcessorCodes)
```
    Indicates how the query was internally processed by PADRE.
  - getContextualNavigation
```
public ContextualNavigation getContextualNavigation()
```
    Contextual navigation suggestions.
  - setContextualNavigation
```
public void setContextualNavigation(ContextualNavigation contextualNavigation)
```
    Contextual navigation suggestions.
  - getRmcs
```
public java.util.Map<java.lang.String,java.lang.Integer> getRmcs()
```
    Metadata counts (Used in faceted navigation).
    
    The key is the tuple metadata_class:value and the value is the count.
    
    Examples:
    
    a:mozart => 12
    
    a:beethoven => 6
    
    -a: => 10 (i.e. items with no a metadata)
  - getRmcItemResults
```
public java.util.Map<java.lang.String,java.util.List<RMCItemResult>> getRmcItemResults()
```
    Metadata counts (Used in faceted navigation) including top n results for each count.
    
    The key is the couple of metadata_class:value. The value is a list of the first n results that would be returned if the metadata constraint was applied.
    
    The key is the same one as the rmcs map.
    
    Examples:
    
    a:shakespeare =>
    
    Romeo and Juliet
    
    Cleopatra
    
    ...
    
    a:voltaire =>
    
    Zadig
    
    ...
    Since:
    
    11.2
  - getMetadataRanges
```
public java.util.Map<java.lang.String,Range> getMetadataRanges()
```
    Metadata ranges.
    
    The key is the metadata_class and the value is a DoubleRange object with maximum and minimum values.
    
    Example:
    
    P => Range(100.0, 400.0)
  - getBoundingBoxes
```
public java.util.Map<java.lang.String,GeoBoundingBox> getBoundingBoxes()
```
    Bounding boxes for Geospatial metadata classes
    
    The key is the metadata_class and the value is the bounding box for the coordinates for that class that appeared in the results (up to the DAAT limit).
  - getUrlCounts
```
public java.util.Map<java.lang.String,java.lang.Integer> getUrlCounts()
```
    URL counts (Used in faceted navigation).
    
    The key is the URL itself and the value is the count. If the URL starts with http://, it's omitted.
    
    Examples:
    
    www.example.com/about => 12
    
    www.example.com/contact => 6
    
    https://secure.example.com/login => 5
  - getGScopeCounts
```
public java.util.Map<java.lang.String,java.lang.Integer> getGScopeCounts()
```
    GScope counts (Used in faceted navigation)
    
    The key is the GScope number and the value is the count.
    
    Warning: When accessing this field from a template or a hook script you must use the following syntax: GScopeCounts, instead of gScopeCounts due to the Javabeans naming conventions.
  - getDateCounts
```
public java.util.Map<java.lang.String,DateCount> getDateCounts()
```
    Date counts (Used in faceted navigation)
    
    The key is a tuple metadata_class:value, with the value being a year or a label, e.g. d:2003 or d:Yesterday.
    
    Since:
    
    12.0
  - getQueryHighlightRegex
```
public java.lang.String getQueryHighlightRegex()
```
    Regular expression to use to highlight query terms in titles, summaries or metadata.
    
    PADRE provides the regular expression to use depending on the query terms and other factors.
  - setQueryHighlightRegex
```
public void setQueryHighlightRegex(java.lang.String queryHighlightRegex)
```
    Regular expression to use to highlight query terms in titles, summaries or metadata.
    
    PADRE provides the regular expression to use depending on the query terms and other factors.
  - getOrigin
```
public java.lang.Float[] getOrigin()
```
    Origin of the search, for geographical searches.
    
    The first slot contains the latitude, the second slot contains the longitude.
  - setOrigin
```
public void setOrigin(java.lang.Float[] origin)
```
    Origin of the search, for geographical searches.
    
    The first slot contains the latitude, the second slot contains the longitude.
  - getEntityList
```
public java.util.Map<java.lang.String,java.lang.Integer> getEntityList()
```
    List of prominent entities.
    
    See the experimental -fluent query processor option.
  - getIncludeScopes
```
public java.util.List<java.lang.String> getIncludeScopes()
```
    Scopes (URL prefixes, not Gscope) included via the scope query processor option.
  - getExcludeScopes
```
public java.util.List<java.lang.String> getExcludeScopes()
```
    Scopes (URL prefixes, not Gscopes) excluded via the scope query processor option.
  - getCoolerWeights
```
public java.util.Map<CoolerWeighting,java.lang.Float> getCoolerWeights()
```
    A Map of floats that describe the cooler ranking weights. Weights are identified by the cooler variable short name + id, and the map is only populated when explain mode is on.
  - getExplainTypes
```
public java.util.Map<CoolerWeighting,java.lang.String> getExplainTypes()
```
    A Map of Strings that describes how to calculate the potential improvement for ranking on each feature when the content optimiser is used.
    
    Ranking features are identified by the cooler variable short name + id, and the map is only populated when explain mode is on.
  - getStopWords
```
public java.util.List<java.lang.String> getStopWords()
```
    A List of stop words used by the query processor. Only populated when explain mode is on.
  - getStemmedEquivs
```
public com.google.common.collect.SetMultimap<java.lang.String,java.lang.String> getStemmedEquivs()
```
    A SetMultimap of Strings that describes the results of stemming on the query. Only populated when explain mode is on. The map keys are content terms, and the value(s) are the query terms that the key matches.
  - getCoolerNames
```
public java.util.Map<CoolerWeighting,java.lang.String> getCoolerNames()
```
    A Map of long names for cooler ranking variables, keyed by the cooler variable short names + id. Only populated when explain mode is on.
  - getSvgs
```
public java.util.Map<java.lang.String,java.lang.String> getSvgs()
```
    Contains SVG data returned by PADRE, for example an SVG representation of the syntax tree.
    
    The value contains the actual SVG XML string which can be directly used in an HTML source for browsers that supports it.
    
    Since:
    
    12.0
  - getUniqueCountsByGroups
```
public java.util.List<UniqueByGroup> getUniqueCountsByGroups()
```
    A list containing the count of unique values for a metadata class grouped by another metadata class.
    
    Each element of the list is the result of the count of unique values of metadata 'X' grouped by metadata 'Y'.
    
    Since:
    
    15.8
  - getSumByGroups
```
public java.util.List<SumByGroup> getSumByGroups()
```
    A list containing the sum of a numeric metadata class grouped by another metadata class
    
    Each element of the list is the result of the sum of metadata 'X' grouped by metadata 'Y'
  - getIndexedTermCounts
```
public java.util.List<IndexedTermCounts> getIndexedTermCounts()
```
    A list containing the counts of term occurrences in a metadata class.
    
    See query processor option -countIndexedTerms.
    
    Since:
    
    15.10
  - getDocumentsPerCollection
```
public java.util.Map<java.lang.String,java.lang.Long> getDocumentsPerCollection()
```
    A map containing the number of documents each collection contributed to the result set.
    
    The key is the collection name and the value is the number of documents that collection contributed
  - getMetadataSums
```
public java.util.Map<java.lang.String,java.lang.Double> getMetadataSums()
```
    A map of the numeric metadata to total of that numeric metadata in the result set
    
    The key is the metadata class. The value is the sum.

Class ResultPacket

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

details

query

queryAsProcessed

queryRaw

querySystemRaw

queryCleaned

collection

qSups

resultsSummary

spell

bestBets

results

tierBars

error

padreElapsedTime

phlusterElapsedTime

queryProcessorCodes

contextualNavigation

rmcs

rmcItemResults

metadataRanges

boundingBoxes

urlCounts

gScopeCounts

dateCounts

queryHighlightRegex

origin

entityList

includeScopes

excludeScopes

coolerWeights

explainTypes

stopWords

stemmedEquivs

coolerNames

svgs

uniqueCountsByGroups

sumByGroups

indexedTermCounts

documentsPerCollection

metadataSums

Constructor Detail

ResultPacket

Method Detail

hasResults

getResultsWithTierBars

getDetails

setDetails

getQuery

setQuery

getQueryAsProcessed

setQueryAsProcessed

getQueryRaw

setQueryRaw

getQuerySystemRaw

setQuerySystemRaw

getQueryCleaned

setQueryCleaned

getCollection

setCollection

getQSups

getResultsSummary

setResultsSummary

getSpell

setSpell

getBestBets

getResults

getTierBars

getError

setError

getPadreElapsedTime

setPadreElapsedTime

getPhlusterElapsedTime