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;
021
022/**
023 * PRE レンデラーは、カラムのデータをそのまま PRE表示する場合に使用するクラスです。
024 *
025 * このクラスは、不変オブジェクトとして、共有されます。
026 *
027 * @og.group データ表示
028 *
029 * @version  4.0
030 * @author   Kazuhiko Hasegawa
031 * @since    JDK5.0,
032 */
033public class Renderer_PRE extends AbstractRenderer {
034        /** このプログラムのVERSION文字列を設定します。   {@value} */
035        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
036
037        private static final CellRenderer DB_CELL = new Renderer_PRE() ;
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        public Renderer_PRE() { super(); }              // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
045
046        /**
047         * 各オブジェクトから自分のインスタンスを返します。
048         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
049         * まかされます。
050         *
051         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
052         * @og.rev 3.1.2.1 (2003/04/10) synchronized を、削除します。
053         *
054         * @param       clm     DBColumnオブジェクト
055         *
056         * @return      CellRendererオブジェクト
057         * @og.rtnNotNull
058         */
059        public CellRenderer newInstance( final DBColumn clm ) {
060                return DB_CELL;
061        }
062
063        /**
064         * データの表示用文字列を返します。
065         *
066         * @param   value 入力値
067         *
068         * @return  データの表示用文字列
069         * @og.rtnNotNull
070         */
071        @Override
072        public String getValue( final String value ) {
073                final String rtn = value == null ? "" : value ;
074
075                return "<pre>" + rtn + "</pre>";
076        }
077
078        /**
079         * データ出力用の文字列を作成します。
080         * ファイル等に出力する形式を想定しますので、HTMLタグを含まない
081         * データを返します。
082         * 基本は、#getValue( String ) をそのまま返します。
083         *
084         * @og.rev 6.0.4.0 (2014/11/28) データ出力用のレンデラー
085         *
086         * @param   value 入力値
087         *
088         * @return  データ出力用の文字列
089         * @og.rtnNotNull
090         * @see         #getValue( String )
091         */
092        @Override
093        public String getWriteValue( final String value ) {
094                return ( value == null ) ? "" : value;
095        }
096}