jp.co.intra_mart.foundation.viewcreator

クラス QueryManager

java.lang.Object

jp.co.intra_mart.foundation.viewcreator.QueryManager

public final class QueryManager
extends Object

ViewCreatorの「クエリ」を管理するマネージャオブジェクトです。
このAPIを通してクエリデータの検索や取得、及び登録・削除を行います。

導入されたバージョン:

8.0.0

バージョン:

8.0.24

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	REVERSE_FALSE フィールド名・以外フラグFalse
static String	REVERSE_TRUE フィールド名・以外フラグTrue

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static int	count(String queryName, QueryType queryType, boolean withpermission) クエリの件数を取得します。
static int	count(String queryName, QueryType queryType, String categoryId, boolean withpermission) クエリの件数を取得します。
static QueryListItem[]	find(String queryName, QueryType queryType, boolean withpermission, String sortFieldName, boolean desc, int start, int length) クエリの一覧を取得します。
static QueryListItem[]	find(String queryName, QueryType queryType, String categoryId, boolean withpermission, String sortFieldName, boolean desc, int start, int length) クエリの一覧を取得します。
static VCQuery	get(String queryCode) クエリを取得します。
static VCQuery	get(String queryCode, boolean withpermission) クエリを取得します。
static String	getParameter(String key) システムパラメータを取得します。
static String[]	getSystemParameterKeys() 抽出条件に設定可能なシステムパラメータのキー一覧を取得します。
static String[]	getSystemParameterKeys4Range() 抽出条件に設定可能なシステムパラメータのキー一覧（範囲検索用）を取得します。
static void	insert(VCQuery query) クエリを新規追加します。
static boolean	isSystemParameterKey(String key) 指定された文字列がシステムパラメータのキーとして有効かどうか判定します。
static void	regist(VCQuery query) 非推奨です。
static void	register(VCQuery query) クエリを登録します。
static void	remove(String queryCode) クエリを削除します。
static void	remove(String[] queryCodes) クエリを削除します。
static VCQuery[]	search() 登録されているクエリの一覧を取得します。
static VCQuery[]	search(String queryName) クエリの一覧を取得します。
static VCQuery[]	search(String queryName, boolean withpermission) クエリの一覧を取得します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

REVERSE_TRUE

public static final String REVERSE_TRUE

フィールド名・以外フラグTrue

関連項目:

定数フィールド値

REVERSE_FALSE

public static final String REVERSE_FALSE

フィールド名・以外フラグFalse

関連項目:

定数フィールド値

メソッドの詳細

get

public static VCQuery get(String queryCode)

クエリを取得します。

パラメータ:

queryCode - クエリコード（完全一致）

戻り値:

クエリ

get

public static VCQuery get(String queryCode,
                          boolean withpermission)

クエリを取得します。
取得に失敗した場合はnullが返却されます。
テーブルのアクセス権調査を行った場合、 クエリの中に1つでもカレントユーザに対してアクセス許可されていないテーブルが含まれている場合は取得に失敗します。

パラメータ:

queryCode - クエリコード（完全一致）

withpermission - クエリに含まれるテーブルのアクセス権調査を行うかどうか。

戻り値:

クエリ

getParameter

public static String getParameter(String key)

システムパラメータを取得します。

パラメータ:

key - システムパラメータのキー<%～%>

戻り値:

取得されたシステムパラメータ値

getSystemParameterKeys

public static String[] getSystemParameterKeys()

抽出条件に設定可能なシステムパラメータのキー一覧を取得します。
システムパラメータは、conf/viewcreator.xmlで設定します。

戻り値:

キー一覧

getSystemParameterKeys4Range

public static String[] getSystemParameterKeys4Range()

抽出条件に設定可能なシステムパラメータのキー一覧（範囲検索用）を取得します。
システムパラメータは、conf/viewcreator.xmlで設定します。

戻り値:

キー一覧

isSystemParameterKey

public static boolean isSystemParameterKey(String key)

指定された文字列がシステムパラメータのキーとして有効かどうか判定します。

パラメータ:

key - キー文字列

戻り値:

有効/無効

regist

@Deprecated
public static void regist(VCQuery query)
                               throws QueryException,
                                      SQLException

非推奨です。

クエリを登録します。

パラメータ:

query - 登録するクエリ

例外:

QueryException - クエリの設定内容にエラーがあった場合にスローされます

SQLException - クエリの登録処理で失敗した場合にスローされます

insert

public static void insert(VCQuery query)
                   throws QueryException,
                          SQLException

クエリを新規追加します。

パラメータ:

query - 登録するクエリ

例外:

QueryException - 登録済みのクエリであるか、クエリの設定内容にエラーがあった場合にスローされます

SQLException - クエリの登録処理で失敗した場合にスローされます

register

public static void register(VCQuery query)
                     throws QueryException,
                            SQLException

クエリを登録します。

パラメータ:

query - 登録するクエリ

例外:

QueryException - クエリの設定内容にエラーがあった場合にスローされます

SQLException - クエリの登録処理で失敗した場合にスローされます

remove

public static void remove(String queryCode)
                   throws QueryException,
                          SQLException

クエリを削除します。

パラメータ:

queryCode - クエリコード

例外:

QueryException - 削除権限が無い場合にスローされます

SQLException - 削除処理に失敗した場合にスローされます

remove

public static void remove(String[] queryCodes)
                   throws QueryException,
                          SQLException

クエリを削除します。

パラメータ:

queryCodes - クエリコードの配列

例外:

QueryException - 削除権限が無い場合にスローされます

SQLException - 削除処理に失敗した場合にスローされます

search

public static VCQuery[] search()

登録されているクエリの一覧を取得します。

戻り値:

クエリの配列

search

public static VCQuery[] search(String queryName)

クエリの一覧を取得します。

パラメータ:

queryName - 検索文字列（クエリ名・部分一致）

戻り値:

クエリの配列

search

public static VCQuery[] search(String queryName,
                               boolean withpermission)

クエリの一覧を取得します。

パラメータ:

queryName - 検索文字列（クエリ名・部分一致）

withpermission - クエリに含まれるテーブルのアクセス権調査を行うかどうか。

戻り値:

クエリの配列

find

public static QueryListItem[] find(String queryName,
                                   QueryType queryType,
                                   boolean withpermission,
                                   String sortFieldName,
                                   boolean desc,
                                   int start,
                                   int length)

クエリの一覧を取得します。

パラメータ:

queryName - 検索文字列（クエリ名・部分一致）

queryType - クエリの種類

withpermission - クエリに含まれるテーブルのアクセス権調査を行うかどうか。

sortFieldName - ソートフィールド名

desc - ソート順。trueの場合降順、falseの場合昇順

start - 取得開始位置

length - 取得件数

戻り値:

クエリの配列

find

public static QueryListItem[] find(String queryName,
                                   QueryType queryType,
                                   String categoryId,
                                   boolean withpermission,
                                   String sortFieldName,
                                   boolean desc,
                                   int start,
                                   int length)

クエリの一覧を取得します。
カテゴリIDで絞り込んだ結果を返します。カテゴリIDがnullの場合はnullで絞り込みます。

パラメータ:

queryName - 検索文字列（クエリ名・部分一致）

queryType - クエリの種類

categoryId - カテゴリーID

withpermission - クエリに含まれるテーブルのアクセス権調査を行うかどうか。

sortFieldName - ソートフィールド名

desc - ソート順。trueの場合降順、falseの場合昇順

start - 取得開始位置

length - 取得件数

戻り値:

クエリの配列

count

public static int count(String queryName,
                        QueryType queryType,
                        boolean withpermission)

クエリの件数を取得します。

パラメータ:

queryName - 検索文字列（クエリ名・部分一致）

queryType - クエリの種類

withpermission - クエリに含まれるテーブルのアクセス権調査を行うかどうか。

戻り値:

クエリの件数

count

public static int count(String queryName,
                        QueryType queryType,
                        String categoryId,
                        boolean withpermission)

クエリの件数を取得します。
カテゴリIDで絞り込んだ結果を返します。カテゴリIDがnullの場合はnullで絞り込みます。

パラメータ:

queryName - 検索文字列（クエリ名・部分一致）

queryType - クエリの種類

categoryId - カテゴリID

withpermission - クエリに含まれるテーブルのアクセス権調査を行うかどうか。

戻り値:

クエリの件数