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.hayabusa.taglib; 017 018import org.opengion.hayabusa.html.ViewJsonParam; 019 020import static org.opengion.fukurou.util.StringUtil.nval ; 021 022import java.io.ObjectOutputStream; 023import java.io.ObjectInputStream; 024import java.io.IOException; 025 026/** 027 * viewタグの viewFormType が JSON の場合にパラメータを設定します。 028 * 029 * JOSN出力のViewForm_JSON クラスに対して、各種パラメータを設定します。 030 * パラメータが設定されていない場合は、ViewJsonParam の初期値が 031 * 使用されます。 032 * (パラメータを使用するには、viewタグのuseParam 属性をtrueに設定する必要があります。) 033 * 034 * @og.formSample 035 * ●形式:<og:jsonParam useHead="false" /> 036 * ●body:なし 037 * 038 * ●Tag定義: 039 * <og:stackParam 040 * useHead 【TAG】ヘッダ情報を出力するかどうか(初期値:true) 041 * useInfo 【TAG】INFO情報を出力するかどうか(初期値:true) 042 * useRenderer 【TAG】データ出力でレンデラを利用するかどうか(初期値:false) 043 * useNullOmit 【TAG】nullデータの出力を行わないかどうか(初期値:false) 044 * useZeroOmit 【TAG】ゼロデータの出力を行わないかどうか(初期値:false) 045 * dataName 【TAG】データ出力時の配列オブジェクトの名称指定(初期値:DATA) 046 * debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) 047 * /> 048 * 049 * @og.rev 5.9.7.0 (2016/04/01) 新規作成 050 * @og.group 画面表示 051 * 052 * @version 5.0 053 * @author Takahashi Masakazu 054 * @since JDK5.0, 055 */ 056public class ViewJsonParamTag extends ViewParamImpl { 057 /** このプログラムのVERSION文字列を設定します。 {@value} */ 058 private static final String VERSION = "6.9.7.0 (2018/05/14)" ; 059 private static final long serialVersionUID = 697020180514L ; 060 061 /** 062 * デフォルトコンストラクター 063 * 064 * @og.rev 6.9.7.0 (2018/05/14) PMD Each class should declare at least one constructor 065 */ 066 public ViewJsonParamTag() { super(); } // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。 067 068 /** 069 * 【TAG】JSON出力で、INFO情報を出すかどうかを指定します。 070 * 071 * @og.tag 072 * JSON中INFO情報を出力しない場合はfalseを指定します。 073 * 074 * 075 * @param useinfo INFO情報を出力するかどうか 076 */ 077 public void setUseInfo( final String useinfo ) { 078 putParam( ViewJsonParam.JSON_INFO_KEY , 079 nval( getRequestParameter( useinfo ),null ) ); 080 } 081 082 /** 083 * 【TAG】JSON出力で、ヘッダ情報を出すかどうかを指定します。 084 * 085 * @og.tag 086 * JSON中にヘッダ情報を出力しない場合はfalseを指定します。 087 * 088 * 089 * @param usehead ヘッダ情報を出力するかどうか 090 */ 091 public void setUseHead( final String usehead ) { 092 putParam( ViewJsonParam.JSON_HEAD_KEY , 093 nval( getRequestParameter( usehead ),null ) ); 094 } 095 096 /** 097 * 【TAG】(廃止予定)JSON出力で、値出力にレンデラを利用するかどうかを指定します。 098 * 099 * @og.tag 100 * JSONのデータのレンデラー変換を行うかどうか。 101 * 指定しない場合は使用しない(false)です。 102 * true指定はrendererColumns="*"と同じため、そちらを利用してください。 103 * 104 * @param usernd レンデラーを利用するかどうか 105 */ 106 public void setUseRenderer( final String usernd ) { 107 putParam( ViewJsonParam.JSON_RENDERER_KEY , 108 nval( getRequestParameter( usernd ),null ) ); 109 } 110 111 /** 112 * 【TAG】JSON出力で、レンデラを利用するカラムを指定します。 113 * 114 * @og.tag 115 * レンデラを利用するカラムを指定します。 116 * 117 * @og.rev 5.9.27.0 (2017/12/01) 追加 118 * 119 * @param cols データ配列の名称 120 */ 121 public void setRendererColumns( final String cols ) { 122 putParam( ViewJsonParam.JSON_RENDERER_COLS_KEY , 123 nval( getRequestParameter( cols ),null ) ); 124 } 125 126 /** 127 * 【TAG】JSON出力で、nullデータの出力を行わないかどうかを指定します(初期値:false)。 128 * 129 * @og.tag 130 * JSONのデータが、nullの場合、出力するかどうかを指定します。 131 * true を指定すると、nullデータは、出力しません。 132 * (初期値:false) 133 * 134 * @og.rev 6.7.7.0 (2017/03/31) 新規追加 135 * 136 * @param nullOmit nullデータの出力を行わないかどうか 137 */ 138 public void setUseNullOmit( final String nullOmit ) { 139 putParam( ViewJsonParam.JSON_NULLOMIT_KEY , 140 nval( getRequestParameter( nullOmit ),null ) ); 141 } 142 143 /** 144 * 【TAG】JSON出力で、ゼロデータの出力を行わないかどうかを指定します(初期値:false)。 145 * 146 * @og.tag 147 * JSONのデータが、ゼロの場合、出力するかどうかを指定します。 148 * true を指定すると、ゼロデータとnullデータを、出力しません。 149 * (初期値:false) 150 * 151 * @og.rev 6.7.7.0 (2017/03/31) 新規追加 152 * 153 * @param zeroOmit ゼロデータの出力を行わないかどうか 154 */ 155 public void setUseZeroOmit( final String zeroOmit ) { 156 putParam( ViewJsonParam.JSON_ZEROOMIT_KEY , 157 nval( getRequestParameter( zeroOmit ),null ) ); 158 } 159 160 /** 161 * 【TAG】JSON出力で、データ部の名前を指定します。 162 * 163 * @og.tag 164 * データ配列の名称を指定します。 165 * 指定しない場合は「DATA」です。 166 * 167 * 168 * @param name データ配列の名称 169 */ 170 public void setDataName( final String name ) { 171 putParam( ViewJsonParam.JSON_DATANAME_KEY , 172 nval( getRequestParameter( name ),null ) ); 173 } 174 175 /** 176 * タグの名称を、返します。 177 * 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。 178 * 179 * 180 * @return タグの名称 181 */ 182 @Override 183 protected String getTagName() { 184 return "jsonParam" ; 185 } 186 187 /** 188 * シリアライズ用のカスタムシリアライズ書き込みメソッド。 189 * 190 * @serialData 一部のオブジェクトは、シリアライズされません 191 * 192 * @param strm ObjectOutputStreamオブジェクト 193 * @throws IOException 入出力エラーが発生した場合 194 */ 195 private void writeObject( final ObjectOutputStream strm ) throws IOException { 196 strm.defaultWriteObject(); 197 } 198 199 /** 200 * シリアライズ用のカスタムシリアライズ読み込みメソッド 201 * 202 * ここでは、transient 宣言された内部変数の内、初期化が必要なフィールドのみ設定します。 203 * 204 * @serialData 一部のオブジェクトは、シリアライズされません。 205 * 206 * @param strm ObjectInputStreamオブジェクト 207 * @see #release2() 208 * @throws IOException シリアライズに関する入出力エラーが発生した場合 209 * @throws ClassNotFoundException クラスを見つけることができなかった場合 210 */ 211 private void readObject( final ObjectInputStream strm ) throws IOException , ClassNotFoundException { 212 strm.defaultReadObject(); 213 } 214}