Class DirectoryDataInstallerBase
Base class for directory-based data installers.
Inherited Members
Namespace: Kephas.Data.IO.Setup
Assembly: Kephas.Data.IO.dll
Syntax
public abstract class DirectoryDataInstallerBase : DataIOInstallerBase, ILoggable, IDataInstaller
Constructors
| Improve this Doc View SourceDirectoryDataInstallerBase(IDataImportService, IExportFactory<IDataSpace>, String)
Initializes a new instance of the DirectoryDataInstallerBase class.
Declaration
protected DirectoryDataInstallerBase(IDataImportService dataImportService, IExportFactory<IDataSpace> dataSpaceFactory, string dataPath)
Parameters
Type | Name | Description |
---|---|---|
IDataImportService | dataImportService | The data import service. |
IExportFactory<IDataSpace> | dataSpaceFactory | The data space factory. |
System.String | dataPath | The full pathname of the location containing the data files. |
Properties
| Improve this Doc View SourceDataPath
Gets the full pathname of the data file.
Declaration
public string DataPath { get; }
Property Value
Type | Description |
---|---|
System.String | The full pathname of the data file. |
Methods
| Improve this Doc View SourceGetDataFilePaths(String, IEnumerable<String>)
Gets the data files to be imported for the provided operation namespace.
Declaration
protected virtual IEnumerable<string> GetDataFilePaths(string operationPath, IEnumerable<string> fileNames)
Parameters
Type | Name | Description |
---|---|---|
System.String | operationPath | The operation relative path. |
System.Collections.Generic.IEnumerable<System.String> | fileNames | List of names of the files. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | An enumeration of file paths. |
GetDataFilePatterns()
Gets the patterns for the data files.
Declaration
protected virtual IEnumerable<string> GetDataFilePatterns()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | An enumeration of data file pattern strings. |
GetInstallDataFileNames()
Gets the file names of the data to be installed.
Declaration
protected virtual IEnumerable<string> GetInstallDataFileNames()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | An enumeration of file names. |
Remarks
When overridden in a derived class, the file names should not contain the resource namespace, because it will be prepended by the GetInstallDataFilePaths(). Also, the file names should be provided in the right order for the import.
GetInstallDataFilePaths()
Gets the files for the data to be installed.
Declaration
protected override IEnumerable<string> GetInstallDataFilePaths()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | An enumeration of file paths. |
Overrides
| Improve this Doc View SourceGetUninstallDataFileNames()
Gets the data file names of the data to be uninstalled.
Declaration
protected virtual IEnumerable<string> GetUninstallDataFileNames()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | An enumeration of file names. |
Remarks
When overridden in a derived class, the file names should not contain the resource namespace, because it will be prepended by the GetInstallDataFilePaths(). Also, the file names should be provided in the right order for the import.
GetUninstallDataFilePaths()
Gets the files for the data to be uninstalled.
Declaration
protected override IEnumerable<string> GetUninstallDataFilePaths()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | An enumeration of file paths. |