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 = "5.0.0 (2012/11/01)" ;
041
042        private static final CellRenderer dbCell = new Renderer_HTMLPRE() ;
043
044        /**
045         * 各オブジェクトから自分のインスタンスを返します。
046         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
047         * まかされます。
048         *
049         *
050         * @param       clm     DBColumnオブジェクト
051         *
052         * @return      CellRendererオブジェクト
053         */
054        public CellRenderer newInstance( final DBColumn clm ) {
055                return dbCell;
056        }
057
058        /**
059         * データの表示用文字列を返します。
060         *
061         * @param   value 入力値
062         *
063         * @return  データの表示用文字列
064         */
065        @Override
066        public String getValue( final String value ) {
067                String rtn = ( value == null ) ? "" : StringUtil.htmlFilter( value ) ;
068
069                return "<pre>" + rtn + "</pre>";
070        }
071}