AppSearchSchema.StringPropertyConfig

public static final class AppSearchSchema.StringPropertyConfig
extends AppSearchSchema.PropertyConfig

java.lang.Object
   ↳ androidx.appsearch.app.AppSearchSchema.PropertyConfig
     ↳ androidx.appsearch.app.AppSearchSchema.StringPropertyConfig

Configuration for a property of type String in a Document.

Summary

Nested classes

class AppSearchSchema.StringPropertyConfig.Builder

Builder for AppSearchSchema.StringPropertyConfig. 

Constants

int INDEXING_TYPE_EXACT_TERMS

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

int INDEXING_TYPE_NONE

Content in this property will not be tokenized or indexed.

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.

int TOKENIZER_TYPE_NONE

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

int TOKENIZER_TYPE_PLAIN

Tokenization for plain text.

Inherited constants

Public methods

int getIndexingType()

Returns how the property is indexed.

int getTokenizerType()

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

Inherited methods

Constants

INDEXING_TYPE_EXACT_TERMS

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.

Ex. A property with "fool" should NOT match a query for "foo".

Constant Value: 1 (0x00000001)

INDEXING_TYPE_NONE

public static final int INDEXING_TYPE_NONE

Content in this property will not be tokenized or indexed.

Constant Value: 0 (0x00000000)

INDEXING_TYPE_PREFIXES

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.

Ex. A property with "fool" should match a query for "foo".

Constant Value: 2 (0x00000002)

TOKENIZER_TYPE_NONE

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 getIndexingType() is INDEXING_TYPE_NONE.

Constant Value: 0 (0x00000000)

TOKENIZER_TYPE_PLAIN

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.

Ex. 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 getIndexingType() is INDEXING_TYPE_EXACT_TERMS or INDEXING_TYPE_PREFIXES.

Constant Value: 1 (0x00000001)

Public methods

getIndexingType

public int getIndexingType ()

Returns how the property is indexed.

Returns
int

getTokenizerType

public int getTokenizerType ()

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

Returns
int