Summary: Methods | [Expand All]
public interface

ContentNameScorer

com.atlassian.confluence.search.contentnames.lucene.ContentNameScorer
Known Indirect Subclasses

Class Overview

Calculates documents scores for a query directed at content names.

Summary

Public Methods
abstract DocumentResultScores score(List<QueryToken> queryTokens, Set<Attachment.Type> attachmentTypes, String... spaceKeys)
abstract DocumentResultScores score(List<QueryToken> queryTokens, Set<Attachment.Type> attachmentTypes, boolean searchParentName, String... spaceKeys)
abstract DocumentResultScores score(List<QueryToken> queryTokens, Set<Attachment.Type> attachmentTypes, boolean searchParentName, Map<String, Object> params, String... spaceKeys)
abstract DocumentResultScores score(List<QueryToken> queryTokens, Map<String, Object> params)
abstract DocumentResultScores score(List<QueryToken> queryTokens)
abstract DocumentResultScores score(List<QueryToken> queryTokens, String... spaceKeys)

Public Methods

public abstract DocumentResultScores score (List<QueryToken> queryTokens, Set<Attachment.Type> attachmentTypes, String... spaceKeys)

Parameters
queryTokens the query tokens to be used for scoring
attachmentTypes attachment types to restrict to. empty/null means all attachments
spaceKeys the spaces to restrict to. empty/null means all spaces
Returns
  • the document scores for this query

public abstract DocumentResultScores score (List<QueryToken> queryTokens, Set<Attachment.Type> attachmentTypes, boolean searchParentName, String... spaceKeys)

Parameters
queryTokens the query tokens to be used for scoring
attachmentTypes attachment types to restrict to. empty/null means all attachments
searchParentName also matches against parent document names
spaceKeys the spaces to restrict to. empty/null means all spaces
Returns
  • the document scores for this query

public abstract DocumentResultScores score (List<QueryToken> queryTokens, Set<Attachment.Type> attachmentTypes, boolean searchParentName, Map<String, Object> params, String... spaceKeys)

Parameters
queryTokens the query tokens to be used for scoring
attachmentTypes attachment types to restrict to. empty/null means all attachments
searchParentName also matches against parent document names
params additional parameters to apply to the scorer
spaceKeys the spaces to restrict to. empty/null means all spaces
Returns
  • the document scores for this query

public abstract DocumentResultScores score (List<QueryToken> queryTokens, Map<String, Object> params)

Parameters
queryTokens the query tokens to be used for scoring
params additional parameters to apply to the scorer
Returns
  • the document scores for this query

public abstract DocumentResultScores score (List<QueryToken> queryTokens)

Parameters
queryTokens the query tokens to be used for scoring
Returns
  • the document scores for this query

public abstract DocumentResultScores score (List<QueryToken> queryTokens, String... spaceKeys)

Parameters
queryTokens the query tokens to be used for scoring
spaceKeys the spaces to restrict to. empty/null means all spaces
Returns
  • the document scores for this query