001/* 002 * Copyright (c) 2009 The openGion Project. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 013 * either express or implied. See the License for the specific language 014 * governing permissions and limitations under the License. 015 */ 016package org.opengion.plugin.column; 017 018import org.opengion.hayabusa.common.HybsSystemException; 019 020import org.opengion.hayabusa.db.AbstractRenderer; 021import org.opengion.hayabusa.db.CellRenderer; 022import org.opengion.hayabusa.db.DBColumn; 023import org.opengion.hayabusa.db.Selection; 024import org.opengion.hayabusa.db.SelectionFactory; 025import org.opengion.fukurou.util.StringFormat; 026 027/** 028 * DBMENU レンデラーは、表示パラメータで指定された SQL文を実行し、 029 * プルダウンメニューで表示する場合に使用するクラスです。 030 * 031 * ここでは、AAA:BBB:CCC:DDD という値を、$1,$2,$3,$4 に割り当てなおして、 032 * QUERYを実行します。また、$1 は、本来の値として、メニューの初期値設定等に 033 * 使用します。上記の例では、AAA が値で、それ以降は、引数になります。 034 * さらに、元の文字列"AAA:BBB:CCC:DDD"は、$0 に割り当てられます。割り当てがない 035 * 変数は、""(ゼロ文字列)として、扱われます。 036 * 又、$Cには自分自身のカラム名を割り当てます。 037 * 038 * カラムの表示に必要な属性は、DBColumn オブジェクト より取り出します。 039 * このクラスは、DBColumn オブジェクト毎に１つ作成されます。 040 * 041 * @og.rev 3.2.3.0 (2003/06/06) 新規作成 042 * @og.rev 3.4.0.1 (2003/09/03) ＤＢ検索をリアルタイムに変更。 043 * @og.rev 3.5.4.2 (2003/12/15) 継承元クラスを、Editor_DBMENU から AbstractRenderer に変更。 044 * @og.group データ表示 045 * 046 * @version 4.0 047 * @author Kazuhiko Hasegawa 048 * @since JDK5.0, 049 */ 050// 8.5.5.1 (2024/02/29) spotbugs CT_CONSTRUCTOR_THROW(ｺﾝｽﾄﾗｸﾀで、Excweptionを出さない) class を final にすれば、警告は消える。 051// public class Renderer_DBMENU extends AbstractRenderer { 052public final class Renderer_DBMENU extends AbstractRenderer { 053 /** このプログラムのVERSION文字列を設定します。 {@value} */ 054 private static final String VERSION = "6.2.0.0 (2015/02/27)" ; 055 056 private final String query ; 057 private final String dbid ; 058 private final String lang ; // 4.0.0 (2006/11/15) 059 private final String name ; 060 private final String useSLabel ; // 5.5.1.0 (2012/04/03) 061 private final String noDisplayVal ; // 5.6.2.3 (2013/03/22) 062 private final String addKeyLabel ; // 6.2.0.0 (2015/02/27) キー:ラベル形式 063 064 /** 065 * デフォルトコンストラクター。 066 * このコンストラクターで、基本オブジェクトを作成します。 067 * 068 * @og.rev 3.4.0.2 (2003/09/05) クラス内部見直し。query の final 化 069 * @og.rev 3.5.4.2 (2003/12/15) name , query 変数を、初期設定しておきます。 070 * @og.rev 5.6.2.3 (2013/03/22) noDisplayVal 変数初期化 071 * @og.rev 6.2.0.0 (2015/02/27) キー:ラベル形式で表示するかどうかを、指定できるようにします。 072 */ 073 public Renderer_DBMENU() { 074 super(); // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor 075 query = null; // 3.5.4.2 (2003/12/15) 076 dbid = null; 077 lang = null; // 4.0.0 (2006/11/15) 078 name = null; // 3.5.4.2 (2003/12/15) 079 useSLabel = "auto"; // 5.5.1.0 (2012/04/03) 080 noDisplayVal = null; // 5.5.1.0 (2012/04/03) 081 addKeyLabel = null; // 6.2.0.0 (2015/02/27) キー:ラベル形式 082 } 083 084 /** 085 * DBColumnオブジェクトを指定したprivateコンストラクター。 086 * 087 * @og.rev 3.3.1.1 (2003/07/03) CodeSelection の設定において、バグ修正。 088 * @og.rev 3.4.0.1 (2003/09/03) 継承の親元の変更に伴う実装の移動。 089 * @og.rev 3.5.4.2 (2003/12/15) 継承元クラスを、Editor_DBMENU から AbstractRenderer に変更。 090 * @og.rev 3.5.5.9 (2004/06/07) getRendererParam 属性が null の場合は、エラーとします。 091 * @og.rev 5.6.2.3 (2013/03/22) noDisplayVal 変数追加 092 * @og.rev 6.2.0.0 (2015/02/27) キー:ラベル形式で表示するかどうかを、指定できるようにします。 093 * 094 * @param clm DBColumnオブジェクト 095 */ 096 private Renderer_DBMENU( final DBColumn clm ) { 097 super(); // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor 098 name = clm.getName(); 099 query = clm.getRendererParam(); 100 dbid = clm.getDbid(); 101 lang = clm.getLang(); // 4.0.0 (2006/11/15) 102 useSLabel = clm.getUseSLabel() ; // 5.5.1.0 (2012/04/03) 103 noDisplayVal = clm.getNoDisplayVal(); // 5.6.2.3 (2013/03/22) 104 addKeyLabel = clm.getAddKeyLabel(); // 6.2.0.0 (2015/02/27) キー:ラベル形式 105 106 // 3.5.5.9 (2004/06/07) 107 if( query == null || query.isEmpty() ) { 108 final String errMsg = "DBMENU Renderer では、表示パラメータは必須です。" 109 + " name=[" + name + "]" + CR ; 110 throw new HybsSystemException( errMsg ); 111 } 112 } 113 114 /** 115 * 各オブジェクトから自分のインスタンスを返します。 116 * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に 117 * まかされます。 118 * 119 * @param clm DBColumnオブジェクト 120 * 121 * @return CellRendererオブジェクト 122 * @og.rtnNotNull 123 */ 124 public CellRenderer newInstance( final DBColumn clm ) { 125 return new Renderer_DBMENU( clm ); 126 } 127 128 /** 129 * データの表示用文字列を返します。 130 * 131 * ここでは、AAA:BBB:CCC:DDD という値を、$1,$2,$3,$4 に割り当てなおして、 132 * QUERYを実行します。また、$1 は、本来の値として、メニューの初期値設定等に 133 * 使用します。上記の例では、AAA が値で、それ以降は、引数になります。 134 * さらに、元の文字列"AAA:BBB:CCC:DDD"は、$0 に割り当てられます。割り当てがない 135 * 変数は、""(ゼロ文字列)として、扱われます。 136 * 137 * @og.rev 3.4.0.1 (2003/09/03) ＤＢ検索をリアルタイムに変更。 138 * @og.rev 3.4.0.2 (2003/09/05) AAA:BBB:CCC:DDD という値を、$1,$2,$3,$4 に割り当てます。 139 * @og.rev 3.5.4.2 (2003/12/15) makeCodeSelection メソッドを CodeSelectionクラスに変更。 140 * @og.rev 3.5.5.7 (2004/05/10) SelectionFactory を使用して、オブジェクト作成 141 * @og.rev 4.0.0.0 (2006/11/15) SelectionFactory に lang 属性を追加します。 142 * @og.rev 4.3.4.0 (2008/12/01) $Cのカラム名置換えを追加 143 * @og.rev 5.5.1.0 (2012/04/03) Slabel対応。"auto"は、false になります。 144 * @og.rev 5.6.2.3 (2013/03/22) noDisplayVal 変数追加 145 * @og.rev 6.0.4.0 (2014/11/28) ロジックの共通化 146 * 147 * @param value 入力値 148 * 149 * @return データの表示用文字列 150 */ 151 @Override 152 public String getValue( final String value ) { 153 final boolean useSlbl = "true".equalsIgnoreCase( useSLabel ); // 5.5.1.0 (2012/04/03) 154 return getSelectionValue( value,useSlbl ); 155 } 156 157 /** 158 * name属性を変えた、データ表示/編集用のHTML文字列を作成します。 159 * テーブル上の name に 行番号を付加して、名前_行番号 で登録するキーを作成し、 160 * リクエスト情報を１つ毎のフィールドで処理できます。 161 * 162 * @og.rev 4.0.0.0 (2005/11/30) 一覧表示では、短縮ラベルを使用します。 163 * @og.rev 4.0.0.0 (2006/11/15) SelectionFactory に lang 属性を追加します。 164 * @og.rev 4.3.4.0 (2008/12/01) $Cのカラム名置換えを追加 165 * @og.rev 5.5.1.0 (2012/04/03) Slabel対応。"auto"は、true になります。 166 * @og.rev 5.6.2.3 (2013/03/22) noDisplayVal 変数追加 167 * @og.rev 6.0.4.0 (2014/11/28) ロジックの共通化 168 * 169 * @param row 行番号 170 * @param value 入力値 171 * 172 * @return データ表示/編集用の文字列 173 */ 174 @Override 175 public String getValue( final int row,final String value ) { 176 final boolean useSlbl = "auto".equalsIgnoreCase( useSLabel ) || "true".equalsIgnoreCase( useSLabel ); // 5.5.1.0 (2012/04/03) 177 return getSelectionValue( value,useSlbl ); 178 } 179 180 /** 181 * データの表示用文字列を返します。 182 * 183 * ここでは、AAA:BBB:CCC:DDD という値を、$1,$2,$3,$4 に割り当てなおして、 184 * QUERYを実行します。また、$1 は、本来の値として、メニューの初期値設定等に 185 * 使用します。上記の例では、AAA が値で、それ以降は、引数になります。 186 * さらに、元の文字列"AAA:BBB:CCC:DDD"は、$0 に割り当てられます。割り当てがない 187 * 変数は、""(ゼロ文字列)として、扱われます。 188 * 189 * @og.rev 6.0.4.0 (2014/11/28) ロジックの共通化 190 * @og.rev 6.2.0.0 (2015/02/27) キー:ラベル形式で表示するかどうかを、指定できるようにします。 191 * 192 * @param value 入力値 表示文字列 193 * @param useSlbl SLabelを使うかどうか(true:使う/false:使わない) 194 * 195 * @return データ表示用の文字列 196 */ 197 private String getSelectionValue( final String value,final boolean useSlbl ) { 198 // 5.6.2.3 (2013/03/22) noDisplayVal 変数追加 199 if( noDisplayVal != null && noDisplayVal.equalsIgnoreCase( value ) ) { return "" ; } 200 201 // StringFormat format = new StringFormat( query,value); 202 final StringFormat format = new StringFormat( query, value, name ); // 4.3.4.0 (2008/12/01) 203 final String newQuery = format.format(); 204 final String newValue = format.getValue(); 205 206 // 6.2.0.0 (2015/02/27) キー:ラベル形式 207 final Selection selection = SelectionFactory.newDBSelection( newQuery,dbid,lang, addKeyLabel ); 208 209 return selection.getValueLabel( newValue,useSlbl ); 210 } 211}