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.hayabusa.db;
017
018import org.opengion.fukurou.util.StringUtil ;           // 6.2.0.0 (2015/02/27)
019import org.opengion.fukurou.system.HybsConst ;          // 6.1.0.0 (2014/12/26)
020
021/**
022 * DBCell の具象クラスで、カラムのデータを表示する場合に使用するクラスです。
023 *
024 *  カラムの表示に必要な属性は、DBColumn オブジェクト より取り出します。
025 * このクラスは、DBColumn オブジェクト毎に１つ作成されます。
026 *
027 * @og.group データ表示
028 *
029 * @version  4.0
030 * @author   Kazuhiko Hasegawa
031 * @since    JDK5.0,
032 */
033public abstract class AbstractRenderer implements CellRenderer {
034        /** システムの改行コードを設定します。*/
035        protected static final String CR                 = HybsConst.CR;                        // 6.1.0.0 (2014/12/26) refactoring
036        /** StringBilderなどの初期値を設定します。   {@value} */
037        protected static final int BUFFER_MIDDLE = HybsConst.BUFFER_MIDDLE;     // 6.1.0.0 (2014/12/26) refactoring
038
039        /**
040         * デフォルトコンストラクター
041         *
042         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
043         */
044        protected AbstractRenderer() { super(); }               // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
045
046        /**
047         * データの表示用文字列を返します。
048         *
049         * @og.rev 6.0.4.0 (2014/11/28) ロジックの共通化
050         *
051         * @param   value 入力値
052         *
053         * @return  データの表示用文字列
054         * @og.rtnNotNull
055         */
056        @Override       // CellRenderer
057        public String getValue( final String value ) {
058                return value==null ? "" : value ;                                       // 6.0.4.0 (2014/11/28) ロジックの共通化
059        }
060
061        /**
062         * name属性を変えた、データ表示/編集用のHTML文字列を作成します。
063         * テーブル上の name に 行番号を付加して、名前_行番号 で登録するキーを作成し、
064         * リクエスト情報を１つ毎のフィールドで処理できます。
065         *
066         * @param       row     行番号
067         * @param   value 入力値
068         *
069         * @return  データ表示/編集用の文字列
070         * @og.rtnNotNull
071         * @see         #getValue( String )
072         */
073        @Override       // CellRenderer
074        public String getValue( final int row,final String value ) {
075                return getValue( value );
076        }
077
078        /**
079         * name属性を変えた、データ表示用のHTML文字列を作成します。
080         * レンデラーのため、row(行番号)は使いません。
081         * 第３引数に、パラメータを渡すことが出来ます。これは、viewMarker で
082         * [$XXXX param] 形式を渡すことで、行単位に表示形式を変更できます。
083         * AbstractRenderer では、#getValue( String ) を呼び出しています。
084         *
085         * @og.rev 6.8.3.1 (2017/12/01) パラメータを渡せるようにします。
086         *
087         * @param   row   行番号
088         * @param   value 値
089         * @param   param パラメータ
090         *
091         * @return  データ表示/編集用の文字列
092         */
093        @Override       // CellRenderer
094        public String getValue( final int row,final String value,final String param ) {
095                return getValue( value );
096        }
097
098        /**
099         * データ出力用の文字列を作成します。
100         * ファイル等に出力する形式を想定しますので、HTMLタグを含まない
101         * データを返します。
102         * 基本は、#getValue( String ) をそのまま返します。
103         *
104         * @og.rev 6.0.4.0 (2014/11/28) データ出力用のレンデラー
105         * @og.rev 6.2.0.0 (2015/02/27) StringUtil#spanCut(String) を入れます。
106         * @og.rev 6.2.4.2 (2015/05/29) StringUtil#spanCut(String) → StringUtil#tagCut(String) に変更します。
107         *
108         * @param   value 入力値
109         *
110         * @return  データ出力用の文字列
111         * @og.rtnNotNull
112         * @see         #getValue( String )
113         */
114        @Override       // CellRenderer
115        public String getWriteValue( final String value ) {
116                return StringUtil.tagCut( getValue( value ) );                                  // 6.2.4.2 (2015/05/29)
117        }
118}