GenericDocument

Kotlin |Java

class GenericDocument

Represents a document unit.

Documents contain structured data conforming to their AppSearchSchema type. Each document is uniquely identified by a namespace and a String ID within that namespace.

Documents are constructed either by using the GenericDocument.Builder or providing an annotated Document data class.

See also
`putAsync`
`getByDocumentIdAsync`
`search`

Summary

Nested types
`class GenericDocument.Builder<BuilderType : GenericDocument.Builder?>` The builder class for `GenericDocument`.

Protected constructors
`GenericDocument(document: GenericDocument)` Creates a new `GenericDocument` from an existing instance.

Public functions
`Boolean`	`equals(other: Any?)`
`java-static GenericDocument`	`fromDocumentClass(document: Any)` Converts an instance of a class annotated with \@`Document` into an instance of `GenericDocument`.
`Long`	`getCreationTimestampMillis()` Returns the creation timestamp of the `GenericDocument`, in milliseconds.
`String`	`getId()` Returns the unique identifier of the `GenericDocument`.
`String`	`getNamespace()` Returns the namespace of the `GenericDocument`.
`Any?`	`getProperty(path: String)` Retrieves the property value with the given path as `Object`.
`AppSearchBlobHandle?`	`@ExperimentalAppSearchApi getPropertyBlobHandle(path: String)` Retrieves an `AppSearchBlobHandle` property by path.
`Array<AppSearchBlobHandle!>?`	`@ExperimentalAppSearchApi getPropertyBlobHandleArray(path: String)` Retrieves a repeated `AppSearchBlobHandle[]` property by path.
`Boolean`	`getPropertyBoolean(path: String)` Retrieves a `boolean` property by path.
`BooleanArray<Boolean>?`	`getPropertyBooleanArray(path: String)` Retrieves a repeated `boolean` property by path.
`ByteArray<Byte>?`	`getPropertyBytes(path: String)` Retrieves a `byte[]` property by path.
`Array<ByteArray<Byte>!>?`	`getPropertyBytesArray(path: String)` Retrieves a `byte[][]` property by path.
`GenericDocument?`	`getPropertyDocument(path: String)` Retrieves a `GenericDocument` property by path.
`Array<GenericDocument!>?`	`getPropertyDocumentArray(path: String)` Retrieves a repeated `GenericDocument` property by path.
`Double`	`getPropertyDouble(path: String)` Retrieves a `double` property by path.
`DoubleArray<Double>?`	`getPropertyDoubleArray(path: String)` Retrieves a repeated `double` property by path.
`EmbeddingVector?`	`getPropertyEmbedding(path: String)` Retrieves an `EmbeddingVector` property by path.
`Array<EmbeddingVector!>?`	`getPropertyEmbeddingArray(path: String)` Retrieves a repeated `EmbeddingVector[]` property by path.
`Long`	`getPropertyLong(path: String)` Retrieves a `long` property by path.
`LongArray<Long>?`	`getPropertyLongArray(path: String)` Retrieves a repeated `long[]` property by path.
`(Mutable)Set<String!>`	`getPropertyNames()` Returns the names of all properties defined in this document.
`String?`	`getPropertyString(path: String)` Retrieves a `String` property by path.
`Array<String!>?`	`getPropertyStringArray(path: String)` Retrieves a repeated `String` property by path.
`String`	`getSchemaType()` Returns the `AppSearchSchema` type of the `GenericDocument`.
`Int`	`getScore()` Returns the score of the `GenericDocument`.
`Long`	`getTtlMillis()` Returns the TTL (time-to-live) of the `GenericDocument`, in milliseconds.
`Int`	`hashCode()`
`T`	`<T> toDocumentClass(documentClass: Class<T!>)` Converts this GenericDocument into an instance of the provided document class.
`T`	`@ExperimentalAppSearchApi <T> toDocumentClass( documentClass: Class<T!>, documentClassMappingContext: DocumentClassMappingContext )` Converts this GenericDocument into an instance of the provided document class.
`String`	`toString()`

Protected constructors

GenericDocument

Added in 1.1.0-alpha07

protected GenericDocument(document: GenericDocument)

Creates a new GenericDocument from an existing instance.

This method should be only used by constructor of a subclass.

Public functions

equals

fun equals(other: Any?): Boolean

fromDocumentClass

Added in 1.1.0-alpha07

java-static fun fromDocumentClass(document: Any): GenericDocument

Converts an instance of a class annotated with \@Document into an instance of GenericDocument.

Parameters
`document: Any`	An instance of a class annotated with \@`Document`.

Returns
`GenericDocument`	an instance of `GenericDocument` produced by converting `document`.

Throws
`androidx.appsearch.exceptions.AppSearchException`	if no generated conversion class exists on the classpath for the given document class or an unexpected error occurs during conversion.

See also
`GenericDocument`

getCreationTimestampMillis

Added in 1.1.0-alpha07

fun getCreationTimestampMillis(): Long

Returns the creation timestamp of the GenericDocument, in milliseconds.

The value is in the currentTimeMillis time base.

getId

Added in 1.1.0-alpha07

fun getId(): String

Returns the unique identifier of the GenericDocument.

getNamespace

Added in 1.1.0-alpha07

fun getNamespace(): String

Returns the namespace of the GenericDocument.

getProperty

Added in 1.1.0-alpha07

fun getProperty(path: String): Any?

Retrieves the property value with the given path as Object.

A path can be a simple property name, such as those returned by getPropertyNames. It may also be a dot-delimited path through the nested document hierarchy, with nested GenericDocument properties accessed via '.' and repeated properties optionally indexed into via [n].

For example, given the following GenericDocument:

    (Message) {
        from: "sender@example.com"
        to: [{
            name: "Albert Einstein"
            email: "einstein@example.com"
          }, {
            name: "Marie Curie"
            email: "curie@example.com"
          }]
        tags: ["important", "inbox"]
        subject: "Hello"
    }

Here are some example paths and their results:

"from" returns "sender@example.com" as a String array with one element
"to" returns the two nested documents containing contact information as a GenericDocument array with two elements
"to[1]" returns the second nested document containing Marie Curie's contact information as a GenericDocument array with one element
"to[1].email" returns "curie@example.com"
"to[100].email" returns null as this particular document does not have that many elements in its "to" array.
"to.email" aggregates emails across all nested documents that have them, returning ["einstein@example.com", "curie@example.com"] as a String array with two elements.

If you know the expected type of the property you are retrieving, it is recommended to use one of the typed versions of this method instead, such as getPropertyString or getPropertyStringArray.

If the property was assigned as an empty array using one of the Builder#setProperty functions, this method will return an empty array. If no such property exists at all, this method returns null.

Parameters
`path: String`	The path to look for.

Returns
`Any?`	The entry with the given path as an object or `null` if there is no such path. The returned object will be one of the following types: `String[]`, `long[]`, `double[]`, `boolean[]`, `byte[][]`, `GenericDocument[]`.

getPropertyBlobHandle

Added in 1.1.0-alpha07

@ExperimentalAppSearchApi
fun getPropertyBlobHandle(path: String): AppSearchBlobHandle?

Retrieves an AppSearchBlobHandle property by path.

See getProperty for a detailed description of the path syntax.

See openBlobForReadAsync for how to use AppSearchBlobHandle to retrieve blob data.

Parameters
`path: String`	The path to look for.

Returns
`AppSearchBlobHandle?`	The first `AppSearchBlobHandle` associated with the given path or `null` if there is no such value or the value is of a different type.

getPropertyBlobHandleArray

Added in 1.1.0-alpha07

@ExperimentalAppSearchApi
fun getPropertyBlobHandleArray(path: String): Array<AppSearchBlobHandle!>?

Retrieves a repeated AppSearchBlobHandle[] property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via setPropertyBlobHandle, this method returns null.

If it has been set via setPropertyBlobHandle to an empty AppSearchBlobHandle[], this method returns an empty AppSearchBlobHandle[].

Parameters
`path: String`	The path to look for.

Returns
`Array<AppSearchBlobHandle!>?`	The `AppSearchBlobHandle[]` associated with the given path, or `null` if no value is set or the value is of a different type.

getPropertyBoolean

Added in 1.1.0-alpha07

fun getPropertyBoolean(path: String): Boolean

Retrieves a boolean property by path.

See getProperty for a detailed description of the path syntax.

Parameters
`path: String`	The path to look for.

Returns
`Boolean`	The first `boolean` associated with the given path or default value `false` if there is no such value or the value is of a different type.

getPropertyBooleanArray

Added in 1.1.0-alpha07

fun getPropertyBooleanArray(path: String): BooleanArray<Boolean>?

Retrieves a repeated boolean property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via setPropertyBoolean, this method returns null.

If it has been set via setPropertyBoolean to an empty boolean[], this method returns an empty boolean[].

Parameters
`path: String`	The path to look for.

Returns
`BooleanArray<Boolean>?`	The `boolean[]` associated with the given path, or `null` if no value is set or the value is of a different type.

getPropertyBytes

Added in 1.1.0-alpha07

fun getPropertyBytes(path: String): ByteArray<Byte>?

Retrieves a byte[] property by path.

See getProperty for a detailed description of the path syntax.

Parameters
`path: String`	The path to look for.

Returns
`ByteArray<Byte>?`	The first `byte[]` associated with the given path or `null` if there is no such value or the value is of a different type.

getPropertyBytesArray

Added in 1.1.0-alpha07

fun getPropertyBytesArray(path: String): Array<ByteArray<Byte>!>?

Retrieves a byte[][] property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via setPropertyBytes, this method returns null.

If it has been set via setPropertyBytes to an empty byte[][], this method returns an empty byte[][].

Parameters
`path: String`	The path to look for.

Returns
`Array<ByteArray<Byte>!>?`	The `byte[][]` associated with the given path, or `null` if no value is set or the value is of a different type.

getPropertyDocument

Added in 1.1.0-alpha07

fun getPropertyDocument(path: String): GenericDocument?

Retrieves a GenericDocument property by path.

See getProperty for a detailed description of the path syntax.

Parameters
`path: String`	The path to look for.

Returns
`GenericDocument?`	The first `GenericDocument` associated with the given path or `null` if there is no such value or the value is of a different type.

getPropertyDocumentArray

Added in 1.1.0-alpha07

fun getPropertyDocumentArray(path: String): Array<GenericDocument!>?

Retrieves a repeated GenericDocument property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via setPropertyDocument, this method returns null.

If it has been set via setPropertyDocument to an empty GenericDocument[], this method returns an empty GenericDocument[].

Parameters
`path: String`	The path to look for.

Returns
`Array<GenericDocument!>?`	The `GenericDocument`[] associated with the given path, or `null` if no value is set or the value is of a different type.

getPropertyDouble

Added in 1.1.0-alpha07

fun getPropertyDouble(path: String): Double

Retrieves a double property by path.

See getProperty for a detailed description of the path syntax.

Parameters
`path: String`	The path to look for.

Returns
`Double`	The first `double` associated with the given path or default value `0.0` if there is no such value or the value is of a different type.

getPropertyDoubleArray

Added in 1.1.0-alpha07

fun getPropertyDoubleArray(path: String): DoubleArray<Double>?

Retrieves a repeated double property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via setPropertyDouble, this method returns null.

If it has been set via setPropertyDouble to an empty double[], this method returns an empty double[].

Parameters
`path: String`	The path to look for.

Returns
`DoubleArray<Double>?`	The `double[]` associated with the given path, or `null` if no value is set or the value is of a different type.

getPropertyEmbedding

Added in 1.1.0-alpha07

fun getPropertyEmbedding(path: String): EmbeddingVector?

Retrieves an EmbeddingVector property by path.

See getProperty for a detailed description of the path syntax.

Parameters
`path: String`	The path to look for.

Returns
`EmbeddingVector?`	The first `EmbeddingVector[]` associated with the given path or `null` if there is no such value or the value is of a different type.

getPropertyEmbeddingArray

Added in 1.1.0-alpha07

fun getPropertyEmbeddingArray(path: String): Array<EmbeddingVector!>?

Retrieves a repeated EmbeddingVector[] property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via setPropertyEmbedding, this method returns null.

If it has been set via setPropertyEmbedding to an empty EmbeddingVector[], this method returns an empty EmbeddingVector[].

Parameters
`path: String`	The path to look for.

Returns
`Array<EmbeddingVector!>?`	The `EmbeddingVector[]` associated with the given path, or `null` if no value is set or the value is of a different type.

getPropertyLong

Added in 1.1.0-alpha07

fun getPropertyLong(path: String): Long

Retrieves a long property by path.

See getProperty for a detailed description of the path syntax.

Parameters
`path: String`	The path to look for.

Returns
`Long`	The first `long` associated with the given path or default value `0` if there is no such value or the value is of a different type.

getPropertyLongArray

Added in 1.1.0-alpha07

fun getPropertyLongArray(path: String): LongArray<Long>?

Retrieves a repeated long[] property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via setPropertyLong, this method returns null.

If it has been set via setPropertyLong to an empty long[], this method returns an empty long[].

Parameters
`path: String`	The path to look for.

Returns
`LongArray<Long>?`	The `long[]` associated with the given path, or `null` if no value is set or the value is of a different type.

getPropertyNames

Added in 1.1.0-alpha07

fun getPropertyNames(): (Mutable)Set<String!>

Returns the names of all properties defined in this document.

getPropertyString

Added in 1.1.0-alpha07

fun getPropertyString(path: String): String?

Retrieves a String property by path.

See getProperty for a detailed description of the path syntax.

Parameters
`path: String`	The path to look for.

Returns
`String?`	The first `String` associated with the given path or `null` if there is no such value or the value is of a different type.

getPropertyStringArray

Added in 1.1.0-alpha07

fun getPropertyStringArray(path: String): Array<String!>?

Retrieves a repeated String property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via setPropertyString, this method returns null.

If it has been set via setPropertyString to an empty String[], this method returns an empty String[].

Parameters
`path: String`	The path to look for.

Returns
`Array<String!>?`	The `String[]` associated with the given path, or `null` if no value is set or the value is of a different type.

getSchemaType

Added in 1.1.0-alpha07

fun getSchemaType(): String

Returns the AppSearchSchema type of the GenericDocument.

getScore

Added in 1.1.0-alpha07

fun getScore(): Int

Returns the score of the GenericDocument.

The score is a query-independent measure of the document's quality, relative to other GenericDocument objects of the same AppSearchSchema type.

Results may be sorted by score using setRankingStrategy. Documents with higher scores are considered better than documents with lower scores.

Any non-negative integer can be used a score.

getTtlMillis

Added in 1.1.0-alpha07

fun getTtlMillis(): Long

Returns the TTL (time-to-live) of the GenericDocument, in milliseconds.

The TTL is measured against getCreationTimestampMillis. At the timestamp of creationTimestampMillis + ttlMillis, measured in the currentTimeMillis time base, the document will be auto-deleted.

The default value is 0, which means the document is permanent and won't be auto-deleted until the app is uninstalled or removeAsync is called.

hashCode

fun hashCode(): Int

toDocumentClass

Added in 1.1.0-alpha07

fun <T> toDocumentClass(documentClass: Class<T!>): T

Converts this GenericDocument into an instance of the provided document class.

It is the developer's responsibility to ensure the right kind of document class is being supplied here, either by structuring the application code to ensure the document type is known, or by checking the return value of getSchemaType.

Document properties are identified by String names. Any that are found are assigned into fields of the given document class. As such, the most likely outcome of supplying the wrong document class would be an empty or partially populated result.

Parameters
`documentClass: Class<T!>`	a class annotated with `Document`

Returns
`T`	an instance of the document class after being converted from a `GenericDocument`

Throws
`androidx.appsearch.exceptions.AppSearchException`	if no factory for this document class could be found on the classpath.

See also
`fromDocumentClass`

toDocumentClass

Added in 1.1.0-alpha07

@ExperimentalAppSearchApi
fun <T> toDocumentClass(
    documentClass: Class<T!>,
    documentClassMappingContext: DocumentClassMappingContext
): T

Converts this GenericDocument into an instance of the provided document class.

If this GenericDocument's type is recorded as a subtype of the provided documentClass, the method will find an AppSearch document class, using the provided documentClassMappingContext, that is the most concrete and assignable to documentClass, and then deserialize to that class instead. This allows for more specific and accurate deserialization of GenericDocuments. If documentClassMappingContext has information missing or we are not able to find a candidate assignable to documentClass, the method will deserialize to documentClass directly.

Assignability is determined by the programing language's type system, and which type is more concrete is determined by AppSearch's type system specified via addParentType or the annotation parameter parent.

For nested document properties, this method will be called recursively, and documentClassMappingContext will be passed down to the recursive calls of this method.

For most use cases, it is recommended to utilize getDocument instead of calling this method directly. This avoids the need to manually create a DocumentClassMappingContext.

Parameters
`documentClass: Class<T!>`	a class annotated with `Document`
`documentClassMappingContext: DocumentClassMappingContext`	a `DocumentClassMappingContext` instance

Returns
`T`	an instance of the document class after being converted from a `GenericDocument`

Throws
`androidx.appsearch.exceptions.AppSearchException`	if no factory for this document class could be found on the classpath.

See also
`fromDocumentClass`

toString

fun toString(): String

GenericDocument

Summary

Nested types

Protected constructors

Public functions

Protected constructors

GenericDocument

Public functions

equals

fromDocumentClass

getCreationTimestampMillis

getId

getNamespace

getProperty

getPropertyBlobHandle

getPropertyBlobHandleArray

getPropertyBoolean

getPropertyBooleanArray

getPropertyBytes

getPropertyBytesArray

getPropertyDocument

getPropertyDocumentArray

getPropertyDouble

getPropertyDoubleArray

getPropertyEmbedding

getPropertyEmbeddingArray

getPropertyLong

getPropertyLongArray

getPropertyNames

getPropertyString

getPropertyStringArray

getSchemaType

getScore

getTtlMillis

hashCode

toDocumentClass

toDocumentClass

toString