ndb-core documentation
  1. Injectables
  2. UpdateMetadataDatatype

File

src/app/core/entity/model/update-metadata.datatype.ts

Description

Datatype for internally saved meta-data of entity edits.

Extends

SchemaEmbedDatatype

Index

Properties
Methods

Methods

transformToDatabaseFormat
transformToDatabaseFormat(value: EntityType, schemaField?: EntitySchemaField)
Inherited from DefaultDatatype
Defined in DefaultDatatype:92
Parameters :
Name Type Optional
value EntityType No
schemaField EntitySchemaField Yes
Returns : DBType
transformToObjectFormat
transformToObjectFormat(value: DBType, schemaField?: EntitySchemaField)
Inherited from DefaultDatatype
Defined in DefaultDatatype:103
Parameters :
Name Type Optional
value DBType No
schemaField EntitySchemaField Yes
Returns : EntityType
Async anonymize
anonymize(value: EntityType, schemaField: EntitySchemaField, parent: any)
Inherited from DefaultDatatype
Defined in DefaultDatatype:190

(Partially) anonymize to "retain-anonymized" for reporting purposes without personal identifiable information.

Parameters :
Name Type Optional Description
value EntityType No

The original value to be anonymized
schemaField EntitySchemaField No
parent any No
Returns : Promise<any>
Static detectFieldInEntity
detectFieldInEntity(entityOrType: Entity | EntityConstructor, dataTypes: string | string[])
Inherited from DefaultDatatype
Defined in DefaultDatatype:57

Detect the first field of the given datatype(s) in an entity's schema.

Scans the schema for a field whose dataType matches one of the provided strings and returns its property name.

Subclasses typically override this without the extra dataTypes parameter, forwarding their own relevant datatype identifiers.

Parameters :
Name Type Optional Description
entityOrType Entity | EntityConstructor No

An entity instance or entity constructor to inspect.
dataTypes string | string[] No

One or more datatype identifiers to match against.
Returns : string | undefined

The field name of the first matching field, or undefined if none is found.
importIncompleteAdditionalConfigBadge
importIncompleteAdditionalConfigBadge(col: ColumnMapping)
Inherited from DefaultDatatype
Defined in DefaultDatatype:166

Output a label indicating whether the given column mapping needs user configuration for the "additional" config or has a valid, complete "additional" config. returns "undefined" if no user action is required.

Parameters :
Name Type Optional
col ColumnMapping No
Returns : string
Async importMapFunction
importMapFunction(val: any, schemaField: EntitySchemaField, additional?: any, importProcessingContext?: any)
Inherited from DefaultDatatype
Defined in DefaultDatatype:145

The function used to map values from the import data to values in the entities to be created. to share information across processing of multiple columns and rows.

Parameters :
Name Type Optional Description
val any No

The value from an imported cell to be mapped
schemaField EntitySchemaField No

The schema field definition for the target property into which the value is mapped
additional any Yes

config as returned by the configComponent
importProcessingContext any Yes

an object that the datatype can use to store any relevant context across multiple calls to share information across processing of multiple columns and rows.
Returns : Promise<EntityType>
normalizeSchemaField
normalizeSchemaField(schemaField: EntitySchemaField)
Inherited from DefaultDatatype
Defined in DefaultDatatype:182

Return the (potentially adjusted) schema field for this datatype.

Called when schema fields are set up (e.g. from config), allowing the datatype to normalize or fill in required settings.

Override this in a subclass to enforce constraints (e.g. always setting isArray: true).

Parameters :
Name Type Optional Description
schemaField EntitySchemaField No

The current schema field definition
Returns : EntitySchemaField

The schema field to use (default: unchanged)

Properties

Static dataType
Type : unknown
Default value : UpdateMetadata.DATA_TYPE
Inherited from DefaultDatatype
Defined in DefaultDatatype:10
embeddedType
Type : unknown
Default value : UpdateMetadata
Inherited from SchemaEmbedDatatype
Defined in SchemaEmbedDatatype:12
Protected Readonly schemaService
Type : unknown
Default value : inject(EntitySchemaService)
Inherited from SchemaEmbedDatatype
Defined in SchemaEmbedDatatype:70
editComponent
Type : string
Default value : "EditText"
Inherited from DefaultDatatype
Defined in DefaultDatatype:101
Readonly importAllowsMultiMapping
Type : boolean
Default value : false
Inherited from DefaultDatatype
Defined in DefaultDatatype:80

Whether this datatype allows multiple values to be mapped to the same entity field during import.
Optional importConfigComponent
Type : string
Inherited from DefaultDatatype
Defined in DefaultDatatype:158

A component to be display as a dialog to configure the transformation function (e.g. defining a format or mapping)
Static label
Type : string
Default value : $localize`:datatype-label:any`
Inherited from DefaultDatatype
Defined in DefaultDatatype:89

The human-readable name for this dataType, used in config UIs.
viewComponent
Type : string
Default value : "DisplayText"
Inherited from DefaultDatatype
Defined in DefaultDatatype:100

The default component how this datatype should be displayed in lists and forms.

The edit component has to be a registered component. Components that are registered contain the DynamicComponent decorator

 
import { UpdateMetadata } from "./update-metadata";
import { SchemaEmbedDatatype } from "../../basic-datatypes/schema-embed/schema-embed.datatype";
import { Injectable } from "@angular/core";

/**
 * Datatype for internally saved meta-data of entity edits.
 */
@Injectable()
export class UpdateMetadataDatatype extends SchemaEmbedDatatype {
  static override dataType = UpdateMetadata.DATA_TYPE;

  override embeddedType = UpdateMetadata;
}

results matching ""

    No results matching ""