DataObjectMapping

Class DataObjectMapping

Namespace: DataWarehouseAutomation.DwaModel
Assembly: DataWarehouseAutomation.dll

The mapping between a source and target data set / table / file.

The DataObjectMapping is the element that defines an individual source-to-target mapping / ETL process. It is a mapping between a source and target object - referred to as DataObjects. The DataObject is in fact a reusable definition in the Json schema.

This definition is used twice in the DataObjectMapping: as the *SourceDataObjects* and as the *TargetDataObject* - both instances/lists of , implemented as or .

The other key component of a DataObjectMapping is the *DataItemMapping*, which describes the column-to-column (or transformation-to-column). The SourceDataObject, TargetDataObject and DataItemMapping are the mandatory components of a DataObjectMapping.There are many other attributes that can be set, and there are mandatory items within the DataObjects and DataItems.These are all described in the Json schema.

public class DataObjectMapping : IMetadata

Inheritance

object ← DataObjectMapping

Implements

IMetadata

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Properties

BusinessKeyDefinitions

The definition of the Business Key(s) for the Data Object Mapping. The order is stored as well, because in some cases the order of keys is meaningful.

[JsonPropertyName("businessKeyDefinitions")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<(int OrdinalPosition, BusinessKeyDefinition)>? BusinessKeyDefinitions { get; set; }

Property Value

List<(int OrdinalPosition, BusinessKeyDefinition)>?

Classifications

Free-form and optional classification for the mapping for use in data logistics generation logic (evaluation).

[JsonPropertyName("classifications")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<DataClassification>? Classifications { get; set; }

Property Value

List<DataClassification>?

DataItemMappings

The collection of individual attribute (column or query) mappings.

[JsonPropertyName("dataItemMappings")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<DataItemMapping>? DataItemMappings { get; set; }

Property Value

List<DataItemMapping>?

DataItems

The collection of Data Items specifically associated with this Data Object Mapping, used as source/target Data Items/Queries for the mapping or the Mappings BKCM as needed.

[JsonPropertyName("dataItems")]
public List<IDataItem>? DataItems { get; set; }

Property Value

List<IDataItem>?

Enabled

An indicator (boolean) which can capture enabling / disabling of (the usage of) an individual source-to-target mapping.

[JsonPropertyName("enabled")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? Enabled { get; set; }

Property Value

bool?

Extensions

The collection of extension Key/Value pairs.

[JsonPropertyName("extensions")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<Extension>? Extensions { get; set; }

Property Value

List<Extension>?

FilterCriterion

Any filtering that needs to be applied to the source-to-target mapping.

[JsonPropertyName("filterCriterion")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? FilterCriterion { get; set; }

Property Value

string?

Id

An optional unique identifier for the Data Object mapping.

[JsonPropertyName("id")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Id { get; set; }

Property Value

string?

Json

Get the standard Json representation

[JsonIgnore(Condition = JsonIgnoreCondition.Always)]
public string Json { get; }

Property Value

string

Name

The name of the Data Object Mapping. Ideally an unique name that identifies the individual mapping.

[JsonPropertyName("name")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
public string Name { get; set; }

Property Value

string

Notes

Free-format notes on the Data Object Mapping.

[JsonPropertyName("notes")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Notes { get; set; }

Property Value

string?

Relationships

The collection of associated data object for purposes other than source-target relationship. For example for lookups, merge joins, lineage etc.

[JsonPropertyName("relationships")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public List<(int OrdinalPosition, Relationship)>? Relationships { get; set; }

Property Value

List<(int OrdinalPosition, Relationship)>?

SourceDataObjects

The source object(s) of the mapping. This can either be an object or a query. Potentially multiple source objects can be mapped to a single target object.

[JsonPropertyName("sourceDataObjects")]
public List<IDataObject> SourceDataObjects { get; set; }

Property Value

List<IDataObject>

TargetDataObject

The target object of the mapping. This is always a Data Object type.

[JsonPropertyName("targetDataObject")]
public IDataObject TargetDataObject { get; set; }

Property Value

IDataObject

Methods

Equals(object?)

Use this method to assert if two Data Object Mappings are the same, based on their Ids.

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

True if the Data Object Mappings are the same, based on their Ids

GetHashCode()

Override to get a hash value that represents the identifier.

public override int GetHashCode()

Returns

int

A 32-bit signed integer hash code

ToString()

String override so that the object returns its value (‘Name’). When an instance of this class is passed to a method that expects a string, the ToString() method will be called implicitly to convert the object to a string, and the value of the “Name” property will be returned.

public override string ToString()

Returns

string

The Name