com.atlassian.confluence.search.contentnames.lucene
Interface ContentNameScorer

All Known Implementing Classes:

LuceneContentNameScorer

public interface ContentNameScorer

Calculates documents scores for a query directed at content names.

Method Summary

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

Method Detail

score

DocumentResultScores score(List<QueryToken> queryTokens)

Parameters:

queryTokens - the query tokens to be used for scoring

Returns:

the document scores for this query

score

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

score

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

score

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

score

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

score

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