Table of Contents

Class AdapterFinding

Namespace
MES.MQC.DataSourceLibrary.Models.Adapters
Assembly
MES.MQC.DataSourceLibrary.dll

The AdapterFinding class contains the data for one data item to be imported. Each Adapter returns a List of with objects of this class on execution with the Read method.

public class AdapterFinding : AdapterDataBase
Inheritance
AdapterFinding
Inherited Members

Properties

ArtifactInnerPath

Artifact Inner Path of the Finding.

public string[] ArtifactInnerPath { get; set; }

Property Value

string[]

DataDateTime

Date of the report.

public DateTime? DataDateTime { get; set; }

Property Value

DateTime?

Description

Description of the Finding (contains information what the finding is about).

public string Description { get; set; }

Property Value

string

HumanReadableAnchor

Anchor of the related human readable html file.

public string HumanReadableAnchor { get; set; }

Property Value

string

HumanReadableFilePath

Human readable html file if different from the data.

public string HumanReadableFilePath { get; set; }

Property Value

string

IssueMessage

Issue Message of the Finding (contains the problem).

public string IssueMessage { get; set; }

Property Value

string

Measure

Measure of the Finding (e.g. Result, Coverage of Testcases).

public string Measure { get; set; }

Property Value

string

MeasurementName

Name of Measurement, used to replace ${MeasurementName} in FindingStructure and FindingStructureForArtifact (after verified with adapter options).

public string MeasurementName { get; set; }

Property Value

string

State

State of the Finding (e.g. Warning, Failed).

public string State { get; set; }

Property Value

string

SubjectName

Subject Name of the Finding.

public string SubjectName { get; set; }

Property Value

string

SubjectPath

Subject Path of the Finding.

public string[] SubjectPath { get; set; }

Property Value

string[]

SubjectPathForArtifact

Subject Path of the Finding specific only for one artifact.

public string[] SubjectPathForArtifact { get; set; }

Property Value

string[]

SubjectType

Subject Type of the Finding (e.g. Requirement, Testcase, Check).

public string SubjectType { get; set; }

Property Value

string

Methods

AddData(AdapterData)

Add an adapterData entry to create a relation.

public void AddData(AdapterData data)

Parameters

data AdapterData

AdapterData

AddData(IEnumerable<AdapterData>)

Add multiple adapterData entries to create relations.

public void AddData(IEnumerable<AdapterData> data)

Parameters

data IEnumerable<AdapterData>

Array of AdapterData

AddRelation(AdapterFinding, string)

Add an adapterFinding entry to create a relation.

public void AddRelation(AdapterFinding finding, string result = null)

Parameters

finding AdapterFinding

AdapterFinding

result string

Result of the Relation

AddRelation(IEnumerable<AdapterFinding>, string)

Add multiple adapterFinding entries to create relations.

public void AddRelation(IEnumerable<AdapterFinding> findings, string result = null)

Parameters

findings IEnumerable<AdapterFinding>

Array of AdapterFinding

result string

Result of the Relation

CreateNew(string, string, DateTime?, string, string, string[], string[], string[], string, string, string, string, string, string, string, DateTime?)

Create a new finding based on the current finding. Arguments are optional and can provide different values for some properties.

public AdapterFinding CreateNew(string type = null, string measure = null, DateTime? dateTime = null, string dataSourceName = null, string artifactPath = null, string[] artifactInnerPath = null, string[] subjectPath = null, string[] subjectPathForArtifact = null, string state = null, string subjectName = null, string description = null, string issueMessage = null, string humanReadableFilePath = null, string humanReadableAnchor = null, string measurementName = null, DateTime? dataDateTime = null)

Parameters

type string

Type for the new Finding

measure string

Measure for the new Finding

dateTime DateTime?

DateTime for the new Finding

dataSourceName string

DataSourceName for the new Finding

artifactPath string

ArtifactPath for the new Finding

artifactInnerPath string[]

ArtifactInnerPath for the new Finding

subjectPath string[]

SubjectPath for the new Finding

subjectPathForArtifact string[]

SubjectPathForArtifact for the new Finding

state string

State for the new Finding

subjectName string

SubjectName for the new Finding

description string

Description for the new Finding

issueMessage string

IssueMessage for the new Finding

humanReadableFilePath string

HumanReadableFilePath for the new Finding

humanReadableAnchor string

HumanReadableAnchor for the new Finding

measurementName string

MeasurementName for the new Finding

dataDateTime DateTime?

DataDateTime for the new Finding

Returns

AdapterFinding

AdapterFinding (a new object)