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.

SnippetExpression

java.lang.Object
- com.google.appengine.api.search.dev.Expression
- - com.google.appengine.api.search.dev.SnippetExpression

```
public class SnippetExpression
extends Expression
```
Expression which generates snippets from specified document.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.appengine.api.search.dev.Expression
  Expression.Sorter

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FieldValue`	`eval(Document doc)` Evaluate the expression to field value proto for the specified document.
`java.lang.String`	`evalHtml(Document doc)`
`java.util.List<Expression.Sorter>`	`getSorters(int sign, double defaultValueNumeric, java.lang.String defaultValueText)` Get list of sort classes for the expression.
`static Expression`	`makeSnippetExpression(java.lang.String query, java.lang.String fieldName, java.util.Set<ContentType> fieldTypes, com.google.appengine.api.search.dev.NumericExpression maxCharsExpression, com.google.appengine.api.search.dev.NumericExpression maxSnippetsExpression)`

Methods inherited from class com.google.appengine.api.search.dev.Expression
makeValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

makeSnippetExpression

public static Expression makeSnippetExpression(java.lang.String query,
                                               java.lang.String fieldName,
                                               java.util.Set<ContentType> fieldTypes,
                                               com.google.appengine.api.search.dev.NumericExpression maxCharsExpression,
                                               com.google.appengine.api.search.dev.NumericExpression maxSnippetsExpression)

evalHtml

public java.lang.String evalHtml(Document doc)
                          throws EvaluationException

Throws:: EvaluationException

eval
```
public FieldValue eval(Document doc)
                throws EvaluationException
```
Description copied from class: Expression

Evaluate the expression to field value proto for the specified document.

Specified by:

eval in class Expression

Throws:

EvaluationException

getSorters
```
public java.util.List<Expression.Sorter> getSorters(int sign,
                                                    double defaultValueNumeric,
                                                    java.lang.String defaultValueText)
```
Description copied from class: Expression

Get list of sort classes for the expression. Usually it contains just one element, but for field expressions it can potentially return 2 sorters when both numeric and text fields exist with a field name.

Specified by:

getSorters in class Expression

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.

SnippetExpression

Class SnippetExpression

Nested Class Summary

Nested classes/interfaces inherited from class com.google.appengine.api.search.dev.Expression

Method Summary

Methods inherited from class com.google.appengine.api.search.dev.Expression

Methods inherited from class java.lang.Object

Method Detail

makeSnippetExpression

evalHtml

eval

getSorters