VCQuery (javadoc-all-dev 8.0.0 API)

java.lang.Object
- jp.co.intra_mart.foundation.viewcreator.model.BaseModel
- - jp.co.intra_mart.foundation.viewcreator.model.VCQuery

すべての実装されたインタフェース:

Serializable, Model
```
public class VCQuery
extends BaseModel
implements Serializable
```
クエリを表すモデルクラスです。

導入されたバージョン:

8.0.0

バージョン:

8.0.31

関連項目:

直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static String NN_QUERY
クエリを表すキー名
- クラスから継承されたフィールド jp.co.intra_mart.foundation.viewcreator.model.BaseModel
  CREATE_DATE, CREATE_USER_CODE, RECORD_DATE, RECORD_USER_CODE

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`NN_QUERY` クエリを表すキー名

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`VCQuery()` 新しいクエリインスタンスを生成します
`VCQuery(boolean format)` 新しいクエリインスタンスを生成します
`VCQuery(Document doc)` XMLデータを用いて新しいクエリインスタンスを生成します。
`VCQuery(Document doc, boolean format)` コンストラクタ。
`VCQuery(String code)` コンストラクタ

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addColumn(Column column)` カラムを追加します。
`void`	`addCondition(Condition condition)` 抽出条件を追加します。
`void`	`addLine(UnitLine line)` 結合条件を追加します。
`void`	`addTable(Table table)` テーブルを追加します。
`void`	`checkError()` データに異常値が無いか調べます。
`void`	`checkError(boolean insertMode)` クエリ定義のデータについて整合性チェックを行います。
`List<Map<String,Object>>`	`execute()` クエリを実行して結果データを取得します。
`List<Map<String,Object>>`	`execute(Object[] params)` クエリを実行して結果データを取得します。
`List<Map<String,Object>>`	`execute(Object[] params, int startrow, int length)` クエリを実行して結果データを取得します。
`List<Map<String,Object>>`	`executeWithName(Object[] params, int startrow, int length)` クエリを実行して結果データを取得します。
`void`	`generateCodes()` テーブルコード、カラムコード、抽出条件コード、接続線コードを生成・付与します。
`String`	`generateFromSql()` クエリからSQL文(FROM句)を生成します。
`String`	`generateOrderbySql(boolean alias)` クエリからSQL文(ORDER BY句)を生成します。
`String`	`generateSelectSql(boolean alias)` クエリからSQL文(SELECT句)を生成します。
`String`	`generateSql(boolean alias)` SQL文を生成します。
`String`	`generateSql(boolean alias, boolean orderBy)` SQL文を生成します。
`String`	`generateWhereSql()` クエリからSQL文(WHERE句)を生成します。
`VCQueryCategory`	`getCategory()` クエリのカテゴリ情報を取得します。
`String`	`getCode()` クエリコードを取得します。
`Column`	`getColumn(String columnCode)` Columnオブジェクトを取得します。
`Column`	`getColumn(String tableCode, String columnName)` カラムオブジェクトを取得します。
`Set<String>`	`getColumnCodeSet()` このクエリに含まれるカラムのコードセットを取得します。
`List<Column>`	`getColumns()` カラム一覧を取得します。
`Condition`	`getCondition(String conditionCode)` Conditionオブジェクトを取得します。
`List<Condition>`	`getConditions()` 抽出条件一覧を取得します。
`String`	`getConditionwhere()` 直接入力されたWHERE句を取得します。
`String`	`getDataSource()` データソース設定を取得します。
`Document`	`getDocument()` クエリの内容を示すＸＭＬデータを取得します。
`String`	`getInfo()` 説明を取得します。
`List<UnitLine>`	`getLines()` 結合条件一覧を取得します。
`String`	`getName()` クエリ名を取得します。
`QueryType`	`getQueryType()` クエリの種類を取得します。
`String`	`getSql()` SQL文字列を取得します
`List<Table>`	`getSqlTableList()` SQL定義されているテーブルの一覧を取得します。
`Table`	`getTable(String tableCode)` Tableオブジェクトを取得します。
`List<Table>`	`getTables()` テーブル一覧を取得します。
`Date`	`getUpdated()` 更新日を取得します。
`boolean`	`hasDynamicParameter()` 指定されたクエリにダイナミックパラメータが設定されているかどうかを調べます。
`boolean`	`hasNumberTypeColumn()` このクエリが数値型のカラムを1つ以上持っているかどうかを調べます。
`boolean`	`hasSqlTable()` SQL定義されているテーブルがクエリ内にあるかどうか調べます。
`boolean`	`isDirectwhere()` WHERE句直接入力フラグを取得します。
`boolean`	`isExpansion()` このクエリが拡張データソースから作成されているかどうかを調べます。
`boolean`	`isOrsearch()` 複数の抽出条件が設定されたとき、OR検索にするかどうかを取得します。
`void`	`setCategory(VCQueryCategory category)` クエリのカテゴリ情報をセットします。
`void`	`setCategoryId(String id)` カテゴリIDをセットします。
`void`	`setCategoryName(String name)` カテゴリ名をセットします。
`void`	`setCode(String code)` クエリコードを設定します。
`void`	`setColumn(Column column)` カラムを更新します。
`void`	`setColumns(List<Column> columns)` カラムを設定します。
`void`	`setConditions(List<Condition> conditions)` 抽出条件を設定します。
`void`	`setConditionwhere(String conditionwhere)` 直接入力されたWHERE句をセットします。
`void`	`setDataSource(String dataSource)` データソース設定を設定します。
`void`	`setDirectwhere(boolean directwhere)` WHERE句直接入力フラグをセットします。
`void`	`setDocument(Document doc)` クエリを表すXMLデータを使用してクエリオブジェクトを再作成します。
`void`	`setFormat(boolean format)` このクエリから生成するSQLをフォーマット整形するかどうかを設定します
`void`	`setInfo(String info)` 説明を設定します。
`void`	`setLines(List<UnitLine> lines)` 結合条件を設定します。
`void`	`setName(String name)` クエリ名を設定します。
`void`	`setOrsearch(boolean orsearch)` OR検索にするかどうかを設定します。
`void`	`setTables(List<Table> tables)` テーブルを設定します。
`void`	`setUpdated(Date updated)` 更新日を設定します。
`String`	`toString()`

クラスから継承されたメソッド jp.co.intra_mart.foundation.viewcreator.model.BaseModel
getCreateDate, getCreateUserCode, getRecordDate, getRecordUserCode, setCreateDate, setCreateUserCode, setRecordDate, setRecordUserCode

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - NN_QUERY
```
public static final String NN_QUERY
```
    クエリを表すキー名
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - VCQuery
```
public VCQuery()
```
    新しいクエリインスタンスを生成します
  - VCQuery
```
public VCQuery(boolean format)
```
    新しいクエリインスタンスを生成します
    
    パラメータ:
    
    format - このクエリから生成するSQLをフォーマット整形するかどうか true:フォーマット整形する false:整形しない
  - VCQuery
```
public VCQuery(Document doc)
        throws QueryException
```
    XMLデータを用いて新しいクエリインスタンスを生成します。
    
    パラメータ:
    
    doc - クエリを表すXMLドキュメント
    
    例外:
    
    QueryException - XMLに不整合なデータが含まれていた場合にスローされます
  - VCQuery
```
public VCQuery(Document doc,
               boolean format)
        throws QueryException
```
    コンストラクタ。XMLデータからクエリオブジェクトを生成します。
    
    パラメータ:
    
    doc - クエリを表すXMLドキュメント
    
    format - このクエリから生成するSQLをフォーマット整形するかどうか true:フォーマット整形する false:整形しない
    
    例外:
    
    QueryException - XMLに不整合なデータが含まれていた場合にスローされます
  - VCQuery
```
public VCQuery(String code)
```
    コンストラクタ
    
    パラメータ:
    
    code - クエリコード
- メソッドの詳細
  - addColumn
```
public void addColumn(Column column)
```
    カラムを追加します。
    
    パラメータ:
    
    column - カラム
  - addCondition
```
public void addCondition(Condition condition)
```
    抽出条件を追加します。
    
    パラメータ:
    
    condition - 抽出条件
  - addLine
```
public void addLine(UnitLine line)
```
    結合条件を追加します。
    
    パラメータ:
    
    line - 結合条件
  - addTable
```
public void addTable(Table table)
```
    テーブルを追加します。
    
    パラメータ:
    
    table - テーブル
  - checkError
```
public void checkError()
                throws QueryException
```
    インタフェースからコピーされた説明: Model
    
    データに異常値が無いか調べます。
    
    定義:
    
    checkError インタフェース内 Model
    
    例外:
    
    QueryException
  - checkError
```
public void checkError(boolean insertMode)
                throws QueryException
```
    クエリ定義のデータについて整合性チェックを行います。
    
    パラメータ:
    
    insertMode - 新規作成用のクエリデータであるかどうか
    
    例外:
    
    QueryException
  - execute
```
public List<Map<String,Object>> execute()
                                 throws SQLException,
                                        QueryException
```
    クエリを実行して結果データを取得します。
    
    戻り値:
    
    結果データ配列>
    
    例外:
    
    SQLException - SQL例外
    
    QueryException - クエリデータエラー
  - execute
```
public List<Map<String,Object>> execute(Object[] params)
                                 throws SQLException,
                                        QueryException
```
    クエリを実行して結果データを取得します。
    
    パラメータ:
    
    params - プリペアドステートメントにセットするパラメータの配列。型はString, Number, Dateのいずれか
    
    戻り値:
    
    結果データ配列>
    
    例外:
    
    SQLException - SQL例外
    
    QueryException - クエリデータエラー
  - execute
```
public List<Map<String,Object>> execute(Object[] params,
                                        int startrow,
                                        int length)
                                 throws SQLException,
                                        QueryException
```
    クエリを実行して結果データを取得します。
    
    パラメータ:
    
    params - プリペアドステートメントにセットするパラメータの配列。型はString, Number, Dateのいずれか
    
    startrow - 取得開始レコード位置
    
    length - 取得レコード数
    
    戻り値:
    
    結果データ配列>
    
    例外:
    
    SQLException - SQL例外
    
    QueryException - クエリデータエラー
  - executeWithName
```
public List<Map<String,Object>> executeWithName(Object[] params,
                                                int startrow,
                                                int length)
                                         throws SQLException,
                                                QueryException
```
    クエリを実行して結果データを取得します。
    結果データ配列のフィールド名には、テーブル名.フィールド名が利用されます。
    
    パラメータ:
    
    params - プリペアドステートメントにセットするパラメータの配列。型はString, Number, Dateのいずれか
    
    startrow - 取得開始レコード位置
    
    length - 取得レコード数
    
    戻り値:
    
    結果データ配列>
    
    例外:
    
    SQLException - SQL例外
    
    QueryException - クエリデータエラー
  - generateCodes
```
public void generateCodes()
```
    テーブルコード、カラムコード、抽出条件コード、接続線コードを生成・付与します。
    既にセットされているコードが有効な場合は付与を行いません。
  - generateFromSql
```
public String generateFromSql()
                       throws SQLException,
                              QueryException
```
    クエリからSQL文(FROM句)を生成します。
    
    戻り値:
    
    SQL文
    
    例外:
    
    SQLException - SQL例外
    
    QueryException - クエリデータエラー
  - generateOrderbySql
```
public String generateOrderbySql(boolean alias)
                          throws SQLException
```
    クエリからSQL文(ORDER BY句)を生成します。
    
    パラメータ:
    
    alias - フィールド名に別名（カラムコード）を使用するかどうか
    
    戻り値:
    
    SQL文
    
    例外:
    
    SQLException - SQL例外
  - generateSelectSql
```
public String generateSelectSql(boolean alias)
                         throws SQLException
```
    クエリからSQL文(SELECT句)を生成します。
    
    パラメータ:
    
    alias - カラムの別名にフィールド名を使うかどうか
    
    戻り値:
    
    SQL文
    
    例外:
    
    SQLException - SQL例外
  - generateSql
```
public String generateSql(boolean alias)
                   throws SQLException,
                          QueryException
```
    SQL文を生成します。
    
    パラメータ:
    
    alias - SELECT句のカラムの別名にフィールド名を使うかどうか
    
    戻り値:
    
    SQL文
    
    例外:
    
    SQLException - SQL例外
    
    QueryException - クエリデータエラー
  - generateSql
```
public String generateSql(boolean alias,
                          boolean orderBy)
                   throws SQLException,
                          QueryException
```
    SQL文を生成します。
    
    パラメータ:
    
    alias - SELECT句のカラムの別名にフィールド名を使うかどうか
    
    orderBy - ORDER BY句を生成するかどうか
    
    戻り値:
    
    SQL文
    
    例外:
    
    SQLException - SQL例外
    
    QueryException - クエリデータエラー
  - generateWhereSql
```
public String generateWhereSql()
                        throws SQLException
```
    クエリからSQL文(WHERE句)を生成します。
    
    戻り値:
    
    SQL文
    
    例外:
    
    SQLException - SQL例外
  - getCategory
```
public VCQueryCategory getCategory()
```
    クエリのカテゴリ情報を取得します。
    
    戻り値:
    
    カテゴリ情報
  - getCode
```
public String getCode()
```
    クエリコードを取得します。
    
    戻り値:
    
    クエリコード
  - getColumn
```
public Column getColumn(String columnCode)
```
    Columnオブジェクトを取得します。
    
    パラメータ:
    
    columnCode - カラムコード
    
    戻り値:
    
    カラムオブジェクト
  - getColumn
```
public Column getColumn(String tableCode,
                        String columnName)
```
    カラムオブジェクトを取得します。
    
    パラメータ:
    
    tableCode - テーブルコード
    
    columnName - カラム名
    
    戻り値:
    
    カラムオブジェクト
  - getColumnCodeSet
```
public Set<String> getColumnCodeSet()
```
    このクエリに含まれるカラムのコードセットを取得します。
    
    戻り値:
    
    カラムコードセット
  - getColumns
```
public List<Column> getColumns()
```
    カラム一覧を取得します。
    
    戻り値:
    
    カラムの配列
  - getCondition
```
public Condition getCondition(String conditionCode)
```
    Conditionオブジェクトを取得します。
    
    パラメータ:
    
    conditionCode - 抽出条件コード
    
    戻り値:
    
    抽出条件の配列
  - getConditions
```
public List<Condition> getConditions()
```
    抽出条件一覧を取得します。
    
    戻り値:
    
    抽出条件の配列
  - getConditionwhere
```
public String getConditionwhere()
```
    直接入力されたWHERE句を取得します。
    
    戻り値:
    
    WHERE句文字列
  - getDataSource
```
public String getDataSource()
```
    データソース設定を取得します。
    
    戻り値:
    
    データソースID
  - getDocument
```
public Document getDocument()
                     throws IOException,
                            SAXException
```
    クエリの内容を示すＸＭＬデータを取得します。
    
    戻り値:
    
    XMLドキュメントインスタンス
    
    例外:
    
    SAXException - XML解析エラー
    
    IOException - 入出力例外
  - getInfo
```
public String getInfo()
```
    説明を取得します。
    
    戻り値:
    
    説明
  - getLines
```
public List<UnitLine> getLines()
```
    結合条件一覧を取得します。
    
    戻り値:
    
    結合条件の配列
  - getName
```
public String getName()
```
    クエリ名を取得します。
    
    戻り値:
    
    クエリ名
  - getQueryType
```
public QueryType getQueryType()
```
    クエリの種類を取得します。
    
    戻り値:
  - getSql
```
public String getSql()
```
    SQL文字列を取得します
    
    戻り値:
    
    SQL文字列
  - getSqlTableList
```
public List<Table> getSqlTableList()
```
    SQL定義されているテーブルの一覧を取得します。
    
    戻り値:
  - getTable
```
public Table getTable(String tableCode)
```
    Tableオブジェクトを取得します。
    
    パラメータ:
    
    tableCode - テーブルコード
    
    戻り値:
    
    テーブル
  - getTables
```
public List<Table> getTables()
```
    テーブル一覧を取得します。
    
    戻り値:
    
    テーブルの配列
  - getUpdated
```
public Date getUpdated()
```
    更新日を取得します。
    
    戻り値:
    
    更新日
  - hasDynamicParameter
```
public boolean hasDynamicParameter()
```
    指定されたクエリにダイナミックパラメータが設定されているかどうかを調べます。
    
    戻り値:
    
    true/false
  - hasNumberTypeColumn
```
public boolean hasNumberTypeColumn()
```
    このクエリが数値型のカラムを1つ以上持っているかどうかを調べます。
    
    戻り値:
    
    1つ以上の数値型カラムを持っている:true 数値型カラムが1つもない:false
  - hasSqlTable
```
public boolean hasSqlTable()
```
    SQL定義されているテーブルがクエリ内にあるかどうか調べます。
    
    戻り値:
    
    true: 存在する false:存在しない
  - isDirectwhere
```
public boolean isDirectwhere()
```
    WHERE句直接入力フラグを取得します。
    
    戻り値:
    
    true/false
  - isExpansion
```
public boolean isExpansion()
```
    このクエリが拡張データソースから作成されているかどうかを調べます。
    
    戻り値:
    
    true/false
  - isOrsearch
```
public boolean isOrsearch()
```
    複数の抽出条件が設定されたとき、OR検索にするかどうかを取得します。
    
    戻り値:
    
    true/false
  - setCategory
```
public void setCategory(VCQueryCategory category)
```
    クエリのカテゴリ情報をセットします。
    
    パラメータ:
    
    category - カテゴリ情報
  - setCategoryId
```
public void setCategoryId(String id)
```
    カテゴリIDをセットします。
    
    パラメータ:
    
    id - カテゴリID
  - setCategoryName
```
public void setCategoryName(String name)
```
    カテゴリ名をセットします。
    
    パラメータ:
    
    name - カテゴリ名
  - setCode
```
public void setCode(String code)
```
    クエリコードを設定します。
    ※登録時に自動生成されます。
    
    パラメータ:
    
    code - クエリコード
  - setColumn
```
public void setColumn(Column column)
```
    カラムを更新します。
    
    パラメータ:
    
    column - カラム
  - setColumns
```
public void setColumns(List<Column> columns)
```
    カラムを設定します。
    
    パラメータ:
    
    columns - カラムの配列
  - setConditions
```
public void setConditions(List<Condition> conditions)
```
    抽出条件を設定します。
    
    パラメータ:
    
    conditions - 抽出条件の配列
  - setConditionwhere
```
public void setConditionwhere(String conditionwhere)
```
    直接入力されたWHERE句をセットします。
    
    パラメータ:
    
    conditionwhere - WHERE句文字列
  - setDataSource
```
public void setDataSource(String dataSource)
```
    データソース設定を設定します。
    
    パラメータ:
    
    dataSource - データソースID
  - setDirectwhere
```
public void setDirectwhere(boolean directwhere)
```
    WHERE句直接入力フラグをセットします。
    
    パラメータ:
    
    directwhere - true/false
  - setDocument
```
public void setDocument(Document doc)
                 throws QueryException
```
    クエリを表すXMLデータを使用してクエリオブジェクトを再作成します。
    
    パラメータ:
    
    doc - XMLドキュメント
    
    例外:
    
    QueryException - XMLに不整合なデータが含まれていた場合にスローされます
  - setFormat
```
public void setFormat(boolean format)
```
    このクエリから生成するSQLをフォーマット整形するかどうかを設定します
    
    パラメータ:
    
    format - true:フォーマット整形する false:整形しない
  - setInfo
```
public void setInfo(String info)
```
    説明を設定します。
    
    パラメータ:
    
    info - 説明
  - setLines
```
public void setLines(List<UnitLine> lines)
```
    結合条件を設定します。
    
    パラメータ:
    
    lines - 結合条件の配列
  - setName
```
public void setName(String name)
```
    クエリ名を設定します。
    
    パラメータ:
    
    name - クエリ名
  - setOrsearch
```
public void setOrsearch(boolean orsearch)
```
    OR検索にするかどうかを設定します。
    
    パラメータ:
    
    orsearch - true/false
  - setTables
```
public void setTables(List<Table> tables)
```
    テーブルを設定します。
    
    パラメータ:
    
    tables - テーブルの配列
  - setUpdated
```
public void setUpdated(Date updated)
```
    更新日を設定します。
    
    パラメータ:
    
    updated - 更新日
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object

クラス VCQuery

フィールドのサマリー

クラスから継承されたフィールド jp.co.intra_mart.foundation.viewcreator.model.BaseModel

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド jp.co.intra_mart.foundation.viewcreator.model.BaseModel

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

NN_QUERY

コンストラクタの詳細

VCQuery

VCQuery

VCQuery

VCQuery

VCQuery

メソッドの詳細

addColumn

addCondition

addLine

addTable

checkError

checkError

execute

execute

execute

executeWithName

generateCodes

generateFromSql

generateOrderbySql

generateSelectSql

generateSql

generateSql

generateWhereSql

getCategory

getCode

getColumn

getColumn

getColumnCodeSet

getColumns

getCondition

getConditions

getConditionwhere

getDataSource

getDocument

getInfo

getLines

getName

getQueryType

getSql

getSqlTableList

getTable

getTables

getUpdated

hasDynamicParameter

hasNumberTypeColumn

hasSqlTable

isDirectwhere

isExpansion

isOrsearch

setCategory

setCategoryId

setCategoryName

setCode

setColumn

setColumns

setConditions

setConditionwhere

setDataSource

setDirectwhere

setDocument

setFormat

setInfo

setLines

setName

setOrsearch

setTables

setUpdated

toString