DocumentClassFactory


public interface DocumentClassFactory<T>


An interface for factories which can convert between instances of classes annotated with \@androidx.appsearch.annotation.Document and instances of GenericDocument.

Parameters
<T>

The document class type this factory converts to and from GenericDocument.

Summary

Public methods

abstract @NonNull T
fromGenericDocument(
    @NonNull GenericDocument genericDoc,
    @Nullable Map<StringList<String>> documentClassMap
)

Converts a androidx.appsearch.app.GenericDocument into an instance of the document class.

abstract @NonNull List<Class<Object>>

Returns document classes that this document class depends on.

abstract @NonNull AppSearchSchema

Returns the schema for this document class.

abstract @NonNull String

Returns the name of this schema type, e.g.

abstract @NonNull GenericDocument

Converts an instance of the class annotated with \@androidx.appsearch.annotation.Document into a androidx.appsearch.app.GenericDocument.

Public methods

fromGenericDocument

Added in 1.1.0-alpha06
abstract @NonNullfromGenericDocument(
    @NonNull GenericDocument genericDoc,
    @Nullable Map<StringList<String>> documentClassMap
)

Converts a androidx.appsearch.app.GenericDocument into an instance of the document class. For nested document properties, this method should pass documentClassMap down to the nested calls of toDocumentClass.

getDependencyDocumentClasses

Added in 1.1.0-alpha06
abstract @NonNull List<Class<Object>> getDependencyDocumentClasses()

Returns document classes that this document class depends on. This is useful so clients are not required to explicitly set all dependencies.

getSchema

Added in 1.1.0-alpha06
abstract @NonNull AppSearchSchema getSchema()

Returns the schema for this document class.

getSchemaName

Added in 1.1.0-alpha06
abstract @NonNull String getSchemaName()

Returns the name of this schema type, e.g. Email.

This is the name used in queries for type restricts.

toGenericDocument

Added in 1.1.0-alpha06
abstract @NonNull GenericDocument toGenericDocument(@NonNull T document)

Converts an instance of the class annotated with \@androidx.appsearch.annotation.Document into a androidx.appsearch.app.GenericDocument.