602SQL-Úplná dokumentace Index  

TSQL602XML

Delphi / Kylix

Zjednodušená deklarace třídy:

type TSQL602XML = class(TComponent)
published
  property Connection   : TSQL602Connection;	
  property DAD          : string;	
  property DADType      : TDadType;	
  property Params       : TParams;	
  property DataSet      : TDataSet;	

public
  property Cursor       : tcursnum;		

  constructor Create(AOwner : TComponent); override;
  destructor  Destroy; override;

  procedure ClearAllParams;
  procedure SetParam(Name : string; Value : Integer; pType : TParamType = ptInput); overload;
  procedure SetParam(Name : string; Value : string; pType : TParamType = ptInput);  overload;
  procedure SetParam(Name : string; Value : string; Size : Integer; pType : TParamType); overload;
  procedure SetParam(Name : string; vType : TFieldType; var Value; Size : Integer; 
            pType : TParamType = ptInput); overload;	
  function  ParamByName(const ParamName : string) : TParam;	
  
  function  ExportToString : string;
  procedure ExportToFile(XMLfile : string);
  procedure ImportFromString(XML : string);
  procedure ImportFromFile(XMLfile : string);

end;


Popis

Komponenta zpřístupňuje XML602 API funkce pro import dat z XML (souboru či stringu) a export dat do XML (souboru či stringu). Je-li specifikována vlastnost DataSet, použije se jako zdroj dat pro export kurzor plnící zvolený Dataset, jinak se použije zdroj dat uvedený v DADu.

Vlastnost Params umožňuje specifikovat vstupní i výstupní parametry (host variables lze v XML použít ve dvou rozdílných významech: pro omezení výběru záznamů pro export nebo jako data pro export/import).

Vede-li zvolený DAD do ODBC zdroje dat, musí být tento zdroj dat předem otevřen pomocí třídy TSQL602ODBCConnection. Vede-li DAD do jiného 602SQL serveru, musí být předem vytvořeno spojení na tento server pomocí TSQL602Connection.



Unit

SQL602

Vlastnosti komponenty

Connection : TSQL602Connection

Spojení na server, kde je uložen DAD, pomocí TSQL602Connection. Změna této vlastnosti nebo deaktivace spojení s SQL serverem vyvolá reset komponenty.

DAD : string

Pro DadType=DadTypeStored jméno DAD objektu popisujícího vazbu (zobrazení) mezi XML textovým souborem a daty a proměnnými v databázi. DAD je třeba vytvořit prostředky vývojového prostředí 602SQL.
Pro DadType=DadTypeString definice DAD jako řetězec (bez nutnosti mít DAD uložen jako objekt v aplikaci). V současné verzi není syntaxe DAD dokumentována.

DADType : TDadType

Podle nastavení této vlastnosti se interpretuje definice DADu (vlastnost DAD) buď ze zadaného objektu uloženého v aplikaci nebo přímo z hodnoty vlastnosti.

type TDadType = (DadTypeStored, DadTypeString);

Params : TParams

Seznam parametrů dotazu použitého v návrhu DADu nebo/a seznam embedded proměnných použitých pro export či import. Specifikuje jména, datové typy (ft...), typy parametrů (pt...) a hodnoty argumentů. Ručně lze seznam plnit pomocí metod SetParam.

Cursor : tcursnum

Vlastnost umožňuje nahradit zdroj dat uvedený v DADu vlastním kurzorem získaným pomocí 602API funkcí.



Metody komponenty

procedure SetParam(Name : string; Value : Integer; pType : TParamType = ptInput);

Pro vytvoření parametru odpovídajícímu 602sql typu INT

procedure SetParam(Name : string; Value : string; pType : TParamType = ptInput);

Pro vytvoření vstupního parametru odpovídajícímu 602sql typu CHAR(N)

procedure SetParam(Name : string; Value : string; Size : Integer; pType : TParamType);

Pro vytvoření výstupního parametru odpovídajícímu 602sql typu CHAR(N)

procedure SetParam(Name : string; vType : TFieldType; var Value; Size : Integer; pType : TParamType = ptInput);

Pro ostatní případy. Metody nastavují vlastnosti jednotlivých parametrů:

Name Jméno parametru
Value Hodnota parametru
vType Libovolný typ hodnoty ftFloat, ftMemo, ftBlob aj. v případě, že nemůžete použít jednodušší předchozí varianty.
Size Délka řetězce - povinné pouze u výstupních parametrů pro 602sql typy CHAR(N) nebo BINARY(N), u vstupních parametrů pro 602sql typy proměnné délky (CLOB, BLOB), u výstupních parametrů těchto typů proměné délky není nutné uvádět
pType Typ parametru ptInput pro vstupní parametr, ptOutput pro výstupní parametr, ptInputOutput pro INOUT parametr

procedure ClearAllParams;

Nastaví hodnotu všech parametrů ze seznamu Params na nil.

function ParamByName(const ParamName : string) : TParam;

Metoda vrací popis parametru zadaného jména.

function ExportToString : string;

Funkce provede export dat podle zvoleného DADu do proměnné typu String.

procedure ExportToFile(XMLfile : string);

Procedura provede export dat podle zvoleného DADu do zadaného textového XML souboru.

procedure ImportFromString(XML : string);

Procedura provede import dat podle zvoleného DADu z XML zdroje zadaného jako proměnná typu String.

procedure ImportFromFile(XMLfile : string);

Procedura provede import dat podle zvoleného DADu ze zadaného textového XML souboru



Příklad