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.db.AbstractRenderer;
019import org.opengion.hayabusa.db.CellRenderer;
020import org.opengion.hayabusa.db.DBColumn;
021import org.opengion.fukurou.util.StringFormat;
022
023/**
024 * FORM レンデラーは、表示パラメータで指定された FORM を表示するクラスで、
025 * 元のValue を、$1 として、使用可能です。
026 * (コロンで区切られた値の表示のコントロールを行うレンデラーです)
027 *
028 * ここでは、AAA:BBB:CCC:DDD という値を、$1,$2,$3,$4 に割り当てなおして、
029 * QUERYを実行します。また、$1 は、本来の値として、メニューの初期値設定等に
030 * 使用します。上記の例では、AAA が値で、それ以降は、引数になります。
031 * さらに、元の文字列"AAA:BBB:CCC:DDD"は、$0 に割り当てられます。割り当てがない
032 * 変数は、""(ゼロ文字列)として、扱われます。
033 * 又、$Cには自分自身のカラム名を割り当てます。
034 *
035 * カラムの表示に必要な属性は、DBColumn オブジェクト より取り出します。
036 * このクラスは、DBColumn オブジェクト毎に１つ作成されます。
037 *
038 * @og.rev 2.1.1.1 (2002/11/15) FORM レンデラーを新規追加しました。
039 * @og.rev 5.4.2.6 (2012/01/19) コメント修正
040 * @og.group データ表示
041 *
042 * @version  4.0
043 * @author   Kazuhiko Hasegawa
044 * @since    JDK5.0,
045 */
046public class Renderer_FORM extends AbstractRenderer {
047        /** このプログラムのVERSION文字列を設定します。   {@value} */
048        private static final String VERSION = "5.4.2.6 (2012/01/19)" ;
049
050        private final String form ;
051        private final String name  ;
052
053        /**
054         * デフォルトコンストラクター。
055         * このコンストラクターで、基本オブジェクトを作成します。
056         *
057         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
058         *
059         */
060        public Renderer_FORM() {
061                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
062                form   = null;
063                name   = null; // 4.3.4.0 (2008/12/01)
064        }
065
066        /**
067         * DBColumnオブジェクトを指定したprivateコンストラクター。
068         *
069         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
070         * @og.rev 3.4.0.0 (2003/09/01) 表示パラメータ、編集パラメータ、文字パラメータの追加。
071         * @og.rev 3.8.8.2 (2007/01/26) StringFormat の $0 対応。
072         *
073         * @param       clm     DBColumnオブジェクト
074         */
075        private Renderer_FORM( final DBColumn clm ) {
076                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
077                String tmp = clm.getRendererParam();
078                if( tmp == null || tmp.isEmpty() ) { tmp = "$0"; }      // 3.8.8.2 (2007/01/26)
079                form = tmp ;
080                name = clm.getName(); // 4.3.4.0 (2008/12/01)
081        }
082
083        /**
084         * 各オブジェクトから自分のインスタンスを返します。
085         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
086         * まかされます。
087         *
088         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
089         * @og.rev 3.1.2.1 (2003/04/10) synchronized を、削除します。
090         *
091         * @param       clm     DBColumnオブジェクト
092         *
093         * @return      CellRendererオブジェクト
094         * @og.rtnNotNull
095         */
096        public CellRenderer newInstance( final DBColumn clm ) {
097                return new Renderer_FORM( clm );
098        }
099
100        /**
101         * データの表示用文字列を返します。
102         *
103         * ここでは、AAA:BBB:CCC:DDD という値を、$1,$2,$3,$4 に割り当てなおして、
104         * QUERYを実行します。また、$1 は、本来の値として、メニューの初期値設定等に
105         * 使用します。上記の例では、AAA が値で、それ以降は、引数になります。
106         * さらに、元の文字列"AAA:BBB:CCC:DDD"は、$0 に割り当てられます。割り当てがない
107         * 変数は、""(ゼロ文字列)として、扱われます。
108         *
109         * @og.rev 3.4.0.2 (2003/09/05) AAA:BBB:CCC:DDD という値を、$1,$2,$3,$4 に割り当てます。
110         * @og.rev 4.3.4.0 (2008/12/01) $Cのカラム名置換えを追加
111         *
112         * @param   value 入力値
113         *
114         * @return  データの表示用文字列
115         */
116        @Override
117        public String getValue( final String value ) {
118                // StringFormat format = new StringFormat( form,value );
119                final StringFormat format = new StringFormat( form, value, name ); // 4.3.4.0 (2008/12/01)
120                return format.format();
121        }
122}