/*
 * 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.plugin.column;

import org.opengion.hayabusa.db.AbstractRenderer;
import org.opengion.hayabusa.db.CellRenderer;
import org.opengion.hayabusa.db.DBColumn;
import org.opengion.hayabusa.db.Selection;
import org.opengion.hayabusa.db.SelectionFactory;               // 5.7.3.0 (2014/02/07)

/**
 * RADIO レンデラーは、カラムのデータをコードリソースに対応したラジオボタンの
 * 代替えラベルで表示する場合に使用するクラスです。
 *
 *  カラムの表示に必要な属性は、DBColumn オブジェクト より取り出します。
 * このクラスは、DBColumn オブジェクト毎に１つ作成されます。
 *
 * @og.rev 3.5.1.0 (2003/10/03) 新規作成
 * @og.group データ表示
 *
 * @version  4.0
 * @author   Kazuhiko Hasegawa
 * @since    JDK5.0,
 */
public class Renderer_RADIO extends AbstractRenderer {
        /** このプログラムのVERSION文字列を設定します。   {@value} */
        private static final String VERSION = "6.2.2.4 (2015/04/24)" ;

        private final Selection selection       ;
        private String errMsg   ;                       // 6.0.4.0 (2014/11/28)

        /**
         * デフォルトコンストラクター。
         * このコンストラクターで、基本オブジェクトを作成します。
         *
         */
        public Renderer_RADIO() {
                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
                selection  = null;
        }

        /**
         * DBColumnオブジェクトを指定したprivateコンストラクター。
         *
         * @og.rev 3.5.4.2 (2003/12/15) makeCodeSelection メソッドを CodeSelectionクラスに変更。
         * @og.rev 3.5.5.7 (2004/05/10) SelectionFactory を使用して、オブジェクト作成
         * @og.rev 4.0.0.0 (2005/01/31) SelectionFactory ではなく、直接 Selection_RADIO を作成。
         * @og.rev 5.7.3.0 (2014/02/07) SelectionFactory 対応
         * @og.rev 6.0.4.0 (2014/11/28) selection が null の場合、警告表示します。
         * @og.rev 6.2.0.0 (2015/02/27) キー:ラベル形式で表示するかどうかを、指定できるようにします。
         *
         * @param       clm     DBColumnオブジェクト
         */
        private Renderer_RADIO( final DBColumn clm ) {
                super();                // 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
                final String addKeyLabel = clm.getAddKeyLabel();                // 6.2.0.0 (2015/02/27) キー:ラベル形式

                // 5.7.3.0 (2014/02/07) SelectionFactory 対応
                selection = SelectionFactory.newSelection( "RADIO" , clm.getCodeData(), addKeyLabel );  // 6.2.0.0 (2015/02/27)

                // 6.0.4.0 (2014/11/28) selection が null の場合、Selection_NULL を作成します。
                if( selection == null ) {
                        errMsg = "codeData が未設定です。"
                                                                + " name="  + clm.getName()
                                                                + " label=" + clm.getLabel()
                                                                + " rendType="  + clm.getRenderer() ;
                        System.out.println( errMsg );
                }
        }

        /**
         * 各オブジェクトから自分のインスタンスを返します。
         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
         * まかされます。
         *
         * @param       clm     DBColumnオブジェクト
         *
         * @return      CellRendererオブジェクト
         * @og.rtnNotNull
         */
        public CellRenderer newInstance( final DBColumn clm ) {
                return new Renderer_RADIO( clm );
        }

        /**
         * データの表示用文字列を返します。
         *
         * @og.rev 6.0.4.0 (2014/11/28) selection が null の場合、警告表示します。
         * @og.rev 6.2.2.4 (2015/04/24) getRadioLabel廃止。getValueLabel を使用する。
         *
         * @param   value 入力値
         *
         * @return  データの表示用文字列
         * @og.rtnNotNull
         */
        @Override
        public String getValue( final String value ) {
                // 6.4.1.1 (2016/01/16) PMD refactoring. A method should have only one exit point, and that should be the last statement in the method
                return selection == null
                                        ? ("<span class=\"error\">" + errMsg + " value=" + value + "</span>")
                                        : ("<pre class=\"RADIO\">" + selection.getValueLabel( value ) + "</pre>") ;
        }

        /**
         * データ出力用の文字列を作成します。
         * ファイル等に出力する形式を想定しますので、HTMLタグを含まない
         * データを返します。
         * 基本は、#getValue( String ) をそのまま返します。
         *
         * @og.rev 6.0.4.0 (2014/11/28) データ出力用のレンデラー
         * @og.rev 6.2.2.4 (2015/04/24) getRadioLabel廃止。getValueLabel を使用する。
         *
         * @param   value 入力値
         *
         * @return  データ出力用の文字列
         * @see         #getValue( String )
         */
        @Override
        public String getWriteValue( final String value ) {
                // 6.4.1.1 (2016/01/16) PMD refactoring. A method should have only one exit point, and that should be the last statement in the method
                return selection == null ? value : selection.getValueLabel( value );
        }
}