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.hayabusa.resource.ResourceFactory;
022import org.opengion.hayabusa.resource.ResourceManager;
023
024/**
025 * COLUMN レンデラーは、データの値をカラム名と認識して、動的カラムを
026 * 表示するクラスです。
027 *
028 * データの値を、動的カラムのそのカラム属性を持ったフォームを表示します。
029 *
030 *  カラムの表示に必要な属性は、DBColumn オブジェクト より取り出します。
031 * このクラスは、DBColumn オブジェクト毎に１つ作成されます。
032 *
033 * @og.group データ表示
034 *
035 * @version  4.0
036 * @author       Kazuhiko Hasegawa
037 * @since    JDK5.0,
038 */
039public class Renderer_COLUMN extends AbstractRenderer {
040        /** このプログラムのVERSION文字列を設定します。   {@value} */
041        private static final String VERSION = "6.0.4.0 (2014/11/28)" ;
042
043        private final String lang ;
044        private final String name ;                     // 3.5.2.0 (2003/10/20) エラー時のキー
045
046        /**
047         * デフォルトコンストラクター。
048         * このコンストラクターで、基本オブジェクトを作成します。
049         *
050         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
051         * @og.rev 3.5.2.0 (2003/10/20) エラー時の表示で、name を使用します。
052         *
053         */
054        public Renderer_COLUMN() {
055                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
056                lang   = null;
057                name   = null;
058        }
059
060        /**
061         * DBColumnオブジェクトを指定したprivateコンストラクター。
062         *
063         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
064         * @og.rev 3.5.2.0 (2003/10/20) エラー時の表示で、name を使用します。
065         *
066         * @param       clm     DBColumnオブジェクト
067         */
068        private Renderer_COLUMN( final DBColumn clm ) {
069                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
070                lang = clm.getLang();
071                name = clm.getName();
072        }
073
074        /**
075         * 各オブジェクトから自分のインスタンスを返します。
076         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
077         * まかされます。
078         *
079         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
080         * @og.rev 3.1.2.1 (2003/04/10) synchronized を、削除します。
081         *
082         * @param       clm     DBColumnオブジェクト
083         *
084         * @return      CellRendererオブジェクト
085         * @og.rtnNotNull
086         */
087        public CellRenderer newInstance( final DBColumn clm ) {
088                return new Renderer_COLUMN( clm );
089        }
090
091        /**
092         * データの表示用文字列を返します。
093         *
094         * @og.rev 3.5.2.0 (2003/10/20) 値で動的カラムが作成できない場合に、エラーメッセージを追加。
095         * @og.rev 6.0.4.0 (2014/11/28) エラーで、Exceptionではなく、エラーの値を返す。
096         *
097         * @param       value 入力値
098         *
099         * @return      データの表示用文字列
100         */
101        @Override
102        public String getValue( final String value ) {
103                final ResourceManager resource = ResourceFactory.newInstance( lang ) ;
104                final DBColumn dbColumn = resource.getDBColumn( value );
105
106                final String rtn ;                      // 6.0.4.0 (2014/11/28)
107                if( dbColumn == null ) {
108                        final String errMsg = "指定のカラムの値[]で、動的カラムは作成できません。"
109                                                + CR
110                                                + "  name=[" + name + "]"
111                                                + "  value=[" + value + "]";
112                        System.err.println( errMsg );
113                        rtn = "<span class=\"error\">" + name + "[" + value + "]" + "</span>";
114                }
115                else {
116                        rtn = dbColumn.getLabel();              // 6.0.4.0 (2014/11/28)
117                }
118
119                return rtn;
120        }
121
122        /**
123         * データ出力用の文字列を作成します。
124         * ファイル等に出力する形式を想定しますので、HTMLタグを含まない
125         * データを返します。
126         * 基本は、#getValue( String ) をそのまま返します。
127         *
128         * @og.rev 6.0.4.0 (2014/11/28) データ出力用のレンデラー
129         *
130         * @param   value 入力値
131         *
132         * @return  データ出力用の文字列
133         * @og.rtnNotNull
134         * @see         #getValue( String )
135         */
136        @Override
137        public String getWriteValue( final String value ) {
138                return value==null ? "" : value;
139        }
140}