kCura.WinEDDS.LoadFileBase

LoadFileBase

public abstract class LoadFileBase : ImportTapiBase

Documentation

public class CodeCreationException : ImporterException

The exception thrown when a failure occurs attempting to create a new code.

public class ColumnCountMismatchException : ImporterException

The exception thrown when the load file line includes more columns than defined by the headers.

public class DuplicateMulticodeValueException : ImporterException

The exception thrown when a multi-choice value already exists and would result in a duplicate if allowed to be imported.

public class DuplicateObjectReferenceException : ImporterException

The exception thrown when an object reference already exists and would result in a duplicate if allowed to be imported.

public class ExtractedTextTooLargeException : ImporterException

The exception thrown when the extracted text file length exceeds the max extracted text length. When the encoding is not specified or is UTF8, the max length is 1GB otherwise, the max length is MaxValue.

public class IdentifierOverlapException : ImporterException

The exception thrown when the identity value has already been processed.

public class MissingFullTextFileException : ImporterException

The exception thrown when extracted text file validation is enabled and the file does not exist.

public class MissingUserException : ImporterException

The exception thrown when the user artifact does not exist within the Relativity instance.

public class NonExistentParentException : ImporterException

The exception thrown when a parent reference does not exist.

public class ParentObjectReferenceRequiredException : ImporterException

The exception thrown when a parent object reference does not exist.

protected SqlDataView _allCodes

protected SqlDataView _allCodeTypes

protected int _artifactTypeID

protected bool _autoDetect

protected IBulkImportManager _bulkImportManager

protected int _caseArtifactID

protected int _caseSystemID

protected ICodeManager _codeManager

protected bool _columnsAreInitialized

protected bool _createFolderStructure

protected string _destinationFolder

protected DocumentField[] _docFields

protected IDocumentManager _documentManager

protected ExecutionSource _executionSource

protected Encoding _extractedTextFileEncoding

protected string _extractedTextFileEncodingName

protected LoadFileFieldMap _fieldMap

protected IFieldQuery _fieldQuery

protected string _filePathColumn

protected int _filePathColumnIndex

protected bool _firstLineContainsColumnNames

protected int _folderID

protected IFolderManager _folderManager

protected bool _fullTextColumnMapsToFileLocation

protected string _hierarchicalMultiValueFieldDelmiter

protected int _keyFieldID

protected char[] _multiValueSeparator

protected IObjectManager _objectManager

protected HybridDictionary _previewCodeCount

protected IRunningContext _runningContext

protected LoadFile _settings

protected Encoding _sourceFileEncoding

protected long _startLineNumber

protected int _timeZoneOffset

protected bool _uploadFiles

protected IUserManager _usermanager

protected Hashtable MulticodeMatrix

protected virtual IArtifactReader _artifactReader { get; protected set; }

public SqlDataView AllCodes { get; set; }

public SqlDataView AllCodeTypes { get; set; }

protected virtual IBulkImportManager BulkImportManager { get; }

public bool DisableExtractedTextFileLocationValidation { get; set; }

public string FileNameColumn { get; set; }

public string FileSizeColumn { get; set; }

public bool FileSizeMapped { get; set; }

public bool LoadImportedFullTextFromServer { get; set; }

public string OIFileIdColumnName { get; set; }

public bool OIFileIdMapped { get; set; }

public string OIFileTypeColumnName { get; set; }

public int SingleCodesCreated { get; }

public bool SkipExtractedTextEncodingCheck { get; set; }

public string SupportedByViewerColumn { get; set; }

public UserCollection Users { get; }

protected abstract bool UseTimeZoneOffset { get; }

protected LoadFileBase(LoadFile args, IIoReporter reporter, ILog logger, int timezoneoffset, bool doRetryLogic, bool autoDetect, CancellationTokenSource cancellationToken, Func<string> correlationIdFunc, IRunningContext runningContext = null)

protected LoadFileBase(LoadFile args, IIoReporter reporter, ILog logger, int timezoneoffset, bool doRetryLogic, bool autoDetect, CancellationTokenSource cancellationToken, bool initializeArtifactReader, Func<string> correlationIdFunc, IRunningContext runningContext = null)

public void AddToCodeCountPreviewHashTable(int fieldID, string fieldName, string fieldValue)

protected void AdvanceLine()

protected bool FieldValueContainsTextFileLocation(ArtifactField field)

protected abstract IArtifactReader GetArtifactReader()

public int? GetCode(string value, int column, ArtifactField field, bool forPreview)

protected virtual string GetCorrelationId()

public int GetMaxExtractedTextLength(Encoding encoding)

public virtual int?[] GetMultiCode(string[] value, int column, ArtifactField field, bool forPreview)

public string GetNullableAssociatedObjectName(string value, int column, int fieldLength, string fieldName)

public string GetNullableFixedString(string value, int column, int fieldLength, string displayName)

public virtual Hashtable GetObjects(string[] value, int column, ArtifactField field, int associatedObjectTypeID, bool shouldRetrieveIdFromServer)

public virtual Hashtable GetObjectsByArtifactID(string[] value, int column, ArtifactField field, int associatedObjectTypeID)

protected abstract Base GetSingleCodeValidator()

public int? GetUserArtifactID(string value, int column)

protected void InitializeArtifactReader()

protected virtual void InitializeManagers(LoadFile args)

public virtual int LookupArtifactIDForName(string objectName, int associatedObjectTypeID)

public virtual string LookupNameForArtifactID(int objectArtifactID, int associatedObjectTypeID)

public void SetFieldValue(ArtifactField field, int columnIndex, bool forPreview, string identityValue, ref int extractedTextFileCodePageId, ImportBehaviorChoice? importBehavior)