AppSearchSchema.StringPropertyConfig
public
static
final
class
AppSearchSchema.StringPropertyConfig
extends AppSearchSchema.PropertyConfig
java.lang.Object | ||
↳ | android.app.appsearch.AppSearchSchema.PropertyConfig | |
↳ | android.app.appsearch.AppSearchSchema.StringPropertyConfig |
Configuration for a property of type String in a Document.
Summary
Nested classes | |
---|---|
class |
AppSearchSchema.StringPropertyConfig.Builder
Builder for |
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 |
JOINABLE_VALUE_TYPE_NONE
Content in this property is not joinable. |
int |
JOINABLE_VALUE_TYPE_QUALIFIED_ID
Content in this string property will be used as a qualified id to join documents. |
int |
TOKENIZER_TYPE_NONE
This value indicates that no tokens should be extracted from this property. |
int |
TOKENIZER_TYPE_PLAIN
Tokenization for plain text. |
int |
TOKENIZER_TYPE_RFC822
Tokenization for emails. |
int |
TOKENIZER_TYPE_VERBATIM
This value indicates that no normalization or segmentation should be applied to string values that are tokenized using this type. |
Inherited constants |
---|
Public methods | |
---|---|
int
|
getIndexingType()
Returns how the property is indexed. |
int
|
getJoinableValueType()
Returns how this property is going to be used to join documents from other schema types. |
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.
For example, 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.
For example, a property with "fool" should match a query for "foo".
Constant Value: 2 (0x00000002)
JOINABLE_VALUE_TYPE_NONE
public static final int JOINABLE_VALUE_TYPE_NONE
Content in this property is not joinable.
Constant Value: 0 (0x00000000)
JOINABLE_VALUE_TYPE_QUALIFIED_ID
public static final int JOINABLE_VALUE_TYPE_QUALIFIED_ID
Content in this string property will be used as a qualified id to join documents.
- Qualified id: a unique identifier for a document, and this joinable value type is
similar to primary and foreign key in relational database. See
DocumentIdUtil
for more details. - Currently we only support single string joining, so it should only be used with
PropertyConfig#CARDINALITY_OPTIONAL
andAppSearchSchema.PropertyConfig.CARDINALITY_REQUIRED
.
Constant Value: 1 (0x00000001)
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.
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 getIndexingType()
is
INDEXING_TYPE_EXACT_TERMS
or INDEXING_TYPE_PREFIXES
.
Constant Value: 1 (0x00000001)
TOKENIZER_TYPE_RFC822
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 getIndexingType()
is
INDEXING_TYPE_EXACT_TERMS
or INDEXING_TYPE_PREFIXES
.
Constant Value: 3 (0x00000003)
TOKENIZER_TYPE_VERBATIM
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 getIndexingType()
is
INDEXING_TYPE_EXACT_TERMS
or INDEXING_TYPE_PREFIXES
.
Constant Value: 2 (0x00000002)
Public methods
getIndexingType
public int getIndexingType ()
Returns how the property is indexed.
Returns | |
---|---|
int |
Value is INDEXING_TYPE_NONE , INDEXING_TYPE_EXACT_TERMS , or INDEXING_TYPE_PREFIXES |
getJoinableValueType
public int getJoinableValueType ()
Returns how this property is going to be used to join documents from other schema types.
Returns | |
---|---|
int |
Value is JOINABLE_VALUE_TYPE_NONE , or JOINABLE_VALUE_TYPE_QUALIFIED_ID |
getTokenizerType
public int getTokenizerType ()
Returns how this property is tokenized (split into words).
Returns | |
---|---|
int |
Value is TOKENIZER_TYPE_NONE , TOKENIZER_TYPE_PLAIN , TOKENIZER_TYPE_VERBATIM , or TOKENIZER_TYPE_RFC822 |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-04 UTC.