Class ImportEngine

Inheritance

System.Object

ImportEngine

CSVImportEngine

ExcelImportEngine

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: TimeCockpit.Data.Import

Assembly: TimeCockpit.Data.Import.dll

Syntax

public abstract class ImportEngine

Constructors

ImportEngine(DataContext)

Declaration

public ImportEngine(DataContext dataContext)

Parameters

Type	Name	Description
DataContext	dataContext

Properties

CurrentRowCount

Declaration

public abstract int CurrentRowCount { get; }

Property Value

Type	Description
System.Int32

DataContext

Declaration

public DataContext DataContext { get; }

Property Value

Type	Description
DataContext

DefinitionName

Declaration

public string DefinitionName { get; set; }

Property Value

Type	Description
System.String

MessageCount

Declaration

public int MessageCount { get; }

Property Value

Type	Description
System.Int32

OriginalSource

Declaration

public byte[] OriginalSource { get; set; }

Property Value

Type	Description
System.Byte[]

SourceFileName

Declaration

public string SourceFileName { get; set; }

Property Value

Type	Description
System.String

Methods

AddMessage(Exception)

Declaration

protected void AddMessage(Exception e)

Parameters

Type	Name	Description
System.Exception	e

AddMessage(ImportMessage.Kind, String)

Declaration

protected void AddMessage(ImportMessage.Kind kind, string message)

Parameters

Type	Name	Description
ImportMessage.Kind	kind
System.String	message

FetchUpdateKeys(ImportColumnDefinition[], ModelEntityBase, Int32)

Declaration

protected abstract Dictionary<int, string> FetchUpdateKeys(ImportColumnDefinition[] keyColumns, ModelEntityBase targetEntity, int defaultHeaderRowNumber)

Parameters

Type	Name	Description
ImportColumnDefinition[]	keyColumns
ModelEntityBase	targetEntity
System.Int32	defaultHeaderRowNumber

Returns

Type	Description
System.Collections.Generic.Dictionary<System.Int32, System.String>

FormatStatusMessage(Int32, Boolean)

Declaration

public static string FormatStatusMessage(int messageCount, bool cancelled)

Parameters

Type	Name	Description
System.Int32	messageCount
System.Boolean	cancelled

Returns

Type	Description
System.String

GetCellKeyValue(ImportColumnDefinition)

Declaration

public abstract object GetCellKeyValue(ImportColumnDefinition column)

Parameters

Type	Name	Description
ImportColumnDefinition	column

Returns

Type	Description
System.Object

GetCellValue(ImportColumnDefinition)

Declaration

public abstract object GetCellValue(ImportColumnDefinition column)

Parameters

Type	Name	Description
ImportColumnDefinition	column

Returns

Type	Description
System.Object

GetCellValueBoolean(Object, out Boolean)

Declaration

protected virtual bool GetCellValueBoolean(object cellValue, out bool b)

Parameters

Type	Name	Description
System.Object	cellValue
System.Boolean	b

Returns

Type	Description
System.Boolean

GetCellValueDateTime(Object, out DateTime)

Declaration

protected virtual bool GetCellValueDateTime(object cellValue, out DateTime dt)

Parameters

Type	Name	Description
System.Object	cellValue
System.DateTime	dt

Returns

Type	Description
System.Boolean

GetCellValueDecimal(Object, out Decimal)

Declaration

protected virtual bool GetCellValueDecimal(object cellValue, out decimal d)

Parameters

Type	Name	Description
System.Object	cellValue
System.Decimal	d

Returns

Type	Description
System.Boolean

GetCellValueGuid(Object, out Guid)

Declaration

protected virtual bool GetCellValueGuid(object cellValue, out Guid g)

Parameters

Type	Name	Description
System.Object	cellValue
System.Guid	g

Returns

Type	Description
System.Boolean

GetCellValueString(Object, out String)

Declaration

protected virtual bool GetCellValueString(object cellValue, out string s)

Parameters

Type	Name	Description
System.Object	cellValue
System.String	s

Returns

Type	Description
System.Boolean

GetKeyValue(DataContext, ModelEntityBase, Dictionary<ImportColumnDefinition, Int32>, ImportColumnDefinition, Dictionary<ImportColumnDefinition, ModelProperty>, Object)

Declaration

protected string GetKeyValue(DataContext dataContext, ModelEntityBase targetEntity, Dictionary<ImportColumnDefinition, int> numbers, ImportColumnDefinition kc, Dictionary<ImportColumnDefinition, ModelProperty> properties, object keyValue)

Parameters

Type	Name	Description
DataContext	dataContext
ModelEntityBase	targetEntity
System.Collections.Generic.Dictionary<ImportColumnDefinition, System.Int32>	numbers
ImportColumnDefinition	kc
System.Collections.Generic.Dictionary<ImportColumnDefinition, ModelProperty>	properties
System.Object	keyValue

Returns

Type	Description
System.String

GetReportData()

Declaration

public abstract byte[] GetReportData()

Returns

Type	Description
System.Byte[]

GetReportMetadata(String, DateTime, out String, out String)

Declaration

public virtual void GetReportMetadata(string definitionName, DateTime exportTimestamp, out string filename, out string mimeType)

Parameters

Type	Name	Description
System.String	definitionName
System.DateTime	exportTimestamp
System.String	filename
System.String	mimeType

GetSourceMetadata(out String, out String)

Declaration

public abstract void GetSourceMetadata(out string filename, out string mimeType)

Parameters

Type	Name	Description
System.String	filename
System.String	mimeType

HasMoreRows()

Declaration

public abstract bool HasMoreRows()

Returns

Type	Description
System.Boolean

ImportColumn(ImportColumnDefinition, Object, EntityObject, Boolean)

Declaration

protected virtual void ImportColumn(ImportColumnDefinition column, object cellValue, EntityObject target, bool includeAllinRelations)

Parameters

Type	Name	Description
ImportColumnDefinition	column
System.Object	cellValue
EntityObject	target
System.Boolean	includeAllinRelations

ImportRow(ImportColumnDefinition[], EntityObject, Boolean)

Declaration

public void ImportRow(ImportColumnDefinition[] columns, EntityObject target, bool includeAllinRelations)

Parameters

Type	Name	Description
ImportColumnDefinition[]	columns
EntityObject	target
System.Boolean	includeAllinRelations

ImportSheet(ImportSheetDefinition)

Declaration

public void ImportSheet(ImportSheetDefinition sheetDefinition)

Parameters

Type	Name	Description
ImportSheetDefinition	sheetDefinition

IsCellEmpty(Object)

Declaration

protected virtual bool IsCellEmpty(object cellValue)

Parameters

Type	Name	Description
System.Object	cellValue

Returns

Type	Description
System.Boolean

LoadPreviewData(Int32, Byte[], Dictionary<String, Int32>, Int32)

Declaration

public abstract PreviewWorkbook LoadPreviewData(int sampleSize, byte[] sourceData, Dictionary<string, int> headerRowPosition = null, int defaultHeaderRowNumber = 1)

Parameters

Type	Name	Description
System.Int32	sampleSize
System.Byte[]	sourceData
System.Collections.Generic.Dictionary<System.String, System.Int32>	headerRowPosition
System.Int32	defaultHeaderRowNumber

Returns

Type	Description
PreviewWorkbook

MoveToNextRow()

Declaration

public abstract void MoveToNextRow()

PerformImport(ImportBookDefinition, Boolean, Byte[], String, Guid, Nullable<Guid>, Nullable<CancellationToken>)

Declaration

public void PerformImport(ImportBookDefinition definition, bool saveOnSuccess, byte[] sourceData, string definitionName, Guid importTaskId, Guid? definitionId = default(Guid? ), CancellationToken? cancelToken = default(CancellationToken? ))

Parameters

Type	Name	Description
ImportBookDefinition	definition
System.Boolean	saveOnSuccess
System.Byte[]	sourceData
System.String	definitionName
System.Guid	importTaskId
System.Nullable<System.Guid>	definitionId
System.Nullable<System.Threading.CancellationToken>	cancelToken

PerformPostProcessExpressions(DataContext, EntityObject, IEnumerable<ImportColumnDefinition>, Boolean)

Declaration

public void PerformPostProcessExpressions(DataContext dataContext, EntityObject eo, IEnumerable<ImportColumnDefinition> columnDefinitions, bool includeAllinRelations)

Parameters

Type	Name	Description
DataContext	dataContext
EntityObject	eo
System.Collections.Generic.IEnumerable<ImportColumnDefinition>	columnDefinitions
System.Boolean	includeAllinRelations

PrepareImportSheet(ImportSheetDefinition)

Declaration

public abstract bool PrepareImportSheet(ImportSheetDefinition sheet)

Parameters

Type	Name	Description
ImportSheetDefinition	sheet

Returns

Type	Description
System.Boolean

PrepareImportWorkbook(ImportBookDefinition)

Declaration

public abstract bool PrepareImportWorkbook(ImportBookDefinition book)

Parameters

Type	Name	Description
ImportBookDefinition	book

Returns

Type	Description
System.Boolean

PreprocessValue(DataContext, ModelEntityBase, ImportColumnDefinition, Object)

Declaration

public object PreprocessValue(DataContext targetContext, ModelEntityBase targetEntity, ImportColumnDefinition icd, object sourceValue)

Parameters

Type	Name	Description
DataContext	targetContext
ModelEntityBase	targetEntity
ImportColumnDefinition	icd
System.Object	sourceValue

Returns

Type	Description
System.Object

SavePreviewData(PreviewWorkbook)

Declaration

public abstract byte[] SavePreviewData(PreviewWorkbook previewWorkbook)

Parameters

Type	Name	Description
PreviewWorkbook	previewWorkbook

Returns

Type	Description
System.Byte[]

SetRowMessage(ImportSheetDefinition, String, Boolean, Boolean)

Declaration

public virtual void SetRowMessage(ImportSheetDefinition sheetDefinition, string text, bool isError, bool isModification)

Parameters

Type	Name	Description
ImportSheetDefinition	sheetDefinition
System.String	text
System.Boolean	isError
System.Boolean	isModification

TryFindRelation(ImportColumnDefinition, Relation, String, Boolean, out EntityObject)

Declaration

protected virtual bool TryFindRelation(ImportColumnDefinition column, Relation targetRelation, string value, bool includeAll, out EntityObject resultingEntityObject)

Parameters

Type	Name	Description
ImportColumnDefinition	column
Relation	targetRelation
System.String	value
System.Boolean	includeAll
EntityObject	resultingEntityObject

Returns

Type	Description
System.Boolean

TrySetProperty(ImportColumnDefinition, ModelProperty, EntityObject, Object)

Declaration

protected virtual void TrySetProperty(ImportColumnDefinition column, ModelProperty targetProperty, EntityObject target, object cellValue)

Parameters

Type	Name	Description
ImportColumnDefinition	column
ModelProperty	targetProperty
EntityObject	target
System.Object	cellValue

Events

OnEntityObjectSaved

Declaration

public event ImportEngine.EntityObjectSaved OnEntityObjectSaved

Event Type

Type	Description
ImportEngine.EntityObjectSaved

OnMessage

Declaration

public event ImportEngine.MessageCallback OnMessage

Event Type

Type	Description
ImportEngine.MessageCallback

OnProgress

Declaration

public event ImportEngine.ProgressCallback OnProgress

Event Type

Type	Description
ImportEngine.ProgressCallback

OnReportFinished

Declaration

public event ImportEngine.SaveReportCallback OnReportFinished

Event Type

Type	Description
ImportEngine.SaveReportCallback