Class DataIOInstallerBase

An initial data i/o handler base.

Inheritance

System.Object

Loggable

DataIOInstallerBase

AssemblyEmbeddedResourcesDataInstallerBase

DirectoryDataInstallerBase

Implements

ILoggable

IDataInstaller

Inherited Members

Loggable.Logger

Loggable.GetLogger()

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()

Namespace: Kephas.Data.IO.Setup

Assembly: Kephas.Data.IO.dll

Syntax

public abstract class DataIOInstallerBase : Loggable, ILoggable, IDataInstaller

Constructors

| Improve this Doc View Source

DataIOInstallerBase(IDataImportService, IExportFactory<IDataSpace>)

Initializes a new instance of the DataIOInstallerBase class.

Declaration

protected DataIOInstallerBase(IDataImportService dataImportService, IExportFactory<IDataSpace> dataSpaceFactory)

Parameters

Type	Name	Description
IDataImportService	dataImportService	The data import service.
IExportFactory<IDataSpace>	dataSpaceFactory	The data space factory.

Properties

| Improve this Doc View Source

DataImportService

Gets the data import service.

Declaration

public IDataImportService DataImportService { get; }

Property Value

Type	Description
IDataImportService	The data import service.

| Improve this Doc View Source

DataSpaceFactory

Gets the data space factory.

Declaration

public IExportFactory<IDataSpace> DataSpaceFactory { get; }

Property Value

Type	Description
IExportFactory<IDataSpace>	The data space factory.

Methods

| Improve this Doc View Source

CreateDataImportContext(IDataSetupContext, IDataSpace)

Creates the data import context.

Declaration

protected virtual IDataImportContext CreateDataImportContext(IDataSetupContext dataSetupContext, IDataSpace dataSpace)

Parameters

Type	Name	Description
IDataSetupContext	dataSetupContext	Context for the initial data.
IDataSpace	dataSpace	The data space.

Returns

Type	Description
IDataImportContext	The new data import context.

| Improve this Doc View Source

CreateDataSource(String)

Creates a data source for the import operation.

Declaration

protected virtual DataStream CreateDataSource(string dataFilePath)

Parameters

Type	Name	Description
System.String	dataFilePath	The data file path.

Returns

Type	Description
DataStream	The new data source.

| Improve this Doc View Source

GetInstallDataFilePaths()

Gets the files containing data to be installed.

Declaration

protected virtual IEnumerable<string> GetInstallDataFilePaths()

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>	An enumeration of file paths.

| Improve this Doc View Source

GetUninstallDataFilePaths()

Gets the files containing data to be uninstalled.

Declaration

protected virtual IEnumerable<string> GetUninstallDataFilePaths()

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>	An enumeration of file paths. collection.

| Improve this Doc View Source

ImportDataAsync(IDataSetupContext, IEnumerable<String>, CancellationToken)

Imports the data contained in the provided files asynchronously.

Declaration

protected virtual Task<IOperationResult> ImportDataAsync(IDataSetupContext dataSetupContext, IEnumerable<string> dataFilePaths, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IDataSetupContext	dataSetupContext	Context for the initial data.
System.Collections.Generic.IEnumerable<System.String>	dataFilePaths	The data file paths.
System.Threading.CancellationToken	cancellationToken	Optional. The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IOperationResult>	An asynchronous result returning the data setup result.

| Improve this Doc View Source

ImportDataFileAsync(IDataSetupContext, String, CancellationToken)

Import data file asynchronously.

Declaration

protected virtual Task<IOperationResult> ImportDataFileAsync(IDataSetupContext dataSetupContext, string dataFilePath, CancellationToken cancellationToken)

Parameters

Type	Name	Description
IDataSetupContext	dataSetupContext	Context for the initial data.
System.String	dataFilePath	The data file path.
System.Threading.CancellationToken	cancellationToken	The cancellation token (optional).

Returns

Type	Description
System.Threading.Tasks.Task<IOperationResult>	The asynchronous result returning the data import result.

| Improve this Doc View Source

InstallDataAsync(IDataSetupContext, CancellationToken)

Installs the data asynchronously.

Declaration

public virtual Task<IOperationResult> InstallDataAsync(IDataSetupContext dataSetupContext, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IDataSetupContext	dataSetupContext	Context for the data setup.
System.Threading.CancellationToken	cancellationToken	Optional. The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IOperationResult>	An asynchronous result returning the data creation result.

| Improve this Doc View Source

UninstallDataAsync(IDataSetupContext, CancellationToken)

Uninstalls the data asynchronously.

Declaration

public virtual Task<IOperationResult> UninstallDataAsync(IDataSetupContext dataSetupContext, CancellationToken cancellationToken = default(CancellationToken))