public final class

AppSearchSchema.StringPropertyConfig

extends AppSearchSchema.PropertyConfig

 java.lang.Object

↳androidx.appsearch.app.AppSearchSchema.PropertyConfig

↳androidx.appsearch.app.AppSearchSchema.StringPropertyConfig

Overview

Configuration for a property of type String in a Document.

Summary

Fields
public static final intINDEXING_TYPE_EXACT_TERMS

Content in this property should only be returned for queries matching the exact tokens appearing in this property.

public static final intINDEXING_TYPE_NONE

Content in this property will not be tokenized or indexed.

public static final intINDEXING_TYPE_PREFIXES

Content in this property should be returned for queries that are either exact matches or query matches of the tokens appearing in this property.

public static final intJOINABLE_VALUE_TYPE_NONE

Content in this property is not joinable.

public static final intJOINABLE_VALUE_TYPE_QUALIFIED_ID

Content in this string property will be used as a qualified id to join documents.

public static final intTOKENIZER_TYPE_NONE

This value indicates that no tokens should be extracted from this property.

public static final intTOKENIZER_TYPE_PLAIN

Tokenization for plain text.

public static final intTOKENIZER_TYPE_RFC822

Tokenization for emails.

public static final intTOKENIZER_TYPE_VERBATIM

This value indicates that no normalization or segmentation should be applied to string values that are tokenized using this type.

from AppSearchSchema.PropertyConfigCARDINALITY_OPTIONAL, CARDINALITY_REPEATED, CARDINALITY_REQUIRED, DATA_TYPE_BOOLEAN, DATA_TYPE_BYTES, DATA_TYPE_DOCUMENT, DATA_TYPE_DOUBLE, DATA_TYPE_EMBEDDING, DATA_TYPE_LONG, DATA_TYPE_STRING
Methods
public intgetIndexingType()

Returns how the property is indexed.

public intgetJoinableValueType()

Returns how this property is going to be used to join documents from other schema types.

public intgetTokenizerType()

Returns how this property is tokenized (split into words).

from AppSearchSchema.PropertyConfigequals, fromParcel, getCardinality, getDataType, getDescription, getName, hashCode, toString
from java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, wait

Fields

public static final int INDEXING_TYPE_NONE

Content in this property will not be tokenized or indexed.

public static final int INDEXING_TYPE_EXACT_TERMS

Content in this property should only be returned for queries matching the exact tokens appearing in this property.

For example, a property with "fool" should NOT match a query for "foo".

public static final int INDEXING_TYPE_PREFIXES

Content in this property should be returned for queries that are either exact matches or query matches of the tokens appearing in this property.

For example, a property with "fool" should match a query for "foo".

public static final int TOKENIZER_TYPE_NONE

This value indicates that no tokens should be extracted from this property.

It is only valid for tokenizer_type to be 'NONE' if AppSearchSchema.StringPropertyConfig.getIndexingType() is AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_NONE.

public static final int TOKENIZER_TYPE_PLAIN

Tokenization for plain text. This value indicates that tokens should be extracted from this property based on word breaks. Segments of whitespace and punctuation are not considered tokens.

For example, a property with "foo bar. baz." will produce tokens for "foo", "bar" and "baz". The segments " " and "." will not be considered tokens.

It is only valid for tokenizer_type to be 'PLAIN' if AppSearchSchema.StringPropertyConfig.getIndexingType() is AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_EXACT_TERMS or AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_PREFIXES.

public static final int TOKENIZER_TYPE_VERBATIM

This value indicates that no normalization or segmentation should be applied to string values that are tokenized using this type. Therefore, the output token is equivalent to the raw string value.

For example, a property with "Hello, world!" will produce the token "Hello, world!", preserving punctuation and capitalization, and not creating separate tokens between the space.

It is only valid for tokenizer_type to be 'VERBATIM' if AppSearchSchema.StringPropertyConfig.getIndexingType() is AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_EXACT_TERMS or AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_PREFIXES.

public static final int TOKENIZER_TYPE_RFC822

Tokenization for emails. This value indicates that tokens should be extracted from this property based on email structure.

For example, a property with "alex.sav@google.com" will produce tokens for "alex", "sav", "alex.sav", "google", "com", and "alexsav@google.com"

It is only valid for tokenizer_type to be 'RFC822' if AppSearchSchema.StringPropertyConfig.getIndexingType() is AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_EXACT_TERMS or AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_PREFIXES.

public static final int JOINABLE_VALUE_TYPE_NONE

Content in this property is not joinable.

public static final int JOINABLE_VALUE_TYPE_QUALIFIED_ID

Content in this string property will be used as a qualified id to join documents.

Methods

public int getIndexingType()

Returns how the property is indexed.

public int getTokenizerType()

Returns how this property is tokenized (split into words).

public int getJoinableValueType()

Returns how this property is going to be used to join documents from other schema types.

Generated Fri, 13 Sep 2024 06:45:08 +0000 by Michael Jentsch - Privacy Policy - Legal Details