Class ArtifactFileAnnotation

Namespace: Workspace.XBR.Xperiflow.Routines.Artifacts

Assembly: Xperiflow.dll

Declaration

public class ArtifactFileAnnotation

Properties

FileAnnotation

The file annotation key. This is a human-readable identifier for the file that comes with its own syntax.

Declaration

public string FileAnnotation { get; set; }

Description

The file annotation description. This is a human-readable description for the file.

Declaration

public string Description { get; set; }

Methods

GetRelativeFileAnnotation()

Gets the relative file annotation.

Example 1:

var annotation = new ArtifactFileAnnotation
{
    FileAnnotation = "artifacts_/@concat_str/data_/string.txt"
};
var result = annotation.GetRelativeFileAnnotation();
// result == "string.txt"

Example 2:

var annotation = new ArtifactFileAnnotation
{
    FileAnnotation = "artifacts_/@dataframe/data_/data_.parquet"
};
var result = annotation.GetRelativeFileAnnotation();
// result == "data_.parquet"

Declaration

public string GetRelativeFileAnnotation()

Returns

System.String

The relative file annotation.

GetPathExtendedSuffix()

Get the extended suffix of the file annotation. See Workspace.XBR.Xperiflow.MetaFileSystem.MetaFilePathUtil.GetPathExtendedSuffix(System.String%2cSystem.Boolean) for more information.

Declaration

public string GetPathExtendedSuffix()

Returns

System.String

HasAnnotationWildCardVariables()

Whether or not the file annotation contains any wildcard variables. This also implies if it is a multi-file annotation.

Declaration

public bool HasAnnotationWildCardVariables()

Returns

System.Boolean

IsFileAnnotationMatch(string)

Declaration

public bool IsFileAnnotationMatch(string fileName)

Returns

System.Boolean

Parameters

Type	Name
System.String	fileName

GetFilteredMatchingRelativeFileNames(List<string>)

Get the matching filtered file names based on the relative file annotation.

Declaration

public List<string> GetFilteredMatchingRelativeFileNames(List<string> fileNames)

Returns

System.Collections.Generic.List<System.String>

Parameters

Type	Name
System.Collections.Generic.List<System.String>	fileNames

Inherited Members

• System.Object.Equals(System.Object)
• System.Object.Equals(System.Object,System.Object)
• System.Object.GetHashCode
• System.Object.GetType
• System.Object.MemberwiseClone
• System.Object.ReferenceEquals(System.Object,System.Object)
• System.Object.ToString