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

Modifier and Type	Method and Description
void	score(List<QueryToken> queryTokens, org.apache.lucene.search.Collector collector)
void	score(List<QueryToken> queryTokens, org.apache.lucene.search.Collector collector, Map<String,Object> params)
void	score(List<QueryToken> queryTokens, org.apache.lucene.search.Collector collector, Set<Attachment.Type> attachmentTypes, boolean searchParentName, Map<String,Object> params, String... spaceKeys)
void	score(List<QueryToken> queryTokens, org.apache.lucene.search.Collector collector, Set<Attachment.Type> attachmentTypes, boolean searchParentName, String... spaceKeys)
void	score(List<QueryToken> queryTokens, org.apache.lucene.search.Collector collector, Set<Attachment.Type> attachmentTypes, String... spaceKeys)
void	score(List<QueryToken> queryTokens, org.apache.lucene.search.Collector collector, String... spaceKeys)

Method Detail

score

void score(List<QueryToken> queryTokens,
           org.apache.lucene.search.Collector collector)

Parameters:

queryTokens - the query tokens to be used for scoring

collector - a lucene collector to collect the results

score

void score(List<QueryToken> queryTokens,
           org.apache.lucene.search.Collector collector,
           String... spaceKeys)

Parameters:

queryTokens - the query tokens to be used for scoring

collector - a lucene collector to collect the results

spaceKeys - the spaces to restrict to. empty/null means all spaces

score

void score(List<QueryToken> queryTokens,
           org.apache.lucene.search.Collector collector,
           Set<Attachment.Type> attachmentTypes,
           String... spaceKeys)

Parameters:

queryTokens - the query tokens to be used for scoring

collector - a lucene collector to collect the results

attachmentTypes - attachment types to restrict to. empty/null means all attachments

spaceKeys - the spaces to restrict to. empty/null means all spaces

score

void score(List<QueryToken> queryTokens,
           org.apache.lucene.search.Collector collector,
           Set<Attachment.Type> attachmentTypes,
           boolean searchParentName,
           String... spaceKeys)

Parameters:

queryTokens - the query tokens to be used for scoring

collector - a lucene collector to collect the results

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

score

void score(List<QueryToken> queryTokens,
           org.apache.lucene.search.Collector collector,
           Set<Attachment.Type> attachmentTypes,
           boolean searchParentName,
           Map<String,Object> params,
           String... spaceKeys)

Parameters:

queryTokens - the query tokens to be used for scoring

collector - a lucene collector to collect the results

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

score

void score(List<QueryToken> queryTokens,
           org.apache.lucene.search.Collector collector,
           Map<String,Object> params)

Parameters:

queryTokens - the query tokens to be used for scoring

collector - a lucene collector to collect the results

params - additional parameters to apply to the scorer