com.google.appengine.api.search
Class MatchScorer

java.lang.Object
  extended by com.google.appengine.api.search.MatchScorer
Direct Known Subclasses:
RescoringMatchScorer

public class MatchScorer
extends java.lang.Object

Assigns a document score based on term frequency. If you add a MatchScorer to a SortOptions as in the following code:

  SortOptions sortOptions = SortOptions.newBuilder()
      .setMatchScorer(MatchScorer().newBuilder())
      .build();
 
then this will sort the documents in descending score order. The scores will be positive. If you want to sort in ascending order, then use the following code:
   SortOptions sortOptions = SortOptions.newBuilder()
       .setMatchScorer(MatchScorer.newBuilder())
       .addSortExpression(
           SortExpression.newBuilder()
               .setExpression(SortExpression.SCORE_FIELD_NAME)
               .setDirection(SortExpression.SortDirection.ASCENDING)
               .setDefaultValueNumeric(0.0))
       .build();
 
The scores in this case will be negative.


Nested Class Summary
static class MatchScorer.Builder
          A builder that constructs MatchScorers.
 
Method Summary
static MatchScorer.Builder newBuilder()
          Creates and returns a MatchScorer Builder.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

newBuilder

public static MatchScorer.Builder newBuilder()
Creates and returns a MatchScorer Builder.

Returns:
a new MatchScorer.Builder. Set the parameters for scorer on the Builder, and use the MatchScorer.Builder.build() method to create a concrete instance of MatchScorer

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object