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 * XXXX レンデラーは、パラメータで指定された XXXXフォーマットに対して、
024 * 値を変換します。たとえば、郵便番号や、電話番号など、ハイフン編集や、日付や
025 * 時刻などの / や : 編集を行います。
026 * 例) 1234567     XXX-XXXX       ⇒ 123-4567
027 * 例) 1234567890 (XXX)-XXX-XXXX ⇒ (123)-456-7890
028 * 例) 20060715     XXXX/XX/XX    ⇒ 2006/07/15
029 *
030 * XXXX フォーマットよりデータが少ない場合は、以下表示されません。
031 * XXXX-XXXX の場合に、データが４桁の場合は、ハイフンは含まれません。
032 *
033 * フォーマットの初期値はXXXXXXXXXXXXXXXXXXXXです。
034 *
035 * カラムの表示に必要な属性は、DBColumn オブジェクト より取り出します。
036 * このクラスは、DBColumn オブジェクト毎に１つ作成されます。
037 *
038 * @og.group データ表示
039 *
040 * @version  4.0
041 * @author       Kazuhiko Hasegawa
042 * @since    JDK5.0,
043 */
044public class Renderer_XXXX extends AbstractRenderer {
045        /** このプログラムのVERSION文字列を設定します。   {@value} */
046        private static final String VERSION = "6.4.1.1 (2016/01/16)" ;
047
048        private final String form ;
049
050        /**
051         * デフォルトコンストラクター。
052         * このコンストラクターで、基本オブジェクトを作成します。
053         *
054         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
055         * @og.rev 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
056         *
057         */
058        public Renderer_XXXX() {
059                super();
060                form   = "XXXXXXXXXXXXXXXXXXXX";
061        }
062
063        /**
064         * DBColumnオブジェクトを指定したprivateコンストラクター。
065         *
066         * @og.rev 6.4.1.1 (2016/01/16) PMD refactoring. It is a good practice to call super() in a constructor
067         *
068         * @param       clm     DBColumnオブジェクト
069         */
070        private Renderer_XXXX( final DBColumn clm ) {
071                super();
072                String tmp = clm.getRendererParam();
073                if( tmp == null || tmp.isEmpty() ) { tmp = "XXXXXXXXXXXXXXXXXXXX"; }
074                form = tmp ;
075        }
076
077        /**
078         * 各オブジェクトから自分のインスタンスを返します。
079         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
080         * まかされます。
081         *
082         * @param       clm DBColumnオブジェクト
083         *
084         * @return      CellRendererオブジェクト
085         * @og.rtnNotNull
086         */
087        public CellRenderer newInstance( final DBColumn clm ) {
088                return new Renderer_XXXX( clm );
089        }
090
091        /**
092         * データの表示用文字列を返します。
093         *
094         * @param       value 入力値
095         *
096         * @return      データの表示用文字列
097         * @og.rtnNotNull
098         */
099        @Override
100        public String getValue( final String value ) {
101                if( value == null ) { return ""; }
102
103                final char[] formChar = form.toCharArray();
104                final char[] valChar  = value.toCharArray();
105
106                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
107                // 8.5.4.2 (2024/01/12) PMD 7.0.0 ShortVariable j ⇒ jj
108                int jj = 0;
109                for( int i=0; i<formChar.length && jj<valChar.length; i++ ) {
110                        if( formChar[i] == 'X' ) {
111                                buf.append( valChar[jj++] );
112                        }
113                        else {
114                                buf.append( formChar[i] );
115                        }
116                }
117
118                return buf.toString();
119        }
120}