Class Result.ResultBuilder
- java.lang.Object
-
- com.funnelback.publicui.search.model.padre.Result.ResultBuilder
-
-
Field Summary
Fields Modifier and Type Field Description private String
allSummaryText
private String
cacheUrl
private String
clickTrackingUrl
private Collapsed
collapsed
private String
collection
private Integer
component
private Date
date
private String
displayUrl
private boolean
diversified$set
private boolean
diversified$value
private Integer
docNum
private boolean
documentVisibleToUser$set
private boolean
documentVisibleToUser$value
private Explain
explain
private String
exploreLink
private Integer
fileSize
private String
fileType
private Set<String>
gscopesSet
private String
indexUrl
private Float
kmFromOrigin
private String
liveUrl
private boolean
promoted$set
private boolean
promoted$value
private QuickLinks
quickLinks
private Integer
rank
private Integer
score
private String
summary
private Integer
tier
private String
title
-
Constructor Summary
Constructors Constructor Description ResultBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Result.ResultBuilder
allSummaryText(String allSummaryText)
All texts available for generating summary textResult
build()
Result.ResultBuilder
cacheUrl(String cacheUrl)
URL to access the cached version of the result.Result.ResultBuilder
clickTrackingUrl(String clickTrackingUrl)
URL for click tracking.Result.ResultBuilder
collapsed(Collapsed collapsed)
Result collapsing information for this result.Result.ResultBuilder
collection(String collection)
ID of the collection to which this result belongs.Result.ResultBuilder
component(Integer component)
For meta collections it's the internal component number of the sub-collection this result is coming from.Result.ResultBuilder
date(Date date)
Date of the search resultResult.ResultBuilder
displayUrl(String displayUrl)
URL to display for the result.Result.ResultBuilder
diversified(boolean diversified)
Set true if the URL was down weighted by result diversification.Result.ResultBuilder
docNum(Integer docNum)
Internal document number of the result in the index.Result.ResultBuilder
documentVisibleToUser(boolean documentVisibleToUser)
Result.ResultBuilder
explain(Explain explain)
Explain data used in the Content Optimiser.Result.ResultBuilder
exploreLink(String exploreLink)
Link to the also of interest CGI.Result.ResultBuilder
fileSize(Integer fileSize)
Size of the file corresponding to the search results, in bytes.Result.ResultBuilder
fileType(String fileType)
File type of the result, usually the file extension ("pdf", "xls", "html", ...)Result.ResultBuilder
gscopesSet(Set<String> gscopesSet)
Set of GScope Numbers that this result has.Result.ResultBuilder
indexUrl(String indexUrl)
Original URL from the index, taken from indexUrl before any transformation.Result.ResultBuilder
kmFromOrigin(Float kmFromOrigin)
Distance in kilometres of this search result from the origin set when the query is run.Result.ResultBuilder
liveUrl(String liveUrl)
URL to access the search result.Result.ResultBuilder
promoted(boolean promoted)
Set true if the URL was promoted using -promote_urls.Result.ResultBuilder
quickLinks(QuickLinks quickLinks)
Quick links associated with the result.Result.ResultBuilder
rank(Integer rank)
Rank of the result (From 1 to n)Result.ResultBuilder
score(Integer score)
Score of the result (From 1000 to 0)Result.ResultBuilder
summary(String summary)
Query-biased summaryResult.ResultBuilder
tier(Integer tier)
Tier number to which this search results belongs.Result.ResultBuilder
title(String title)
Title of the resultString
toString()
-
-
-
Field Detail
-
rank
private Integer rank
-
score
private Integer score
-
title
private String title
-
collection
private String collection
-
component
private Integer component
-
collapsed
private Collapsed collapsed
-
liveUrl
private String liveUrl
-
summary
private String summary
-
allSummaryText
private String allSummaryText
-
cacheUrl
private String cacheUrl
-
date
private Date date
-
fileSize
private Integer fileSize
-
fileType
private String fileType
-
tier
private Integer tier
-
docNum
private Integer docNum
-
exploreLink
private String exploreLink
-
kmFromOrigin
private Float kmFromOrigin
-
quickLinks
private QuickLinks quickLinks
-
displayUrl
private String displayUrl
-
clickTrackingUrl
private String clickTrackingUrl
-
explain
private Explain explain
-
indexUrl
private String indexUrl
-
documentVisibleToUser$set
private boolean documentVisibleToUser$set
-
documentVisibleToUser$value
private boolean documentVisibleToUser$value
-
promoted$set
private boolean promoted$set
-
promoted$value
private boolean promoted$value
-
diversified$set
private boolean diversified$set
-
diversified$value
private boolean diversified$value
-
-
Method Detail
-
rank
public Result.ResultBuilder rank(Integer rank)
Rank of the result (From 1 to n)- Returns:
this
.
-
score
public Result.ResultBuilder score(Integer score)
Score of the result (From 1000 to 0)- Returns:
this
.
-
title
public Result.ResultBuilder title(String title)
Title of the result- Returns:
this
.
-
collection
public Result.ResultBuilder collection(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.
- Returns:
this
.
-
component
public Result.ResultBuilder component(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.
- Returns:
this
.- See Also:
Result.collection
-
collapsed
public Result.ResultBuilder collapsed(Collapsed collapsed)
Result collapsing information for this result.
Will be null if no results are collapsed with this one.
- Returns:
this
.- Since:
- 12.5
-
liveUrl
public Result.ResultBuilder liveUrl(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.
- Returns:
this
.
-
summary
public Result.ResultBuilder summary(String summary)
Query-biased summary- Returns:
this
.
-
allSummaryText
public Result.ResultBuilder allSummaryText(String allSummaryText)
All texts available for generating summary text- Returns:
this
.- Since:
- 15.18
-
cacheUrl
public Result.ResultBuilder cacheUrl(String cacheUrl)
URL to access the cached version of the result.- Returns:
this
.
-
date
public Result.ResultBuilder date(Date date)
Date of the search result- Returns:
this
.
-
fileSize
public Result.ResultBuilder fileSize(Integer fileSize)
Size of the file corresponding to the search results, in bytes.- Returns:
this
.
-
fileType
public Result.ResultBuilder fileType(String fileType)
File type of the result, usually the file extension ("pdf", "xls", "html", ...)- Returns:
this
.
-
tier
public Result.ResultBuilder tier(Integer tier)
Tier number to which this search results belongs.- Returns:
this
.- See Also:
ResultPacket.getResultsWithTierBars()
-
docNum
public Result.ResultBuilder docNum(Integer docNum)
Internal document number of the result in the index.- Returns:
this
.
-
exploreLink
public Result.ResultBuilder exploreLink(String exploreLink)
Link to the also of interest CGI.- Returns:
this
.
-
kmFromOrigin
public Result.ResultBuilder kmFromOrigin(Float kmFromOrigin)
Distance in kilometres of this search result from the origin set when the query is run.- Returns:
this
.
-
quickLinks
public Result.ResultBuilder quickLinks(QuickLinks quickLinks)
Quick links associated with the result.- Returns:
this
.
-
displayUrl
public Result.ResultBuilder displayUrl(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- Returns:
this
.
-
clickTrackingUrl
public Result.ResultBuilder clickTrackingUrl(String clickTrackingUrl)
URL for click tracking.- Returns:
this
.
-
explain
public Result.ResultBuilder explain(Explain explain)
Explain data used in the Content Optimiser.- Returns:
this
.
-
indexUrl
public Result.ResultBuilder indexUrl(String indexUrl)
Original URL from the index, taken from indexUrl before any transformation.- Returns:
this
.
-
gscopesSet
public Result.ResultBuilder gscopesSet(Set<String> gscopesSet)
Set of GScope Numbers that this result has.- Returns:
this
.
-
documentVisibleToUser
public Result.ResultBuilder documentVisibleToUser(boolean documentVisibleToUser)
- Returns:
this
.
-
promoted
public Result.ResultBuilder promoted(boolean promoted)
Set true if the URL was promoted using -promote_urls.- Returns:
this
.- Since:
- 15.12
-
diversified
public Result.ResultBuilder diversified(boolean diversified)
Set true if the URL was down weighted by result diversification. This might happen from same site suppression (SSS).- Returns:
this
.- Since:
- 15.12
-
build
public Result build()
-
-