Skip to main content

Interface IArtifactReader<T>

Interface for classes that read data from storage into an object of type T

Namespace: Workspace.XBR.Xperiflow.Routines.Io

Assembly: Xperiflow.dll

Declaration
public interface IArtifactReader<T>

Derived: Workspace.XBR.Xperiflow.Routines.Io.DataTableParquetArtifactReader, Workspace.XBR.Xperiflow.Routines.Io.JsonArtifactReader, Workspace.XBR.Xperiflow.Routines.Io.StringTextArtifactReader, Workspace.XBR.Xperiflow.Routines.Io.WebAppArtifactReader

Methods​

IsApplicable(List<ArtifactFileAnnotation>)​

Determine whether or not this Artifact Reader is applicable to the given artifact file annotations.

Declaration
bool IsApplicable(List<ArtifactFileAnnotation> artifactFileAnnotations)
Returns​

System.Boolean

Parameters​
TypeNameDescription
System.Collections.Generic.List< Workspace.XBR.Xperiflow.Routines.Artifacts.ArtifactFileAnnotation >artifactFileAnnotationsThe file annotation protocol as defined by the Routine system.

Read(IMetaFileSystemClient, string, List<ArtifactFileAnnotation>)​

Read the data from storage into an object of type T

Declaration
T Read(IMetaFileSystemClient metaFileSystemClient, string dirpath, List<ArtifactFileAnnotation> artifactFileAnnotations)
Returns​

<T>

The object of type T that was read from storage.

Parameters​
TypeNameDescription
Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemClientmetaFileSystemClientThe client to use to read the data from storage.
System.StringdirpathThe path to the directory containing the data to read.
System.Collections.Generic.List< Workspace.XBR.Xperiflow.Routines.Artifacts.ArtifactFileAnnotation >artifactFileAnnotationsThe annotations from the Routine system that describe the artifact files to read.

Was this page helpful?