Class Result
- java.lang.Object
-
- com.funnelback.publicui.search.model.padre.Result
-
- All Implemented Interfaces:
ResultType
public class Result extends java.lang.Object implements ResultType
A single search result.- Since:
- 11.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Result.Schema
Constants for the PADRE XML result packet tags.
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
allSummaryText
All texts available for generating summary textprivate java.lang.String
cacheUrl
URL to access the cached version of the result.private java.lang.String
clickTrackingUrl
URL for click tracking.private Collapsed
collapsed
Result collapsing information for this result.private java.lang.String
collection
ID of the collection to which this result belongs.private java.lang.Integer
component
For meta collections it's the internal component number of the sub-collection this result is coming from.private java.util.Map<java.lang.String,java.lang.Object>
customData
Custom data placeholder allowing any arbitrary data to be stored by hook scripts.private java.util.Date
date
Date of the search resultstatic java.lang.String
DATE_PATTERN_OUT
Date format used to format a date when serialising a result object.static java.lang.String[]
DATE_PATTERNS_IN
Date formats used to parse dates in PADRE results.private com.google.common.collect.ListMultimap<java.lang.String,java.lang.String>
definedMetadataSeparators
Map containing the separators defined for each metadata class.private java.lang.String
displayUrl
URL to display for the result.private boolean
diversified
Set true if the URL was down weighted by result diversification.private java.lang.Integer
docNum
Internal document number of the result in the index.private boolean
documentVisibleToUser
private Explain
explain
Explain data used in the Content Optimiser.private java.lang.String
exploreLink
Link to the also of interest CGI.private java.lang.Integer
fileSize
Size of the file corresponding to the search results, in bytes.private java.lang.String
fileType
File type of the result, usually the file extension ("pdf", "xls", "html", ...)private java.util.Set<java.lang.String>
gscopesSet
Set of GScope Numbers that this result has.private java.lang.String
indexUrl
Original URL from the index, taken from indexUrl before any transformation.private java.lang.Float
kmFromOrigin
Distance in kilometres of this search result from the origin set when the query is run.private com.google.common.collect.ListMultimap<java.lang.String,java.lang.String>
listMetadata
Multi-Map containing the list of metadata values for each metadata fields for each result.private com.google.common.collect.ListMultimap<java.lang.String,java.lang.String>
listMetadataSeparators
Multi-Map containing the separators originally used by the metadata values within in newMetadata.private java.lang.String
liveUrl
URL to access the search result.private java.util.Map<java.lang.String,java.lang.String>
metaData
Deprecated.As of release 15.16, replaced bylistMetadata
static java.lang.String
METADATA_PREFIX
Prefix for Metadata fields in the MetaData Map.static java.lang.String
NO_DATE
String returned by PADRE when a result has no date.private boolean
promoted
Set true if the URL was promoted using -promote_urls.private QuickLinks
quickLinks
Quick links associated with the result.private java.lang.Integer
rank
Rank of the result (From 1 to n)private java.util.Map<java.lang.String,java.util.Set<RelatedDocument>>
relatedDocuments
Documents related to this result which have been fetched by RelatedDocumentFetcher.private java.lang.Integer
score
Score of the result (From 1000 to 0)private java.lang.String
summary
Query-biased summaryprivate java.util.List<java.lang.String>
tags
Tags associated with a result.private java.lang.Integer
tier
Tier number to which this search results belongs.private java.lang.String
title
Title of the result
-
Constructor Summary
Constructors Constructor Description Result()
Result(java.lang.Integer rank, java.lang.Integer score, java.lang.String title, java.lang.String collection, java.lang.Integer component, Collapsed collapsed, java.lang.String liveUrl, java.lang.String summary, java.lang.String allSummaryText, java.lang.String cacheUrl, java.util.Date date, java.lang.Integer fileSize, java.lang.String fileType, java.lang.Integer tier, java.lang.Integer docNum, java.lang.String exploreLink, java.lang.Float kmFromOrigin, QuickLinks quickLinks, java.lang.String displayUrl, java.lang.String clickTrackingUrl, Explain explain, java.lang.String indexUrl, java.util.Set<java.lang.String> gscopesSet, boolean documentVisibleToUser, boolean promoted, boolean diversified)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getAllSummaryText()
All texts available for generating summary textjava.lang.String
getCacheUrl()
URL to access the cached version of the result.java.lang.String
getClickTrackingUrl()
URL for click tracking.Collapsed
getCollapsed()
Result collapsing information for this result.java.lang.String
getCollection()
ID of the collection to which this result belongs.java.lang.Integer
getComponent()
For meta collections it's the internal component number of the sub-collection this result is coming from.java.util.Map<java.lang.String,java.lang.Object>
getCustomData()
Custom data placeholder allowing any arbitrary data to be stored by hook scripts.java.util.Date
getDate()
Date of the search resultcom.google.common.collect.ListMultimap<java.lang.String,java.lang.String>
getDefinedMetadataSeparators()
Map containing the separators defined for each metadata class.java.lang.String
getDisplayUrl()
URL to display for the result.java.lang.Integer
getDocNum()
Internal document number of the result in the index.Explain
getExplain()
Explain data used in the Content Optimiser.java.lang.String
getExploreLink()
Link to the also of interest CGI.java.lang.Integer
getFileSize()
Size of the file corresponding to the search results, in bytes.java.lang.String
getFileType()
File type of the result, usually the file extension ("pdf", "xls", "html", ...)java.util.Set<java.lang.String>
getGscopesSet()
Set of GScope Numbers that this result has.java.lang.String
getIndexUrl()
Original URL from the index, taken from indexUrl before any transformation.java.lang.Float
getKmFromOrigin()
Distance in kilometres of this search result from the origin set when the query is run.com.google.common.collect.ListMultimap<java.lang.String,java.lang.String>
getListMetadata()
Multi-Map containing the list of metadata values for each metadata fields for each result.com.google.common.collect.ListMultimap<java.lang.String,java.lang.String>
getListMetadataSeparators()
Multi-Map containing the separators originally used by the metadata values within in newMetadata.java.lang.String
getLiveUrl()
URL to access the search result.java.util.Map<java.lang.String,java.lang.String>
getMetaData()
Deprecated.As of release 15.16, replaced bylistMetadata
QuickLinks
getQuickLinks()
Quick links associated with the result.java.lang.Integer
getRank()
Rank of the result (From 1 to n)java.util.Map<java.lang.String,java.util.Set<RelatedDocument>>
getRelatedDocuments()
Documents related to this result which have been fetched by RelatedDocumentFetcher.java.lang.Integer
getScore()
Score of the result (From 1000 to 0)java.lang.String
getSummary()
Query-biased summaryjava.util.List<java.lang.String>
getTags()
Tags associated with a result.java.lang.Integer
getTier()
Tier number to which this search results belongs.java.lang.String
getTitle()
Title of the resultboolean
isDiversified()
Set true if the URL was down weighted by result diversification.boolean
isDocumentVisibleToUser()
boolean
isPromoted()
Set true if the URL was promoted using -promote_urls.void
setAllSummaryText(java.lang.String allSummaryText)
All texts available for generating summary textvoid
setCacheUrl(java.lang.String cacheUrl)
URL to access the cached version of the result.void
setClickTrackingUrl(java.lang.String clickTrackingUrl)
URL for click tracking.void
setCollapsed(Collapsed collapsed)
Result collapsing information for this result.void
setCollection(java.lang.String collection)
ID of the collection to which this result belongs.void
setComponent(java.lang.Integer component)
For meta collections it's the internal component number of the sub-collection this result is coming from.void
setDate(java.util.Date date)
Date of the search resultvoid
setDisplayUrl(java.lang.String displayUrl)
URL to display for the result.void
setDiversified(boolean diversified)
Set true if the URL was down weighted by result diversification.void
setDocNum(java.lang.Integer docNum)
Internal document number of the result in the index.void
setDocumentVisibleToUser(boolean documentVisibleToUser)
void
setExplain(Explain explain)
Explain data used in the Content Optimiser.void
setExploreLink(java.lang.String exploreLink)
Link to the also of interest CGI.void
setFileSize(java.lang.Integer fileSize)
Size of the file corresponding to the search results, in bytes.void
setFileType(java.lang.String fileType)
File type of the result, usually the file extension ("pdf", "xls", "html", ...)void
setGscopesSet(java.util.Set<java.lang.String> gscopesSet)
Set of GScope Numbers that this result has.void
setIndexUrl(java.lang.String indexUrl)
Original URL from the index, taken from indexUrl before any transformation.void
setKmFromOrigin(java.lang.Float kmFromOrigin)
Distance in kilometres of this search result from the origin set when the query is run.void
setLiveUrl(java.lang.String liveUrl)
URL to access the search result.void
setPromoted(boolean promoted)
Set true if the URL was promoted using -promote_urls.void
setQuickLinks(QuickLinks quickLinks)
Quick links associated with the result.void
setRank(java.lang.Integer rank)
Rank of the result (From 1 to n)void
setScore(java.lang.Integer score)
Score of the result (From 1000 to 0)void
setSummary(java.lang.String summary)
Query-biased summaryvoid
setTier(java.lang.Integer tier)
Tier number to which this search results belongs.void
setTitle(java.lang.String title)
Title of the resultjava.lang.String
toString()
-
-
-
Field Detail
-
DATE_PATTERN_OUT
public static final java.lang.String DATE_PATTERN_OUT
Date format used to format a date when serialising a result object.- See Also:
- Constant Field Values
-
DATE_PATTERNS_IN
public static final java.lang.String[] DATE_PATTERNS_IN
Date formats used to parse dates in PADRE results.
-
NO_DATE
public static final java.lang.String NO_DATE
String returned by PADRE when a result has no date.- See Also:
- Constant Field Values
-
METADATA_PREFIX
public static final java.lang.String METADATA_PREFIX
Prefix for Metadata fields in the MetaData Map.- See Also:
- Constant Field Values
-
rank
private java.lang.Integer rank
Rank of the result (From 1 to n)
-
score
private java.lang.Integer score
Score of the result (From 1000 to 0)
-
title
private java.lang.String title
Title of the result
-
collection
private java.lang.String collection
ID of the collection to which this result belongs.
This is usually the same ID as the collection being searched, except for Meta collections where results can come from different sub-collections.
-
component
private java.lang.Integer component
For meta collections it's the internal component number of the sub-collection this result is coming from.
For non-meta collections it's always zero.
- See Also:
collection
-
collapsed
private Collapsed collapsed
Result collapsing information for this result.
Will be null if no results are collapsed with this one.
- Since:
- 12.5
-
liveUrl
private java.lang.String liveUrl
URL to access the search result.
It's identical to the
indexUrl
initially, but might have been transformed by a hook script. The click tracking URL will be built based on this URL, so if you need to modify the URL that's recorded in the click log, this field should be changed.In the default form, its only use it to display a proper URL when the user mouse-over the result title link.
-
summary
private java.lang.String summary
Query-biased summary
-
allSummaryText
private java.lang.String allSummaryText
All texts available for generating summary text- Since:
- 15.18
-
cacheUrl
private java.lang.String cacheUrl
URL to access the cached version of the result.
-
date
private java.util.Date date
Date of the search result
-
fileSize
private java.lang.Integer fileSize
Size of the file corresponding to the search results, in bytes.
-
fileType
private java.lang.String fileType
File type of the result, usually the file extension ("pdf", "xls", "html", ...)
-
tier
private java.lang.Integer tier
Tier number to which this search results belongs.- See Also:
ResultPacket.getResultsWithTierBars()
-
docNum
private java.lang.Integer docNum
Internal document number of the result in the index.
-
exploreLink
private java.lang.String exploreLink
Link to the also of interest CGI.
-
kmFromOrigin
private java.lang.Float kmFromOrigin
Distance in kilometres of this search result from the origin set when the query is run.
-
definedMetadataSeparators
private final com.google.common.collect.ListMultimap<java.lang.String,java.lang.String> definedMetadataSeparators
Map containing the separators defined for each metadata class.
Intended only for internal use, and not exposed in the XML/JSON data model.
Please note that currently separators are defined globally, however this data-model aims to support the possibility of per-class separators in the future.
- Since:
- 15.16
- See Also:
Metadata classes
-
listMetadata
private final com.google.common.collect.ListMultimap<java.lang.String,java.lang.String> listMetadata
Multi-Map containing the list of metadata values for each metadata fields for each result.
The key is the metadata class name as defined in the metadata mappings.
The values are each mapped metadata value, split based on any defined separators.
Note that changes to this multi-map will be reflected in the legacy metaData map, which presents all values as a single string instead of pre-split, and changes to the legacy map will likewise be reflected here.
- Since:
- 15.16
- See Also:
Metadata classes
-
listMetadataSeparators
private final com.google.common.collect.ListMultimap<java.lang.String,java.lang.String> listMetadataSeparators
Multi-Map containing the separators originally used by the metadata values within in newMetadata.
Intended only for internal use, and not exposed in the XML/JSON data model.
This map is only of interest if the specific separators are meaningful to an implementation which is hopefully uncommon. If values are added to the newMetadata map, new separators may be added here also. Some separator from the definedMetadataSeparators list will be used for any added metadata if this map lacks sufficient values.
Note that changes to this multi-map will be reflected in the legacy metaData map, which presents all values as a single string instead of pre-split, and changes to the legacy map will likewise be reflected here.
- Since:
- 15.16
- See Also:
Metadata classes
-
metaData
@Deprecated private final java.util.Map<java.lang.String,java.lang.String> metaData
Deprecated.As of release 15.16, replaced bylistMetadata
Map containing the metadata fields for the result.
The key is the metadata class name as defined in the metadata mappings.
- See Also:
Metadata classes
-
tags
private final java.util.List<java.lang.String> tags
Tags associated with a result.
See the url_tagger program.
-
quickLinks
private QuickLinks quickLinks
Quick links associated with the result.
-
displayUrl
private java.lang.String displayUrl
URL to display for the result.
Initially identical to
indexUrl
andliveUrl
, but might have been transformed by a hook script. This URL can be used to display a different URL from the actual one, while preserving theliveUrl
for the user to access the result.In the default form, this URL is displayed in the
<cite>
block for the the result
-
clickTrackingUrl
private java.lang.String clickTrackingUrl
URL for click tracking.
-
explain
private Explain explain
Explain data used in the Content Optimiser.
-
indexUrl
private java.lang.String indexUrl
Original URL from the index, taken from indexUrl before any transformation.
-
gscopesSet
private java.util.Set<java.lang.String> gscopesSet
Set of GScope Numbers that this result has.
-
customData
private final java.util.Map<java.lang.String,java.lang.Object> customData
Custom data placeholder allowing any arbitrary data to be stored by hook scripts.
-
relatedDocuments
private final java.util.Map<java.lang.String,java.util.Set<RelatedDocument>> relatedDocuments
Documents related to this result which have been fetched by RelatedDocumentFetcher. The map key is chosen by the related document fetching configuration and the set of related documents are those that were fetched based on the metadata relationships traversed by the configuration.- Since:
- 15.16
-
documentVisibleToUser
private boolean documentVisibleToUser
-
promoted
private boolean promoted
Set true if the URL was promoted using -promote_urls.- Since:
- 15.12
-
diversified
private boolean diversified
Set true if the URL was down weighted by result diversification. This might happen from same site suppression (SSS).- Since:
- 15.12
-
-
Constructor Detail
-
Result
public Result(java.lang.Integer rank, java.lang.Integer score, java.lang.String title, java.lang.String collection, java.lang.Integer component, Collapsed collapsed, java.lang.String liveUrl, java.lang.String summary, java.lang.String allSummaryText, java.lang.String cacheUrl, java.util.Date date, java.lang.Integer fileSize, java.lang.String fileType, java.lang.Integer tier, java.lang.Integer docNum, java.lang.String exploreLink, java.lang.Float kmFromOrigin, QuickLinks quickLinks, java.lang.String displayUrl, java.lang.String clickTrackingUrl, Explain explain, java.lang.String indexUrl, java.util.Set<java.lang.String> gscopesSet, boolean documentVisibleToUser, boolean promoted, boolean diversified)
-
Result
public Result()
-
-
Method Detail
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getRank
public java.lang.Integer getRank()
Rank of the result (From 1 to n)
-
setRank
public void setRank(java.lang.Integer rank)
Rank of the result (From 1 to n)
-
getScore
public java.lang.Integer getScore()
Score of the result (From 1000 to 0)
-
setScore
public void setScore(java.lang.Integer score)
Score of the result (From 1000 to 0)
-
getTitle
public java.lang.String getTitle()
Title of the result
-
setTitle
public void setTitle(java.lang.String title)
Title of the result
-
getCollection
public java.lang.String getCollection()
ID of the collection to which this result belongs.
This is usually the same ID as the collection being searched, except for Meta collections where results can come from different sub-collections.
-
setCollection
public void setCollection(java.lang.String collection)
ID of the collection to which this result belongs.
This is usually the same ID as the collection being searched, except for Meta collections where results can come from different sub-collections.
-
getComponent
public java.lang.Integer getComponent()
For meta collections it's the internal component number of the sub-collection this result is coming from.
For non-meta collections it's always zero.
- See Also:
collection
-
setComponent
public void setComponent(java.lang.Integer component)
For meta collections it's the internal component number of the sub-collection this result is coming from.
For non-meta collections it's always zero.
- See Also:
collection
-
getCollapsed
public Collapsed getCollapsed()
Result collapsing information for this result.
Will be null if no results are collapsed with this one.
- Since:
- 12.5
-
setCollapsed
public void setCollapsed(Collapsed collapsed)
Result collapsing information for this result.
Will be null if no results are collapsed with this one.
- Since:
- 12.5
-
getLiveUrl
public java.lang.String getLiveUrl()
URL to access the search result.
It's identical to the
indexUrl
initially, but might have been transformed by a hook script. The click tracking URL will be built based on this URL, so if you need to modify the URL that's recorded in the click log, this field should be changed.In the default form, its only use it to display a proper URL when the user mouse-over the result title link.
-
setLiveUrl
public void setLiveUrl(java.lang.String liveUrl)
URL to access the search result.
It's identical to the
indexUrl
initially, but might have been transformed by a hook script. The click tracking URL will be built based on this URL, so if you need to modify the URL that's recorded in the click log, this field should be changed.In the default form, its only use it to display a proper URL when the user mouse-over the result title link.
-
getSummary
public java.lang.String getSummary()
Query-biased summary
-
setSummary
public void setSummary(java.lang.String summary)
Query-biased summary
-
getAllSummaryText
public java.lang.String getAllSummaryText()
All texts available for generating summary text- Since:
- 15.18
-
setAllSummaryText
public void setAllSummaryText(java.lang.String allSummaryText)
All texts available for generating summary text- Since:
- 15.18
-
getCacheUrl
public java.lang.String getCacheUrl()
URL to access the cached version of the result.
-
setCacheUrl
public void setCacheUrl(java.lang.String cacheUrl)
URL to access the cached version of the result.
-
getDate
public java.util.Date getDate()
Date of the search result
-
setDate
public void setDate(java.util.Date date)
Date of the search result
-
getFileSize
public java.lang.Integer getFileSize()
Size of the file corresponding to the search results, in bytes.
-
setFileSize
public void setFileSize(java.lang.Integer fileSize)
Size of the file corresponding to the search results, in bytes.
-
getFileType
public java.lang.String getFileType()
File type of the result, usually the file extension ("pdf", "xls", "html", ...)
-
setFileType
public void setFileType(java.lang.String fileType)
File type of the result, usually the file extension ("pdf", "xls", "html", ...)
-
getTier
public java.lang.Integer getTier()
Tier number to which this search results belongs.- See Also:
ResultPacket.getResultsWithTierBars()
-
setTier
public void setTier(java.lang.Integer tier)
Tier number to which this search results belongs.- See Also:
ResultPacket.getResultsWithTierBars()
-
getDocNum
public java.lang.Integer getDocNum()
Internal document number of the result in the index.
-
setDocNum
public void setDocNum(java.lang.Integer docNum)
Internal document number of the result in the index.
-
getExploreLink
public java.lang.String getExploreLink()
Link to the also of interest CGI.
-
setExploreLink
public void setExploreLink(java.lang.String exploreLink)
Link to the also of interest CGI.
-
getKmFromOrigin
public java.lang.Float getKmFromOrigin()
Distance in kilometres of this search result from the origin set when the query is run.
-
setKmFromOrigin
public void setKmFromOrigin(java.lang.Float kmFromOrigin)
Distance in kilometres of this search result from the origin set when the query is run.
-
getDefinedMetadataSeparators
public com.google.common.collect.ListMultimap<java.lang.String,java.lang.String> getDefinedMetadataSeparators()
Map containing the separators defined for each metadata class.
Intended only for internal use, and not exposed in the XML/JSON data model.
Please note that currently separators are defined globally, however this data-model aims to support the possibility of per-class separators in the future.
- Since:
- 15.16
- See Also:
Metadata classes
-
getListMetadata
public com.google.common.collect.ListMultimap<java.lang.String,java.lang.String> getListMetadata()
Multi-Map containing the list of metadata values for each metadata fields for each result.
The key is the metadata class name as defined in the metadata mappings.
The values are each mapped metadata value, split based on any defined separators.
Note that changes to this multi-map will be reflected in the legacy metaData map, which presents all values as a single string instead of pre-split, and changes to the legacy map will likewise be reflected here.
- Since:
- 15.16
- See Also:
Metadata classes
-
getListMetadataSeparators
public com.google.common.collect.ListMultimap<java.lang.String,java.lang.String> getListMetadataSeparators()
Multi-Map containing the separators originally used by the metadata values within in newMetadata.
Intended only for internal use, and not exposed in the XML/JSON data model.
This map is only of interest if the specific separators are meaningful to an implementation which is hopefully uncommon. If values are added to the newMetadata map, new separators may be added here also. Some separator from the definedMetadataSeparators list will be used for any added metadata if this map lacks sufficient values.
Note that changes to this multi-map will be reflected in the legacy metaData map, which presents all values as a single string instead of pre-split, and changes to the legacy map will likewise be reflected here.
- Since:
- 15.16
- See Also:
Metadata classes
-
getMetaData
@Deprecated public java.util.Map<java.lang.String,java.lang.String> getMetaData()
Deprecated.As of release 15.16, replaced bylistMetadata
Map containing the metadata fields for the result.
The key is the metadata class name as defined in the metadata mappings.
- See Also:
Metadata classes
-
getTags
public java.util.List<java.lang.String> getTags()
Tags associated with a result.
See the url_tagger program.
-
getQuickLinks
public QuickLinks getQuickLinks()
Quick links associated with the result.
-
setQuickLinks
public void setQuickLinks(QuickLinks quickLinks)
Quick links associated with the result.
-
getDisplayUrl
public java.lang.String getDisplayUrl()
URL to display for the result.
Initially identical to
indexUrl
andliveUrl
, but might have been transformed by a hook script. This URL can be used to display a different URL from the actual one, while preserving theliveUrl
for the user to access the result.In the default form, this URL is displayed in the
<cite>
block for the the result
-
setDisplayUrl
public void setDisplayUrl(java.lang.String displayUrl)
URL to display for the result.
Initially identical to
indexUrl
andliveUrl
, but might have been transformed by a hook script. This URL can be used to display a different URL from the actual one, while preserving theliveUrl
for the user to access the result.In the default form, this URL is displayed in the
<cite>
block for the the result
-
getClickTrackingUrl
public java.lang.String getClickTrackingUrl()
URL for click tracking.
-
setClickTrackingUrl
public void setClickTrackingUrl(java.lang.String clickTrackingUrl)
URL for click tracking.
-
getExplain
public Explain getExplain()
Explain data used in the Content Optimiser.
-
setExplain
public void setExplain(Explain explain)
Explain data used in the Content Optimiser.
-
getIndexUrl
public java.lang.String getIndexUrl()
Original URL from the index, taken from indexUrl before any transformation.
-
setIndexUrl
public void setIndexUrl(java.lang.String indexUrl)
Original URL from the index, taken from indexUrl before any transformation.
-
getGscopesSet
public java.util.Set<java.lang.String> getGscopesSet()
Set of GScope Numbers that this result has.
-
setGscopesSet
public void setGscopesSet(java.util.Set<java.lang.String> gscopesSet)
Set of GScope Numbers that this result has.
-
getCustomData
public java.util.Map<java.lang.String,java.lang.Object> getCustomData()
Custom data placeholder allowing any arbitrary data to be stored by hook scripts.
-
getRelatedDocuments
public java.util.Map<java.lang.String,java.util.Set<RelatedDocument>> getRelatedDocuments()
Documents related to this result which have been fetched by RelatedDocumentFetcher. The map key is chosen by the related document fetching configuration and the set of related documents are those that were fetched based on the metadata relationships traversed by the configuration.- Since:
- 15.16
-
isDocumentVisibleToUser
public boolean isDocumentVisibleToUser()
-
setDocumentVisibleToUser
public void setDocumentVisibleToUser(boolean documentVisibleToUser)
-
isPromoted
public boolean isPromoted()
Set true if the URL was promoted using -promote_urls.- Since:
- 15.12
-
setPromoted
public void setPromoted(boolean promoted)
Set true if the URL was promoted using -promote_urls.- Since:
- 15.12
-
isDiversified
public boolean isDiversified()
Set true if the URL was down weighted by result diversification. This might happen from same site suppression (SSS).- Since:
- 15.12
-
setDiversified
public void setDiversified(boolean diversified)
Set true if the URL was down weighted by result diversification. This might happen from same site suppression (SSS).- Since:
- 15.12
-
-