Interface IDataImporter
Provides an extension point for addins to implement data importers.
Namespace: Algenta.Colectica.ViewModel.Import
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public interface IDataImporterProperties
DefaultExtension
Gets the default file extension to display when prompting for a file.
Declaration
string DefaultExtension { get; }Property Value
| Type | Description |
|---|---|
| System.String |
FileFilter
Gets the file filter to display when prompting for a file.
Declaration
string FileFilter { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Name
Gets the name of the importer.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
SupportsColumnDataTypes
Gets a value indicating whether the importer can provide information about the type of each column.
Declaration
bool SupportsColumnDataTypes { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
SupportsSingleColumnStreaming
Gets a value indicating whether this importer supports streaming one column of data at a time.
If true, use GetDataReader and MoveDataReaderToBegininning.
If false, use GetDataSet to read the full data set.
Declaration
bool SupportsSingleColumnStreaming { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Weight
Gets the weight of the importer. This is used to determine the order in which the importer is displayed in the user interface.
Declaration
int Weight { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
AreSystemRequirementsSatisfied(out String)
Determines system requirements necessary for the importer to function are in place.
Declaration
bool AreSystemRequirementsSatisfied(out string message)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | message | A message describing what requirements are missing. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
|
CanImportDataSource(String)
Determines whether the specified data source can be imported by the addin.
Declaration
bool CanImportDataSource(string path)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | The full path or connection string of the data source to be imported. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
|
GetDataReader(String)
Gets an IDataReader for the specified data source.
Declaration
IDataReader GetDataReader(string path)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | The path or connection string of the data source to be imported. |
Returns
| Type | Description |
|---|---|
| IDataReader | An |
GetDataSet(String)
Gets the DataSet from the specified data source.
Declaration
DataSet GetDataSet(string path)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | The path or connection string of the data source to be imported. |
Returns
| Type | Description |
|---|---|
| DataSet |
Import(String, String)
Imports the specified data source.
Declaration
ResourcePackage Import(string path, string agencyId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path | The path or connection string of the data source to be imported. |
| System.String | agencyId | The agency identifier to be assigned to newly created items. |
Returns
| Type | Description |
|---|---|
| ResourcePackage | A |
MoveDataReaderToBeginning(IDataReader)
Moves the data reader to the beginning of the stream.
Declaration
void MoveDataReaderToBeginning(IDataReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| IDataReader | reader | The data reader to move to the beginning of the stream. |