ConnectorDataItemClass Class

Base class for data access

Inheritance Hierarchy

SystemObject
SOWIData.DatabaseConnectorDataItemClass
More...

Namespace: SOWIData.Database
Assembly: SOWIData (in SOWIData.dll) Version: 19.1.23.1 (19.1.23.622)

Syntax

Copy

public abstract class Connector<DataItemClass> : IConnector<DataItemClass>

Public MustInherit Class Connector(Of DataItemClass)
	Implements IConnector(Of DataItemClass)

Type Parameters

DataItemClass: [Missing <typeparam name="DataItemClass"/> documentation for "T:SOWIData.Database.Connector`1"]

The ConnectorDataItemClass type exposes the following members.

Constructors

	Name	Description
	ConnectorDataItemClass	Standard database connector for data handling

Top

Properties

	Name	Description
	ConnectionString	Gives database connection string of the app used
	DB	Database object. Sets with method SetDB.
	NameUnchanged	Flag no change value in field Name Default: false
	NameUnique	Flag whether Name unique Default: false
	Provider	Gives data provider type back.
	RecordStandard	Which data items read from database? All, active or archived records.
	SortDirectionStandard	Standard sort direction by sort field for example method GeAll
	SortFieldStandard	Standard sort field for example method GeAll
	UserName	Gives user name of the app used
	XML	XML object. Sets with method SetDB

Top

Methods

	Name	Description
	Count(Records)	Gives the count by all, active or archive data records
	Count(String, Records)	Gives the count by all, active or archive data records and filtering by Name
	Delete(ListInt32)	Delete all data items
	Delete(Int32)	Delete a data item - set Status = Delete (except XML provider)
	Delete(String)	Delete data item by Name
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Exist(Int32)	Check exist data item by ID (hits can be multiple)
	Exist(String)	Check exist data item by Name (can be multiple)
	ExistOne	Check exist one data item by Name
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAll	Get data list by standards value without parameter.
	GetAll(Records)	Get data list by Records (all, active, archived)
	GetAll(String, SortDirections)	Get data list details with sort parameters
	GetAll(String, Operators, Object)	Get data list by search parameter.
	GetAll(String, SortDirections, String, Operators, Object, Records)	Get data list with all parameters.
	GetByID	Gives one data item by ID
	GetByName	Data item search by field Name
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetList	Gives raw data list and is basis for all data processing (example for method GetAll)
	GetProperty	Gives a property from object properties
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Insert(ListDataItemClass)	Insert list of data items
	Insert(DataItemClass)	Insert data item
	InsertOrUpdateByName	If not exists data record by Name then call method Insert. If exists data record unique then call method Update. If more data records then trigger an exception DataFoundMoreAsOne
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetDB	Sets database
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update(ListDataItemClass)	Data list update
	Update(DataItemClass)	Data item update
	Validate	Validate data item

Top

Fields

	Name	Description
	DBActionAfter	Triggered by methods Get*, Insert, Update and Delete
	DBActionBefore	Triggered by methods Get*, Insert, Update and Delete
	DBActionDone	Triggered by methods Get*, Insert, Update and Delete
	DBActionPermission	Triggered by methods Get*, Insert, Update and Delete
	DBActionPrepare	Triggered by methods Get*, Insert, Update and Delete
	Validating	Triggered by method Validate

Top

Extension Methods

	Name	Description
	DatabaseIsChangedDataItemClass	Check is object pApp null, is parameter pConnectionString no equal to App property, is parameter pUserName no equal to App property (Defined by Helper.)
	GetObjectToBytes	Convert an object to byte array (Defined by Extensions.)
	IsNumber	Check is value a number (Defined by Convert.)
	ToHTMLDisplay(DataGrid, TempDataDictionary)	Overloaded. Gives HTML code for display. Details see ToHTMLDisplay(Object, String, DataGridDataTypes, String, String, String, String, TempDataDictionary). (Defined by Extensions.)
	ToHTMLDisplay(String, DataGridDataTypes, String, String, String, String, TempDataDictionary)	Overloaded. Gives HTML code for display. (Defined by Extensions.)
	ToHTMLEditor(DataGrid, TempDataDictionary, String)	Overloaded. Gives HTML code for Input field. Call method ToHTMLEditor(Object, String, DataGridDataTypes, String, String, String, TempDataDictionary, Boolean, String, DataPlacements, String, String) (Defined by Extensions.)
	ToHTMLEditor(String, DataGridDataTypes, String, String, String, TempDataDictionary, Boolean, String, DataPlacements, String, String)	Overloaded. Gives HTML code for Input field (Defined by Extensions.)
	ToHTMLHidden(String)	Overloaded. Gives HTML code for hidden data (Defined by Extensions.)
	ToHTMLHidden(DataGrid)	Overloaded. Gives HTML code for hidden data (Defined by Extensions.)
	XMLWrite	Gives XML string from data item (Defined by Helper.)

Top

Remarks

Initialize which data source in method SetDB and method GetList

Type parameter DataItemClass must based on type IDataStandard

XML Provider

Values of ConnectionString properties:

DataSource puts value XML (SOWIData.Providers.XML).

InitialCatalog value it XML file

Examples

This example creates a SOWI Data Database Connector with a XML file

Copy

//* declaration SOWI Data Connector object for XML file (based on SOWIData.Database.Connector)*
SOWIDataConnectorXML lSOWIDataConnectorXML = null;

//* declaration and initialize the Connection String Builder *
SqlConnectionStringBuilder lConnectionStringBuilder = new SqlConnectionStringBuilder();

//* puts XML provider to property DataSource *
lConnectionStringBuilder.DataSource = SOWIData.Providers.XML.ToString();

//* puts XML file name to property InitialCatalog *
lConnectionStringBuilder.InitialCatalog = "XMLFileName.xml";

//* initialize user *
string lUserName = "TestCaseUser";

//* create SOWI Data Connector for XML file *
lSOWIDataConnectorXML = new SOWIDataConnectorXML(lConnectionStringBuilder.ConnectionString.ToString(), lUserName);

SetDB

Reference

SOWIData.Database Namespace

Inheritance Hierarchy

ConnectorAddLanguageSpecificTextSet("LST6BE18914_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");DataItemClassAddLanguageSpecificTextSet("LST6BE18914_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

XML Provider

Reference

ConnectorDataItemClass Class