Note: Java 8 has reached end of support on January 31, 2024. Your existing Java 8 applications will continue to run and receive traffic. However, App Engine might block re-deployment of applications that use runtimes after their end of support date. We recommend that you migrate to the latest supported version of Java.

MatchScorer (Google App Engine API for Java)

java.lang.Object
- 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

Nested Classes
Modifier and Type Class and Description

static class MatchScorer.Builder
A builder that constructs MatchScorers.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-02-15 UTC.

MatchScorer (Google App Engine API for Java)

Class MatchScorer

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newBuilder

toString