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;
021import org.opengion.fukurou.util.StringUtil;                            // 8.5.4.2 (2024/01/12) import static … を個別に記述;
022
023// import static org.opengion.fukurou.util.StringUtil.isNull;
024
025/**
026 * SUBSTR レンデラーは、カラムのデータを特定の文字列の範囲のみに分割するクラスです。
027 *
028 * パラメータに、開始文字列$$終了文字列　を指定すると、最初の開始文字列から
029 * 最後に現れた終了文字列の間のみを抜き出します。
030 *
031 * 開始文字列が未設定や見つからない場合は、文字列の最初から、終了文字列が未設定や
032 * 見つからない場合は、最後まで抜き出し対象とします。
033 *
034 * $$も存在しない場合は、開始文字列のみ指定されたとして処理します。
035 * パラメータに何も指定されなかった場合は、何も加工しません。
036 *
037 * @og.group データ変換
038 *
039 * @og.rev 7.2.6.0 (2020/06/30) 行単位に抜き出す機能追加
040 *
041 * @version  7.2
042 * @author   Kazuhiko Hasegawa
043 * @since    JDK11.0,
044 */
045public class Renderer_SUBSTR extends AbstractRenderer {
046        /** このプログラムのVERSION文字列を設定します。   {@value} */
047        private static final String VERSION = "7.2.6.0 (2020/06/30)" ;
048
049        private static final String SEPARATOR = "$$" ;
050
051        private static final CellRenderer DB_CELL = new Renderer_SUBSTR( "","" ) ;
052
053        // 7.2.6.0 (2020/06/30) 行単位に抜き出す機能追加
054        /** 開始文字列 */
055        private final String  stStr ;
056        /** 終了文字列 */
057        private final String  enStr ;
058        /** 処理するかどうか */
059        private final boolean isUse ;
060
061        /**
062         * デフォルトコンストラクター
063         *
064         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
065         */
066        public Renderer_SUBSTR() {
067                this( "","" );
068        }
069
070        /**
071         * 必要なパラメータを指定したprivateコンストラクター。
072         *
073         * パラメータで、先頭からスキップする文字列と以降を無視する文字列を指定する。
074         *
075         * @og.rev 7.2.6.0 (2020/06/30) 行単位に抜き出す機能追加
076         *
077         * @param       stStr   開始文字列
078         * @param       enStr   終了文字列
079         */
080        private Renderer_SUBSTR( final String stStr,final String enStr ) {
081                super();
082                this.stStr      = stStr;
083                this.enStr      = enStr;
084//              this.isUse      = !isNull( stStr ) || !isNull( enStr );
085                this.isUse      = !StringUtil.isNull( stStr ) || !StringUtil.isNull( enStr );   // 8.5.4.2 (2024/01/12) import static … を個別に記述
086        }
087
088        /**
089         * 各オブジェクトから自分のインスタンスを返します。
090         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
091         * まかされます。
092         *
093         * @og.rev 7.2.6.0 (2020/06/30) 行単位に抜き出す機能追加
094         *
095         * @param       clm     DBColumnオブジェクト
096         *
097         * @return      CellRendererオブジェクト
098         * @og.rtnNotNull
099         */
100        public CellRenderer newInstance( final DBColumn clm ) {
101                final String param = clm.getRendererParam();
102                if( StringUtil.isNull( param ) ) {                                      // 8.5.4.2 (2024/01/12) import static … を個別に記述
103                        return DB_CELL;
104                }
105                else {
106                        String  stStr   = "";
107                        String  enStr   = "";
108
109                        final int ad = param.indexOf( SEPARATOR );
110                        if( ad < 0 ) {
111                                stStr = param;
112                        }
113                        else {
114                                stStr = param.substring( 0,ad );
115                                enStr = param.substring( ad+SEPARATOR.length() );
116                        }
117                        return new Renderer_SUBSTR( stStr,enStr );
118                }
119        }
120
121        /**
122         * データの表示用文字列を返します。
123         *
124         * @og.rev 7.2.6.0 (2020/06/30) 行単位に抜き出す機能追加
125         *
126         * @param   value 入力値
127         *
128         * @return  データの表示用文字列
129         * @og.rtnNotNull
130         */
131        @Override
132        public String getValue( final String value ) {
133                // 8.5.5.1 (2024/02/29) PMD 7.0.0 OnlyOneReturn メソッドには終了ポイントが 1 つだけ必要
134//              final String rtn = ( value == null ) ? "" : value ;
135                String rtn = ( value == null ) ? "" : value ;
136
137                if( isUse ) {
138                        int st = rtn.indexOf(     stStr );              // 引数が空の文字列の場合も　0
139                        int ed = rtn.lastIndexOf( enStr );
140
141                        if( st < 0 ) { st = 0; }
142                        if( ed < 0 ) { ed = rtn.length(); }
143
144//                      return rtn.substring( st,ed );
145                        rtn = rtn.substring( st,ed );
146                }
147
148                return rtn ;
149        }
150
151        /**
152         * データ出力用の文字列を作成します。
153         * ファイル等に出力する形式を想定しますので、HTMLタグを含まない
154         * データを返します。
155         * 基本は、#getValue( String ) をそのまま返します。
156         *
157         * @param   value 入力値
158         *
159         * @return  データ出力用の文字列
160         * @og.rtnNotNull
161         * @see         #getValue( String )
162         */
163        @Override
164        public String getWriteValue( final String value ) {
165                return getValue( value );
166        }
167}