/*
 * Copyright (c) 2009 The openGion Project.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.opengion.hayabusa.taglib;

import org.opengion.fukurou.util.ErrorMessage;
import org.opengion.fukurou.util.ToString;						// 6.1.1.0 (2015/01/17)
import org.opengion.fukurou.util.ArraySet;						// 6.4.3.4 (2016/03/11)
import org.opengion.hayabusa.common.HybsSystem;
import org.opengion.hayabusa.common.HybsSystemException;
import org.opengion.hayabusa.db.DBTableModel;
import org.opengion.hayabusa.db.DBMetaData;

import static org.opengion.fukurou.util.StringUtil.nval ;
import static org.opengion.fukurou.system.HybsConst.BR;			// 6.1.0.0 (2014/12/26) refactoring

import java.util.Locale ;
import java.util.Set;											// 6.4.3.4 (2016/03/11)

/**
 * データベース情報(DBMetaData)より、テーブル、カラム等の情報を取得するタグです。
 *
 * データベースに関する包括的な情報を提供する、DatabaseMetaData の内容を
 * 取得して、DBTableModel にセットするタグです。
 *
 * @og.formSample
 * ●形式：&lt;og:dbMetaDataQuery action="･･･" ･･･ /&gt;
 * ●body：なし
 *
 * ●Tag定義：
 *   &lt;og:dbMetaDataQuery
 *       command            【TAG】コマンド[NEW/RENEW]をセットします(初期値:NEW)
 *       action           ○【TAG】アクション(SCHEMAS,TABLES,COLUMNS,INDEXINFO,PROCEDURES)を指定します(必須)。
 *       catalog            【TAG】カタログ名をセットします(初期値:null)
 *       schema             【TAG】スキーマ名パターンをセットします(初期値:null)
 *       tableName          【TAG】テーブル名パターンをセットします(初期値:null)
 *       columnName         【TAG】列名パターンをセットします(初期値:null)
 *       procName           【TAG】プロシージャ名パターンをセットします(初期値:null)
 *       unique             【TAG】返すインデックスの種類[true:ユニークのみ/false:非ユニーク含む]を指定します(初期値:false)
 *       approximate        【TAG】統計情報の精度[true:概数/false:正確]を指定します(初期値:true)
 *       scope              【TAG】キャッシュする場合のスコープ[request/page/session/application]を指定します(初期値:session)
 *       displayMsg         【TAG】検索結果を画面上に表示するメッセージリソースIDを指定します(初期値:MSG0033[　件検索しました])
 *       notfoundMsg        【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした])
 *       tableId            【TAG】(通常は使いません)結果をDBTableModelに書き込んで、sessionに登録するときのキーを指定します
 *       dbid               【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します
 *       mainTrans          【TAG】(通常は使いません)タグで処理される処理がメインとなるトランザクション処理かどうかを指定します(初期値:false)
 *       useTimeView        【TAG】処理時間を表示する TimeView を表示するかどうかを指定します
 *										(初期値:VIEW_USE_TIMEBAR[={@og.value SystemData#VIEW_USE_TIMEBAR}])。
 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
 *   /&gt;
 *
 * ●使用例
 *    command属性 は、columnSetタグのcommand属性と同一の場合のみ、処理します。
 *    [command属性]
 *      NEW       新規
 *      RENEW     再検索
 *
 *    [action属性]
 *      SCHEMAS    このデータベースで使用可能なスキーマ名を取得します。
 *      TABLES     指定されたカタログで使用可能なテーブルに関する記述を取得します。
 *      COLUMNS    指定されたカタログで使用可能なテーブル列の記述を取得します。
 *      INDEXINFO  指定されたテーブルのインデックスと統計情報に関する記述を取得します。
 *      PROCEDURES 指定されたカタログで使用可能なストアドプロシージャに関する記述を取得します。
 *
 * @og.group ＤＢ検索
 *
 * @version  4.0
 * @author	 Kazuhiko Hasegawa
 * @since    JDK5.0,
 */
public class DBMetaDataQueryTag extends CommonTagSupport {
	/** このプログラムのVERSION文字列を設定します。	{@value} */
	private static final String VERSION = "6.4.3.4 (2016/03/11)" ;
	private static final long serialVersionUID = 643420160311L ;

	/** command 引数に渡す事の出来る コマンド  新規 {@value} */
	public static final String CMD_NEW	 = "NEW" ;
	/** command 引数に渡す事の出来る コマンド  再検索 {@value} */
	public static final String CMD_RENEW = "RENEW" ;

	/** action 引数に渡す事の出来る アクションコマンド  スキーマ名 {@value} */
	public static final String ACT_SCHEMAS     = "SCHEMAS" ;
	/** action 引数に渡す事の出来る アクションコマンド  テーブル {@value} */
	public static final String ACT_TABLES      = "TABLES" ;
	/** action 引数に渡す事の出来る アクションコマンド  テーブル列 {@value} */
	public static final String ACT_COLUMNS     = "COLUMNS" ;
	/** action 引数に渡す事の出来る アクションコマンド  インデックスと統計情報{@value} */
	public static final String ACT_INDEXINFO   = "INDEXINFO" ;
	/** action 引数に渡す事の出来る アクションコマンド  ストアドプロシージャ{@value} */
	public static final String ACT_PROCEDURES  = "PROCEDURES" ;

	// 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。
	private static final Set<String> COMMAND_SET = new ArraySet<>( CMD_NEW , CMD_RENEW );
	private static final Set<String> ACTION_SET = new ArraySet<>( ACT_SCHEMAS , ACT_TABLES , ACT_COLUMNS , ACT_INDEXINFO , ACT_PROCEDURES );

	private String	tableId	    = HybsSystem.TBL_MDL_KEY;

	private String	command		= "NEW";
	private String	action		;				// taglib で必須属性にします。
	private String	displayMsg	= HybsSystem.sys( "VIEW_DISPLAY_MSG" );
	private String	notfoundMsg	= "MSG0077";	// 対象データはありませんでした。

	// 4.0.0.0 (2007/10/10) dbid の初期値を、"DEFAULT" から null に変更
	private String	dbid		;
	private String	catalog		;
	private String	schema		;
	private String	tableName	;
	private String	procName	;
	private String	columnName	;
	private boolean	unique		;			// true:ユニークのみ / false:非ユニーク含む
	private boolean	approximate	= true;		// true:概数 / false:正確
	private boolean	isMainTrans	= true;		// 5.1.6.0 (2010/05/01) DBLastSqlの処理の見直し

	private long	dyStart 	;				// 実行時間測定用のDIV要素
	private boolean	useTimeView	= HybsSystem.sysBool( "VIEW_USE_TIMEBAR" );		// 6.3.6.0 (2015/08/16)

	/**
	 * デフォルトコンストラクター
	 *
	 * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
	 */
	public DBMetaDataQueryTag() { super(); }		// これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。

	/**
	 * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
	 *
	 * @og.rev 5.1.6.0 (2010/05/01) DBLastSqlの処理は、DBTableModelが新規作成された処理でのみ行う。
	 * @og.rev 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。
	 *
	 * @return	後続処理の指示(SKIP_BODY)
	 */
	@Override
	public int doStartTag() {
		dyStart = System.currentTimeMillis();
		if( ! check( command, COMMAND_SET ) ) { return SKIP_BODY ; }

		useMainTrans( isMainTrans );			// 5.1.6.0 (2010/05/01) DBLastSqlの処理の見直し
		startQueryTransaction( tableId );		// 3.6.0.8 (2004/11/19)

		// 3.5.6.5 (2004/08/09) 削除するのは、セッションのオブジェクトでよい。
		// 3.6.0.0 (2004/09/24) 削除するのは、scope="session" の場合のみ。
		if( "session".equals( getScope() ) ) {
			removeSessionAttribute( tableId );
			removeSessionAttribute( HybsSystem.VIEWFORM_KEY );
		}

		return SKIP_BODY ;				// Body を評価しない
	}

	/**
	 * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
	 *
	 * @og.rev 4.0.0.0 (2006/11/14) notfoundMsg 属性を追加。displayMsg は、VIEW_USE_DISPLAY_MSG で制御
	 * @og.rev 4.0.0.0 (2007/10/18) メッセージリソース統合( getResource().getMessage ⇒ getResource().getLabel )
	 * @og.rev 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。
	 *
	 * @return	後続処理の指示
	 */
	@Override
	public int doEndTag() {
		debugPrint();		// 4.0.0 (2005/02/28)

		String label  = "";				// 4.0.0 (2005/11/30) 検索しなかった場合。
		if( check( command, COMMAND_SET ) ) {
			final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );

			final DBTableModel table = actionExec( action );
			final int executeCount = table.getRowCount();	// 検索した数

			// 実行件数の表示 command="NEW" のときのみ、displayMsg を表示させます。
			// 4.0.0 (2005/11/30) 出力順の変更。一番最初に出力します。
			if(  CMD_NEW.equals( command ) ) {
				if( executeCount > 0 && displayMsg != null && displayMsg.length() > 0 ) {
					buf.append( executeCount )
						.append( getResource().getLabel( displayMsg ) )
						.append( BR );
				}
				else if( executeCount == 0 && notfoundMsg != null && notfoundMsg.length() > 0 ) {
					buf.append( getResource().getLabel( notfoundMsg ) )
						.append( BR );
				}
			}

			// 3.3.3.3 (2003/08/06) 検索結果の件数を、"DB.COUNT" キーでリクエストにセットする。
			setRequestAttribute( "DB.COUNT"   , String.valueOf( executeCount ) );
			// 3.3.3.3 (2003/08/06) 検索結果を、"DB.ERR_CODE" キーでリクエストにセットする。
			setRequestAttribute( "DB.ERR_CODE", String.valueOf( ErrorMessage.OK ) );

			// オーバーフロー時のメッセージを表示
	//		if( table != null && table.isOverflow() ) {
	//			buf.append( getResource().getMessage( overflowMsg ) );
	//			buf.append( BR );
	//		}

			// 実行件数の表示
			// 2.0.0.8 (2002/10/09) command="NEW" のときのみ、displayMsg を表示させます。
	//		if( displayMsg != null && displayMsg.length() > 0 && command.equals( CMD_NEW ) ) {
	//			buf.append( executeCount );
	//			buf.append( getResource().getMessage( displayMsg ) );
	//			buf.append( BR );
	//		}

			label = buf.toString();

			// 3.6.0.8 (2004/11/19) トランザクションチェックを行います。
			if( ! commitTableObject( tableId, table ) ) {
				jspPrint( "DBMetaDataQueryTag Query処理が割り込まれました。DBTableModel は登録しません。" );
				return SKIP_PAGE;
			}
		}
		jspPrint( label );

		if( useTimeView ) {		// 6.3.6.0 (2015/08/16)
			// 3.5.4.7 (2004/02/06)
			final long dyTime = System.currentTimeMillis()-dyStart;
			jspPrint( "<div id=\"queryTime\" value=\"" + (dyTime) + "\"></div>" );	// 3.5.6.3 (2004/07/12)
		}
		return EVAL_PAGE;
	}

	/**
	 * タグリブオブジェクトをリリースします。
	 * キャッシュされて再利用されるので、フィールドの初期設定を行います。
	 *
	 * @og.rev 4.0.0.0 (2007/10/10) dbid の初期値を、"DEFAULT" から null に変更
	 * @og.rev 5.1.6.0 (2010/05/01) DBLastSqlの処理は、DBTableModelが新規作成された処理でのみ行う。
	 */
	@Override
	protected void release2() {
		super.release2();
		tableId	    = HybsSystem.TBL_MDL_KEY;
		dbid		= null;
		catalog		= null;
		schema		= null;
		tableName	= null;
		procName	= null;
		columnName	= null;
		unique		= false;	// true:ユニークのみ / false:非ユニーク含む
		approximate	= true;		// true:概数 / false:正確
		displayMsg	= HybsSystem.sys( "VIEW_DISPLAY_MSG" );
		notfoundMsg	= "MSG0077";	// 対象データはありませんでした。
		isMainTrans	= true;			// 5.1.6.0 (2010/05/01) DBLastSqlの処理の見直し
		useTimeView	= HybsSystem.sysBool( "VIEW_USE_TIMEBAR" );	// 6.3.6.0 (2015/08/16)
	}

	/**
	 * 指定のアクションを実行し、結果を、DBTableModel にセットして返します。
	 * アクションは、(SCHEMAS,TABLES,COLUMNS,INDEXINFO,PROCEDURES)を指定します。
	 *
	 *      SCHEMAS    このデータベースで使用可能なスキーマ名を取得します。
	 *      TABLES     指定されたカタログで使用可能なテーブルに関する記述を取得します。
	 *      COLUMNS    指定されたカタログで使用可能なテーブル列の記述を取得します。
	 *      INDEXINFO  指定されたテーブルのインデックスと統計情報に関する記述を取得します。
	 *      PROCEDURES 指定されたカタログで使用可能なストアドプロシージャに関する記述を取得します。
	 *
	 * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
	 *
	 * @param	action	アクション文字列
	 *
	 * @return	テーブルモデル
	 * @see		<a href="../../../../constant-values.html#org.opengion.hayabusa.taglib.DBMetaDataQueryTag.ACT_COLUMNS">アクション定数</a>
	 */
	private DBTableModel actionExec( final String action ) {
		final DBMetaData metaData = new DBMetaData();
		metaData.setDbid( dbid );
		metaData.setResourceManager( getResource() );
		metaData.setApplicationInfo( getApplicationInfo() );	// 3.8.7.0 (2006/12/15)

		DBTableModel tbl = null;

		if( ACT_SCHEMAS.equals( action ) ) {
			tbl = metaData.getSchemas() ;
		}
		else if( ACT_TABLES.equals( action ) ) {
			tbl = metaData.getTables( catalog, schema, tableName ) ;
		}
		else if( ACT_COLUMNS.equals( action ) ) {
			tbl = metaData.getColumns(catalog, schema, tableName, columnName) ;
		}
		else if( ACT_INDEXINFO.equals( action ) ) {
			tbl = metaData.getIndexInfo(catalog, schema, tableName, unique, approximate) ;
		}
		else if( ACT_PROCEDURES.equals( action ) ) {
			tbl = metaData.getProcedures(catalog, schema, procName) ;
		}

		return tbl ;
	}

	/**
	 * 【TAG】コマンド[NEW/RENEW]をセットします(初期値:NEW)。
	 *
	 * @og.tag
	 * コマンドは,HTMLから(get/post)指定されますので,CMD_xxx で設定される
	 * フィールド定数値のいづれかを、指定できます。
	 *
	 * @param	cmd コマンド (public static final 宣言されている文字列)
	 * @see		<a href="../../../../constant-values.html#org.opengion.hayabusa.taglib.DBMetaDataQueryTag.CMD_NEW">コマンド定数</a>
	 */
	public void setCommand( final String cmd ) {
		final String cmd2 = getRequestParameter( cmd );
		if( cmd2 != null && cmd2.length() > 0 ) { command = cmd2.toUpperCase(Locale.JAPAN); }
	}

	/**
	 * 【TAG】アクション(SCHEMAS,TABLES,COLUMNS,INDEXINFO,PROCEDURES)を指定します。
	 *
	 * @og.tag
	 * アクションは,HTMLから(get/post)指定されますので,ACT_xxx で設定される
	 * フィールド定数値のいづれかを、指定できます。
	 *
	 *      SCHEMAS    このデータベースで使用可能なスキーマ名を取得します。
	 *      TABLES     指定されたカタログで使用可能なテーブルに関する記述を取得します。
	 *      COLUMNS    指定されたカタログで使用可能なテーブル列の記述を取得します。
	 *      INDEXINFO  指定されたテーブルのインデックスと統計情報に関する記述を取得します。
	 *      PROCEDURES 指定されたカタログで使用可能なストアドプロシージャに関する記述を取得します。
	 *
	 * @og.rev 6.3.4.0 (2015/08/01) Arrays.toString から String.join に置き換え。
	 * @og.rev 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。
	 *
	 * @param	cmd アクション文字列
	 * @see		<a href="../../../../constant-values.html#org.opengion.hayabusa.taglib.DBMetaDataQueryTag.ACT_COLUMNS">アクション定数</a>
	 */
	public void setAction( final String cmd ) {
		action = getRequestParameter( cmd );

		if( ! check( action, ACTION_SET ) ) {
			final String errMsg = "指定のアクションは実行できません。アクションエラー"	+ CR
								+ "action=[" + action + "] "							+ CR
								+ "actionList=[" + String.join( ", " , ACTION_SET ) + "]" ;
			throw new HybsSystemException( errMsg );
		}
	}

	/**
	 * 【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します(初期値:null)。
	 *
	 * @og.tag Queryオブジェクトを作成する時のDB接続IDを指定します。
	 *
	 * @param	id データベース接続ID
	 */
	public void setDbid( final String id ) {
		dbid = nval( getRequestParameter( id ),dbid );
	}

	/**
	 * 【TAG】(通常は使いません)Queryオブジェクトを作成する時のカタログを指定します(初期値:null)。
	 *
	 * @og.tag データベースに格納されたカタログ名と一致しなければならない。
	 * "" はカタログなしでカタログ名を検索する。
	 * null は、カタログ名を検索の限定に使用してはならないことを意味する
	 *
	 * @param	catalog カタログ名
	 */
	public void setCatalog( final String catalog ) {
		this.catalog = nval( getRequestParameter( catalog ),this.catalog );
	}

	/**
	 * 【TAG】スキーマ名パターンをセットします(初期値:null)。
	 *
	 * @og.tag データベースに格納されたスキーマ名と一致しなければならない。
	 * "" はスキーマなしでスキーマ名を検索する。
	 * null は、スキーマ名を検索の限定に使用してはならないことを意味する
	 *
	 * @param	schema スキーマ名パターン
	 */
	public void setSchema( final String schema ) {
		this.schema = nval( getRequestParameter( schema ),this.schema );
	}

	/**
	 * 【TAG】テーブル名パターンをセットします(初期値:null)。
	 *
	 * @og.tag 。データベースに格納されたテーブル名と一致しなければならない
	 *
	 * @param	tableName テーブル名パターン
	 */
	public void setTableName( final String tableName ) {
		this.tableName = nval( getRequestParameter( tableName ),this.tableName );
	}

	/**
	 * 【TAG】プロシージャ名パターンをセットします(初期値:null)。
	 *
	 * @og.tag 。データベースに格納されたプロシージャ名と一致しなければならない
	 *
	 * @param	procName プロシージャ名パターン
	 */
	public void setProcName( final String procName ) {
		this.procName = nval( getRequestParameter( procName ),this.procName );
	}

	/**
	 * 【TAG】列名パターンをセットします(初期値:null)。
	 *
	 * @og.tag データベースに格納された列名と一致しなければならない
	 *
	 * @param	columnName 列名パターン
	 */
	public void setColumnName( final String columnName ) {
		this.columnName = nval( getRequestParameter( columnName ),this.columnName );
	}

	/**
	 * 【TAG】返すインデックスの種類[true:ユニークのみ/false:非ユニーク含む]を指定します(初期値:false)。
	 *
	 * @og.tag  true の場合は、一意の値のインデックスだけを返す。
	 * false の場合は、一意であるかどうかにかかわらずインデックスを返す
	 * 初期値は、false:非ユニーク含む です。
	 *
	 * @param	uniqFlag 返すインデックスの種類 [true:ユニークのみ/false:非ユニーク含む]
	 */
	public void setUnique( final String uniqFlag ) {
		this.unique = nval( getRequestParameter( uniqFlag ),this.unique );
	}

	/**
	 * 【TAG】統計情報の精度[true:概数/false:正確]を指定します(初期値:true)。
	 *
	 * @og.tag 指定されたテーブルのインデックスと統計情報に関する記述を取得する場合に
	 * 結果の精度を指定します。
	 * true の場合は、結果は概数またはデータ値から外れることもある。
	 * false の場合は、正確であることが要求される
	 * 初期値は、true:概数 です。
	 *
	 * @param	appFlag 統計情報の精度 [true:概数/false:正確]
	 */
	public void setApproximate( final String appFlag ) {
		this.approximate = nval( getRequestParameter( appFlag ),this.approximate );
	}

	/**
	 * 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
	 *		(初期値:HybsSystem#TBL_MDL_KEY[={@og.value HybsSystem#TBL_MDL_KEY}])。
	 *
	 * @og.tag
	 * 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に
	 * 渡す場合に、通常は、session を利用します。その場合の登録キーです。
	 * query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、
	 * この tableId 属性を利用して、メモリ空間を分けます。
	 *		(初期値:HybsSystem#TBL_MDL_KEY[={@og.value HybsSystem#TBL_MDL_KEY}])。
	 *
	 * @param	id テーブルID (sessionに登録する時のID)
	 */
	public void setTableId( final String id ) {
		this.tableId = nval( getRequestParameter( id ),tableId );
	}

	/**
	 * 【TAG】検索結果を画面上に表示するメッセージリソースIDを指定します
	 *		(初期値:VIEW_DISPLAY_MSG[={@og.value SystemData#VIEW_DISPLAY_MSG}])。
	 *
	 * @og.tag
	 * ここでは、検索結果の件数や登録された件数をまず出力し、
	 * その次に、ここで指定したメッセージをリソースから取得して
	 * 表示します。
	 * 件数を表示させる場合は、displayMsg = "MSG0033"[　件検索しました] をセットしてください。
	 * 表示させたくない場合は, displayMsg = "" をセットしてください。
	 * (初期値:システム定数のVIEW_DISPLAY_MSG[={@og.value SystemData#VIEW_DISPLAY_MSG}])。
	 *
	 * @param	id 処理結果表示メッセージID
	 */
	public void setDisplayMsg( final String id ) {
		final String ids = getRequestParameter( id );
		if( ids != null ) { displayMsg = ids; }
	}

	/**
	 * 【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした])。
	 *
	 * @og.tag
	 * ここでは、検索結果がゼロ件の場合のみ、特別なメッセージを表示させます。
	 * 従来は、displayMsg と兼用で、『0　件検索しました』という表示でしたが、
	 * displayMsg の初期表示は、OFF になりましたので、ゼロ件の場合のみ別に表示させます。
	 * 表示させたくない場合は, notfoundMsg = "" をセットしてください。
	 * 初期値は、MSG0077[対象データはありませんでした]です。
	 *
	 * @param	id ゼロ件時表示メッセージID
	 */
	public void setNotfoundMsg( final String id ) {
		final String ids = getRequestParameter( id );
		if( ids != null ) { notfoundMsg = ids; }
	}

	/**
	 * 【TAG】処理時間を表示する TimeView を表示するかどうか[true:する/false:しない]を指定します
	 *		(初期値:VIEW_USE_TIMEBAR[={@og.value SystemData#VIEW_USE_TIMEBAR}])。
	 *
	 * @og.tag
	 * true に設定すると、処理時間を表示するバーイメージが表示されます。
	 * これは、DB検索、APサーバー処理、画面表示の各処理時間をバーイメージで
	 * 表示させる機能です。処理時間の目安になります。
	 * (初期値:VIEW_USE_TIMEBAR[={@og.value SystemData#VIEW_USE_TIMEBAR}])。
	 *
	 * @og.rev 6.3.6.0 (2015/08/16) useTimeView の初期値を、VIEW_USE_TIMEBAR にする。
	 *
	 * @param	flag	処理時間を表示 [true:する/false:しない]
	 */
	public void setUseTimeView( final String flag ) {
		useTimeView = nval( getRequestParameter( flag ),useTimeView );
	}

	/**
	 * タグの名称を、返します。
	 * 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。
	 *
	 * @og.rev 4.0.0.0 (2005/01/31) 新規追加
	 *
	 * @return  タグの名称
	 * @og.rtnNotNull
	 */
	@Override
	protected String getTagName() {
		return "dbMetaDataQuery" ;
	}

	/**
	 * 【TAG】(通常は使いません)タグで処理される処理がメインとなるトランザクション処理かどうかを指定します(初期値:true)。
	 *
	 * @og.tag
	 * この値は、ファイルダウンロード処理に影響します。この値がtrueに指定された時にcommitされたDBTableModelが
	 * ファイルダウンロードの対象の表になります。
	 *
	 * このパラメーターは、通常、各タグにより実装され、ユーザーが指定する必要はありません。
	 * 但し、1つのJSP内でDBTableModelが複数生成される場合に、前に処理したDBTableModelについてファイルダウンロードをさせたい
	 * 場合は、後ろでDBTableModelを生成するタグで、明示的にこの値をfalseに指定することで、ファイルダウンロード処理の対象から
	 * 除外することができます。
	 *
	 * @og.rev 5.1.6.0 (2010/05/01) 新規作成
	 *
	 * @param  flag メイントランザクションかどうか [true:メイン/false:その他]
	 */
	public void setMainTrans( final String flag ) {
		isMainTrans = nval( getRequestParameter( flag ),isMainTrans );
	}

	/**
	 * このオブジェクトの文字列表現を返します。
	 * 基本的にデバッグ目的に使用します。
	 *
	 * @return このクラスの文字列表現
	 * @og.rtnNotNull
	 */
	@Override
	public String toString() {
		return ToString.title( this.getClass().getName() )
				.println( "VERSION"		,VERSION	)
				.println( "tableId"	    ,tableId	)
				.println( "command"		,command	)
				.println( "action"		,action		)
				.println( "displayMsg"	,displayMsg	)
				.println( "dbid"		,dbid		)
				.println( "catalog"		,catalog	)
				.println( "schema"		,schema		)
				.println( "tableName"	,tableName	)
				.println( "procName"	,procName	)
				.println( "columnName"	,columnName	)
				.println( "unique"		,unique		)
				.println( "approximate"	,approximate)
				.println( "Other..."	,getAttributes().getAttribute() )
				.fixForm().toString() ;
	}
}
