    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.fukurou.util.StringUtil;
    019import org.opengion.hayabusa.db.AbstractRenderer;
    020import org.opengion.hayabusa.db.CellRenderer;
    021import org.opengion.hayabusa.db.DBColumn;
    022
    023/**
    024 * HTMLPRE レンデラーは、カラムのデータをそのまま PRE表示する場合に使用するクラスです。
    025 * HTMLタグを含むデータを表示する場合に使用するクラスです。
    026 *
    027 * クロスサイトスクリプティング問題に対応するフィールドに対して
    028 * 定義することにより、エスケープ処理を行います。
    029 *
    030 * このクラスは、不変オブジェクトとして、共有されます。
    031 *
    032 * @og.group データ表示
    033 *
    034 * @version  5.0
    035 * @author   Takahashi Masakazu
    036 * @since    JDK5.0,
    037 */
    038public class Renderer_HTMLPRE extends AbstractRenderer {
    039        /** このプログラムのVERSION文字列を設定します。   {@value} */
    040        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
    041
    042        private static final CellRenderer DB_CELL = new Renderer_HTMLPRE() ;
    043
    044        /**
    045         * デフォルトコンストラクター
    046         *
    047         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    048         */
    049        public Renderer_HTMLPRE() { super(); }          // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
    050
    051        /**
    052         * 各オブジェクトから自分のインスタンスを返します。
    053         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
    054         * まかされます。
    055         *
    056         * @param       clm     DBColumnオブジェクト
    057         *
    058         * @return      CellRendererオブジェクト
    059         * @og.rtnNotNull
    060         */
    061        public CellRenderer newInstance( final DBColumn clm ) {
    062                return DB_CELL;
    063        }
    064
    065        /**
    066         * データの表示用文字列を返します。
    067         *
    068         * @param   value 入力値
    069         *
    070         * @return  データの表示用文字列
    071         * @og.rtnNotNull
    072         */
    073        @Override
    074        public String getValue( final String value ) {
    075                final String rtn = ( value == null ) ? "" : StringUtil.htmlFilter( value ) ;
    076
    077                return "<pre>" + rtn + "</pre>";
    078        }
    079
    080        /**
    081         * データ出力用の文字列を作成します。
    082         * ファイル等に出力する形式を想定しますので、HTMLタグを含まない
    083         * データを返します。
    084         * 基本は、#getValue( String ) をそのまま返します。
    085         *
    086         * @og.rev 6.0.4.0 (2014/11/28) データ出力用のレンデラー
    087         *
    088         * @param   value 入力値
    089         *
    090         * @return  データ出力用の文字列
    091         * @og.rtnNotNull
    092         * @see         #getValue( String )
    093         */
    094        @Override
    095        public String getWriteValue( final String value ) {
    096                return ( value == null ) ? "" : value;
    097        }
    098}