Classe TMI_ui_Custom_Application

Descrição

Hierarquia

Tipos Aninhados

Campos

Métodos

Propriedades

Unit

mi_rtl_ui_custom_application

Declaração

type TMI_ui_Custom_Application = class(TApplication)

Descrição

A classe TMI_ui_Custom_Application concentra as propriedades e formulários gerais necessários em qualquer aplicação.

Recursos globais:
- Propriedade Get_Parameters cria um formulário de entrada de dados de configuração de acesso ao banco de dados e outros parâmetros;
- Propriedade SQLConnector e SQLTransaction e as propriedades relacionadas;
- O evento OnValidUser é usado para validar o nome do usuário e senha.

Hierarquia

TCustomApplication
TApplicationAbstract
TApplication_type
TApplicationConsts
TApplication
TMI_ui_Custom_Application

Visão Geral

Tipos Aninhados

TTb_Access = mi.rtl.Objects.Methods.Db.Tb__Access.TTb__Access;

Campos

	`MI_UI_InputBox: TMI_UI_InputBox;`
	`BufDataSet1: TBufDataSet;`
	`DataSource1: TDataSource;`
	`nested const OkCreateDataBase : boolean = false;`
	`nested const Const_ConnectorType : Array[TUiDmxScroller.TConnectorType] of AnsiString =('PostgreSQL','SqLite3');`
	`nested const FileName_Parameters : AnsiString = '';`
	`_Get_Parameters: TUiDmxScroller;`
	`Mi_Transaction: TUiDmxScroller.TMi_Transaction;`

Métodos

	`function ExistDataBase:Boolean;`
	`function CreateDataBase:boolean;`
	`procedure Get_ParametersEnter(aDmxScroller: TUiDmxScroller);`
	`procedure Get_ParametersExit(aDmxScroller: TUiDmxScroller);`
	`Procedure Get_ParametersCloseQuery(aDmxScroller:TUiDmxScroller; var CanClose:boolean);`
	`Function Login_GetTemplate( aNext : PSItem ) : PSItem;`
	`Function NameDataBase:AnsiString;`
	`function DoOnValidUser(aDmxScroller:TUiDmxScroller;aUserName:AnsiString;aPassword:AnsiString):boolean; virtual;`
	`procedure Create_Get_Parameters; virtual; Abstract;`
	`constructor Create(AOwner: TComponent); override;`
	`destructor Destroy; override;`

Propriedades

	`property SQLConnectorOptions : TSQLConnectionOptions Read _SQLConnectorOptions write SetSQLConnectorOptions default [];`
	`property SQLTransactionOptions : TSQLTransactionOptions Read _SQLTransactionOptions write SetSQLTransactionOptions default [];`
	`property Connected : Boolean Read GetConnected write SetConnected;`
	`property ConnectorType : TUiDmxScroller.TConnectorType Read _ConnectorType write _ConnectorType;`
	`property HostName : AnsiString Read GetHostName write SetHostName;`
	`property DirDataBaseName : AnsiString Read GetDirDataBaseName write SetDirDataBaseName;`
	`property DatabaseName : AnsiString Read GetDatabaseName write SetDatabaseName;`
	`property UserName : AnsiString Read GetUserName write SetUserName;`
	`property Password : AnsiString Read GetPassword write SetPassword;`
	`property CharSet : AnsiString Read GetCharSet write SetCharSet;`
	`property onValidUser : TOnValidUser Read _OnValidUser write _onValidUser;`
	`property SQLConnector : TSQLConnector read _SQLConnector;`
	`property SQLTransaction : TSQLTransaction read _SQLTransaction;`
	`property Get_Parameters : TUiDmxScroller read _Get_Parameters;`

Descrição

Tipos Aninhados

	`TTb_Access = mi.rtl.Objects.Methods.Db.Tb__Access.TTb__Access;`

Campos

	`MI_UI_InputBox: TMI_UI_InputBox;`

	`BufDataSet1: TBufDataSet;`
O atributo `BufDataSet1` é usado para salvar em disco local no arquivo FileName_Parameters os parâmetros informados pelo formulário Get_Parameters

	`DataSource1: TDataSource;`
O atributo `DataSource1` permite integrar os dados da classe TMiDmxScroller com os componentes da LCL com DbGrid, DbEdit etc...

	`nested const OkCreateDataBase : boolean = false;`
A constante `OkCreateDataBase` se true executa o método CreateDataBase se ExisteCreateDataBase = false

	`nested const Const_ConnectorType : Array[TUiDmxScroller.TConnectorType] of AnsiString =('PostgreSQL','SqLite3');`
A constante `Const_ConnectorType` contém a lista de nomes dos tipo de bancos de dados testados pelo componente TMI_ui_Custom_Application

nested const FileName_Parameters : AnsiString = '';

A constante FileName_Parameters contém o nome do arquivo de parâmetros

A constante FileName_Parameters é inicializado em TMI_ui_Custom_Application.create onde:
- FileName_Parameters := ParamStr(0)+'_Parameters.bds';

_Get_Parameters: TUiDmxScroller;

Este atributo é usado pelas classes filhas para implementar classes herdadas de TUiDmxScroller.

No momento (08/04/22 a classe que herdade é: TUiDmxScroller_form)

	`Mi_Transaction: TUiDmxScroller.TMi_Transaction;`
O Método `Mi_Transaction` genrencia as transações do projeto MarIcarai

Métodos

	`function ExistDataBase:Boolean;`
O Método `ExistDataBase` retorna true se o banco de dados existe e false se não existir.

	`function CreateDataBase:boolean;`
O método `CreateDataBase` cria o banco de dados se a constante OkCreateDataBase = true

procedure Get_ParametersEnter(aDmxScroller: TUiDmxScroller);

O método Get_ParametersEnter é usado pela classe Get_Parameters.

Esse evento cria o arquivo de parâmetros usando os dados das propriedades de TMI_ui_Custom_Application definidas no tempo de projeto.

	`procedure Get_ParametersExit(aDmxScroller: TUiDmxScroller);`

Procedure Get_ParametersCloseQuery(aDmxScroller:TUiDmxScroller; var CanClose:boolean);

O método Get_ParametersCloseQuery é usado para confirmar o fechamento do formulário Get_Parameters com botão MrOK caso os campos de Get_Parameters sejam válidos.

NOTA
- Método Get_ParametersCloseQuery executa o evento DoOnValidUser, se o mesmo for assinalado na aplicação com objetivo de não permitir fechar o formulário modal com botão MrOK caso DoOnValidUser retornar false.
- Pode ser usado para checar se usuário e senha são válidos bem como se os parâmetros estão compatíveis com os bancos de dados instalados.

	`Function Login_GetTemplate( aNext : PSItem ) : PSItem;`
O método `Login_GetTemplate` retorna um Template usado para criar o formulário de entrada de dados para a conexão.

	`Function NameDataBase:AnsiString;`
O método `NameDataBase` retorna o nome do banco de dados de acordo com o tipo de banco de dados.

	`function DoOnValidUser(aDmxScroller:TUiDmxScroller;aUserName:AnsiString;aPassword:AnsiString):boolean; virtual;`
O método `DoOnValidUser` executa o evento onValidUser se o mesmo for assinalado na aplicação ou retorna true se onValidUser = nil

	`procedure Create_Get_Parameters; virtual; Abstract;`
O método `Create_Get_Parameters` deve ser implementado para criar classe TUiDmxScroller_form_lcl ou TUiDmxScroller_form_HTML_Angular4.

	`constructor Create(AOwner: TComponent); override;`
O constructor `Create` cria os componentes SQLConnector, SQLTransaction, BufDataSet1, DataSource1, Inicia a constante FileName_Parameters, executa o método Create_Get_Parameters, inicializa charSet e liga os componentes SQLConnector com SQLTransaction e os componentes DataSource1.DataSet := BufDataset1.

	`destructor Destroy; override;`
O destructor `Destroy` destrói as classes criadas pelo constructor da classe

Propriedades

property SQLConnectorOptions : TSQLConnectionOptions Read _SQLConnectorOptions write SetSQLConnectorOptions default [];

A propriedade SQLConnectorOptions é usada para controlar o comportamento do SqlDb para esta conexão.

As seguintes opções podem ser definidas:
- Type TSQLConnectionOption = (scoExplicitConnect, scoApplyUpdatesChecksRowsAffected);
- ONDE:
  - scoExplicitConnect :
    - Quando definido, a conexão deve ser feita explicitamente.
    - O comportamento padrão é para TSQLQuery abrir implicitamente a conexão conforme necessário.
  - scoApplyUpdatesChecksRowsAffected :
    - Quando definido, sempre que uma instrução SQL de atualização é executada durante ApplyOptions de um conjunto de dados, RowsAffected é verificado e deve ser igual a 1.
REFERÊNCIAS
- [tsqltransaction.options](https://www.freepascal.org/docs-html/fcl/sqldb/tsqltransaction.options.html)

property SQLTransactionOptions : TSQLTransactionOptions Read _SQLTransactionOptions write SetSQLTransactionOptions default [];

A propriedade SQLTransactionOptions é usada para controlar o comportamento do SqlDb para esta transação.

As seguintes opções podem ser definidas:
- Type TSQLTransactionOption = (stoUseImplicit, stoExplicitStart);
- ONDE:
  - stoUseImplicit :
    - Use o suporte a transações implícitas do mecanismo de banco de dados. Isso significa que nenhum comando explícito de início e parada de transação será enviado ao servidor quando os métodos Commit ou Rollback forem chamados (tornando-os efetivamente sem operação no nível do banco de dados).
  - stoExplicitStart
    - Quando definido, sempre que uma instrução SQL é executada, a transação deve ter sido iniciada explicitamente. O comportamento padrão é que TSQLStatement ou TSQLQuery iniciem a transação conforme necessário.
REFERÊNCIAS
- [tsqltransaction.options](https://www.freepascal.org/docs-html/fcl/sqldb/tsqltransaction.options.html)

property Connected : Boolean Read GetConnected write SetConnected;

A propriedade Connected conecta ao banco de dados selecionado.

True = Conecta ao banco;
False = Desconecta do banco;

	`property ConnectorType : TUiDmxScroller.TConnectorType Read _ConnectorType write _ConnectorType;`
O evento `ConnectorType` seleciona o tipo de banco de dados a ser conectado

	`property HostName : AnsiString Read GetHostName write SetHostName;`
A propriedade `HostName` informa ao SQLConnector o IP ou domínimo onde o banco de dados foi hospedado.

property DirDataBaseName : AnsiString Read GetDirDataBaseName write SetDirDataBaseName;

A propriedade DirDataBaseName contém a pasta do HD do servidor onde o banco de banco foi hospedado.

Não foi implementado ainda
- Preciso de mais informações de como alterar a pasta dos bancos de dados PostgreSQL e SQLite3.

	`property DatabaseName : AnsiString Read GetDatabaseName write SetDatabaseName;`
A propriedade `DatabaseName` contém o nome do Banco de Dados dentro do PostegresSQL ou do SQLite3.

	`property UserName : AnsiString Read GetUserName write SetUserName;`
A propriedade `UserName` contém o nome do usuário conectado ao banco de dados.

	`property Password : AnsiString Read GetPassword write SetPassword;`
A propriedade `Password` contém a senha do usuário conectado ao banco de dados.

property CharSet : AnsiString Read GetCharSet write SetCharSet;

A propriedade CharSet é usada para definir o tipo de caractere do banco de dados.

NOTA
- Deve ser informado em tempo de designe do projeto.
REFERÊNCIAS
- [CHARSET-TABLE](https://www.postgresql.org/docs/current/multibyte.html#CHARSET-TABLE)

	`property onValidUser : TOnValidUser Read _OnValidUser write _onValidUser;`
O evento `onValidUser` é disparado toda vez que o TUiDmxScroller ativado.

property SQLConnector : TSQLConnector read _SQLConnector;

A propriedade SQLConnector é um componente conector de banco de dados versátil para uso com qualquer banco de dados suportado.

A incluir uma aplicação TMi_UI_Application na aplicação correnteautomaticamente é disponibilizado um conector de acesso o banco de dados.
REFERÊNCIAS
- [TSQLConnector](https://wiki.freepascal.org/TSQLConnector)
- [sqldb/tsqlconnector](https://www.freepascal.org/docs-html/fcl/sqldb/tsqlconnector.html)

property SQLTransaction : TSQLTransaction read _SQLTransaction;

A propriedade SQLTransaction representa uma transação no banco de dados na qual um TSQLQuery é tratado.

Na prática, pelo menos uma transação precisa estar ativa para um banco de dados, mesmo que você a utilize apenas para leitura de dados.
NOTAS
- Ao usar uma única transação, defina a propriedade TConnection. Transaction para a transação para definir a transação padrão para o banco de dados; a propriedade TSQLTransaction.Database correspondente deve apontar automaticamente para a conexão.
- Ao ativar uma TSQLTransaction o método StartTransaction inicia uma transação; chamar o método Commit ou o método RollBack confirma (salva) ou reverte (esquece/aborta) a transação.
  - Você deve cercar suas transações de banco de dados com eles, a menos que use as propriedades Autocommit ou CommitRetaining.
REFERÊNCIAS
- [tsqltransaction](https://www.freepascal.org/docs-html/fcl/sqldb/tsqltransaction.html)

	`property Get_Parameters : TUiDmxScroller read _Get_Parameters;`
A propriedade `Get_Parameters` contém o formulário para ler os parâmetros de conexão com o banco de dados.

Gerado por PasDoc 0.16.0.