VCQueryオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.31 |
since | 8.0.0 |
クエリオブジェクト。
データ参照の作成に必要な、クエリを表すオブジェクトです。
クエリが持つ情報へのgetterおよびsetterを提供するほか、SQLクエリを実行して結果データを取得することもできます。
◆クエリXML文字列
クエリのデータの登録・検索結果はXML文字列で行われます。
以下に例を示します。
------------------------------------------
<?xml version='1.0' encoding='UTF-8' ?>
<root err="0" msg="">
<query>
<query-code>クエリコード</query-code>
<query-name>クエリ名</query-name>
<query-info>説明</query-info>
<db-source>データソース</db-source>
</query>
<!-- カラム一覧 -->
<column-list>
<column caption="表示名" column_cd="カラムコード"
column_name="カラム物理名" column_type="カラムタイプ"
table_cd="テーブルコード" />
...
</column-list>
<!-- テーブル一覧 -->
<table-list>
<table height="高さ" width="幅" table_cd="テーブルコード"
table_name="テーブル物理名" x="X座標" y="Y座標">
<sql>SELECT文</sql>
</table>
...
</table-list>
<!-- 結合条件一覧 -->
<line-list>
<line from_column_name="左カラム物理名" from_table_cd="左テーブルコード"
from_table_name="左テーブル物理名" line_cd="結合条件コード" line_type="結合タイプ"
target_column_name="右カラム物理名" target_table_cd="右テーブルコード"
target_table_name="右テーブル物理名" />
...
</line-list>
</root>
------------------------------------------
データ参照の作成に必要な、クエリを表すオブジェクトです。
クエリが持つ情報へのgetterおよびsetterを提供するほか、SQLクエリを実行して結果データを取得することもできます。
◆クエリXML文字列
クエリのデータの登録・検索結果はXML文字列で行われます。
以下に例を示します。
------------------------------------------
<?xml version='1.0' encoding='UTF-8' ?>
<root err="0" msg="">
<query>
<query-code>クエリコード</query-code>
<query-name>クエリ名</query-name>
<query-info>説明</query-info>
<db-source>データソース</db-source>
</query>
<!-- カラム一覧 -->
<column-list>
<column caption="表示名" column_cd="カラムコード"
column_name="カラム物理名" column_type="カラムタイプ"
table_cd="テーブルコード" />
...
</column-list>
<!-- テーブル一覧 -->
<table-list>
<table height="高さ" width="幅" table_cd="テーブルコード"
table_name="テーブル物理名" x="X座標" y="Y座標">
<sql>SELECT文</sql>
</table>
...
</table-list>
<!-- 結合条件一覧 -->
<line-list>
<line from_column_name="左カラム物理名" from_table_cd="左テーブルコード"
from_table_name="左テーブル物理名" line_cd="結合条件コード" line_type="結合タイプ"
target_column_name="右カラム物理名" target_table_cd="右テーブルコード"
target_table_name="右テーブル物理名" />
...
</line-list>
</root>
------------------------------------------
メソッドの概要
返却値の型 | メソッド名 |
---|---|
ResultObject | checkError () クエリのデータにエラーが無いかどうか調べます。 |
Boolean | evalXml (String jsXmlString ) staticクエリを表すXML文字列が有効かどうかを評価します。 |
ResultObject | execute (Array jsparam1 , Number jsparam2 , Number jsparam3 ) クエリを実行して結果データを取得します。 |
String | generateFromSql () クエリからSQL文(FROM句)を生成します。 |
String | generateOrderbySql (Boolean jsalias ) クエリからSQL文(ORDER BY句)を生成します。 |
String | generateSelectSql (Boolean jsalias ) クエリからSQL文(SELECT句)を生成します。 |
String | generateSql (Boolean jsalias ) クエリからSQL文を生成します。 |
String | generateWhereSql () クエリからSQL文(WHERE句)を生成します。 |
String | getCategoryId () カテゴリIDを取得します。 |
String | getCode () クエリコードを取得します。 |
Number | getColumnLength () クエリに含まれるカラムの数を返します。 |
Object | getColumn (String jsparam1 , String jsparam2 ) カラムオブジェクトを取得します。 |
Array | getColumns () クエリを構成するカラム一覧を取得します。 |
Number | getConditionLength () クエリに含まれる抽出条件の数を返します。 |
Object | getCondition (String jsconditionCode ) 抽出条件オブジェクトを取得します。 |
Array | getConditions () 抽出条件の一覧を取得します。 |
String | getConditionwhere () 直接入力されたWHERE句を取得します。 |
String | getCreatedBy () 作成者コードを取得します。 |
String | getDataSource () データソースを取得します。 |
String | getInfo () 説明を取得します。 |
Array | getLines () 結合条件を取得します。 |
String | getName () クエリ名を取得します。 |
Array | getSqlTables () SQL定義されているテーブルの一覧を取得します。 |
Number | getTableLength () クエリに含まれるテーブルの数を返します。 |
Object | getTable (String jstableCode ) テーブルオブジェクトを取得します。 |
Array | getTables () クエリを構成するテーブル一覧を取得します。 |
Date | getUpdated () 更新日を取得します。 |
String | getXmlString (String jsencoding ) クエリオブジェクトのXMLデータを取得します。 |
Boolean | hasDynamicParameter () 指定されたクエリにダイナミックパラメータが設定されているかどうかを調べます。 |
Boolean | hasNumberTypeColumn () このクエリが数値型のカラムを1つ以上持っているかどうかを調べます。 |
Boolean | hasSqlTable () SQL定義されているテーブルがクエリ内にあるかどうか調べます。 |
Boolean | isDirectwhere () 直接入力されたWHERE句を使うかどうかを調べます |
Boolean | isExpansion () このクエリが拡張データソースから作成されているかどうかを調べます。 |
Boolean | isOrsearch () OR検索するかどうかを調べます。 |
String | setCategoryId (String jscategoryId ) カテゴリIDを設定します。 |
String | setCode (String jscode ) クエリコードを設定します。 |
Array | setColumns (Array jsparam ) カラム一覧を設定します。 |
Array | setConditions (Array jsparam ) 抽出条件の一覧を設定します。 |
String | setConditionwhere (String jsconditionwhere ) 直接入力されたWHERE句を設定します。 |
String | setDataSource (String jsdataSource ) データソースを設定します。 |
Boolean | setDirectwhere (Boolean jsdirectwhere ) 直接入力されたWHERE句を使うかどうかを設定します。 |
void | setFormat (Boolean jsformat ) SQL文をフォーマット整形するかどうかを設定します。 |
String | setInfo (String jsinfo ) 説明を設定します。 |
Array | setLines (Array jsparam ) 結合条件を設定します。 |
String | setName (String jsname ) クエリ名を設定します。 |
Boolean | setOrsearch (Object orsearch ) OR検索するかどうかを設定します。 |
Array | setTables (Array jsparam ) テーブル一覧を設定します。 |
Date | setUpdated (Date jsdate ) 更新日を設定します。 |
メソッドの詳細
ResultObject checkError ()
クエリのデータにエラーが無いかどうか調べます。
返却値
|
Boolean evalXml (String jsXmlString )
static
クエリを表すXML文字列が有効かどうかを評価します。
パラメータ
返却値
|
ResultObject execute (Array jsparam1 , Number jsparam2 , Number jsparam3 )
クエリを実行して結果データを取得します。
ステートメントに値を設定するためには、そのパラメータをダイナミックパラメータとして事前に登録しておく必要があります。
パラメータ
返却値
|
String generateFromSql ()
クエリからSQL文(FROM句)を生成します。
返却値
|
String generateOrderbySql (Boolean jsalias )
クエリからSQL文(ORDER BY句)を生成します。
パラメータ
返却値
|
String generateSelectSql (Boolean jsalias )
クエリからSQL文(SELECT句)を生成します。
パラメータ
返却値
|
String generateSql (Boolean jsalias )
クエリからSQL文を生成します。
パラメータ
返却値
|
String generateWhereSql ()
クエリからSQL文(WHERE句)を生成します。
返却値
|
String getCategoryId ()
カテゴリIDを取得します。
返却値
|
String getCode ()
クエリコードを取得します。
返却値
|
Number getColumnLength ()
クエリに含まれるカラムの数を返します。
返却値
|
Object getColumn (String jsparam1 , String jsparam2 )
カラムオブジェクトを取得します。
パラメータ
返却値
|
Array getColumns ()
クエリを構成するカラム一覧を取得します。
返却値
|
Number getConditionLength ()
クエリに含まれる抽出条件の数を返します。
返却値
|
Object getCondition (String jsconditionCode )
抽出条件オブジェクトを取得します。
パラメータ
返却値
|
Array getConditions ()
抽出条件の一覧を取得します。
返却値
|
String getConditionwhere ()
直接入力されたWHERE句を取得します。
返却値
|
String getCreatedBy ()
作成者コードを取得します。
返却値
|
String getDataSource ()
データソースを取得します。
返却値
|
String getInfo ()
説明を取得します。
返却値
|
Array getLines ()
結合条件を取得します。
返却値
|
String getName ()
クエリ名を取得します。
返却値
|
Array getSqlTables ()
SQL定義されているテーブルの一覧を取得します。
返却値
|
Number getTableLength ()
クエリに含まれるテーブルの数を返します。
返却値
|
Object getTable (String jstableCode )
テーブルオブジェクトを取得します。
パラメータ
返却値
|
Array getTables ()
クエリを構成するテーブル一覧を取得します。
返却値
|
Date getUpdated ()
更新日を取得します。
返却値
|
String getXmlString (String jsencoding )
クエリオブジェクトのXMLデータを取得します。
パラメータ
返却値
|
Boolean hasDynamicParameter ()
指定されたクエリにダイナミックパラメータが設定されているかどうかを調べます。
返却値
|
Boolean hasNumberTypeColumn ()
このクエリが数値型のカラムを1つ以上持っているかどうかを調べます。
返却値
|
Boolean hasSqlTable ()
SQL定義されているテーブルがクエリ内にあるかどうか調べます。
返却値
|
Boolean isDirectwhere ()
直接入力されたWHERE句を使うかどうかを調べます
返却値
|
Boolean isExpansion ()
このクエリが拡張データソースから作成されているかどうかを調べます。
返却値
|
Boolean isOrsearch ()
OR検索するかどうかを調べます。
返却値
|
String setCategoryId (String jscategoryId )
カテゴリIDを設定します。
パラメータ
返却値
|
String setCode (String jscode )
クエリコードを設定します。
パラメータ
返却値
|
Array setColumns (Array jsparam )
カラム一覧を設定します。
パラメータ
返却値
|
Array setConditions (Array jsparam )
抽出条件の一覧を設定します。
パラメータ
返却値
|
String setConditionwhere (String jsconditionwhere )
直接入力されたWHERE句を設定します。
パラメータ
返却値
|
String setDataSource (String jsdataSource )
データソースを設定します。
パラメータ
返却値
|
Boolean setDirectwhere (Boolean jsdirectwhere )
直接入力されたWHERE句を使うかどうかを設定します。
パラメータ
返却値
|
void setFormat (Boolean jsformat )
SQL文をフォーマット整形するかどうかを設定します。
パラメータ
返却値
|
String setInfo (String jsinfo )
説明を設定します。
パラメータ
返却値
|
Array setLines (Array jsparam )
結合条件を設定します。
パラメータ
返却値
|
String setName (String jsname )
クエリ名を設定します。
パラメータ
返却値
|
Boolean setOrsearch (Object orsearch )
OR検索するかどうかを設定します。
パラメータ
返却値
|
Array setTables (Array jsparam )
テーブル一覧を設定します。
パラメータ
返却値
|
Date setUpdated (Date jsdate )
更新日を設定します。
パラメータ
返却値
|