DocumentClassFactory
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 |
Summary
Public functions |
|
|---|---|
T |
@ExperimentalAppSearchApiConverts a |
(Mutable)List<Class<Any!>!> |
Returns document classes that this document class depends on. |
AppSearchSchema |
Returns the schema for this document class. |
String |
Returns the name of this schema type, e.g. |
GenericDocument |
toGenericDocument(document: T)Converts an instance of the class annotated with \@ |
Public functions
fromGenericDocument
@ExperimentalAppSearchApi
fun fromGenericDocument(
genericDoc: GenericDocument,
documentClassMappingContext: DocumentClassMappingContext
): T
Converts a androidx.appsearch.app.GenericDocument into an instance of the document class. For nested document properties, this method should pass documentClassMappingContext down to the nested calls of toDocumentClass.
| Parameters | |
|---|---|
genericDoc: GenericDocument |
The document to convert. |
documentClassMappingContext: DocumentClassMappingContext |
The context object that holds mapping information for document classes and their parent types. This context typically comes from |
getDependencyDocumentClasses
fun getDependencyDocumentClasses(): (Mutable)List<Class<Any!>!>
Returns document classes that this document class depends on. This is useful so clients are not required to explicitly set all dependencies.
getSchema
fun getSchema(): AppSearchSchema
Returns the schema for this document class.
getSchemaName
fun getSchemaName(): String
Returns the name of this schema type, e.g. Email.
This is the name used in queries for type restricts.
toGenericDocument
fun toGenericDocument(document: T): GenericDocument
Converts an instance of the class annotated with \@androidx.appsearch.annotation.Document into a androidx.appsearch.app.GenericDocument.