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.7.7.0 (2017/03/31)" ; 059 private static final long serialVersionUID = 677020170331L ; 060 061 /** 062 * 【TAG】JSON出力で、INFO情報を出すかどうかを指定します。 063 * 064 * @og.tag 065 * JSON中INFO情報を出力しない場合はfalseを指定します。 066 * 067 * 068 * @param useinfo INFO情報を出力するかどうか 069 */ 070 public void setUseInfo( final String useinfo ) { 071 putParam( ViewJsonParam.JSON_INFO_KEY , 072 nval( getRequestParameter( useinfo ),null ) ); 073 } 074 075 /** 076 * 【TAG】JSON出力で、ヘッダ情報を出すかどうかを指定します。 077 * 078 * @og.tag 079 * JSON中にヘッダ情報を出力しない場合はfalseを指定します。 080 * 081 * 082 * @param usehead ヘッダ情報を出力するかどうか 083 */ 084 public void setUseHead( final String usehead ) { 085 putParam( ViewJsonParam.JSON_HEAD_KEY , 086 nval( getRequestParameter( usehead ),null ) ); 087 } 088 089 /** 090 * 【TAG】(廃止予定)JSON出力で、値出力にレンデラを利用するかどうかを指定します。 091 * 092 * @og.tag 093 * JSONのデータのレンデラー変換を行うかどうか。 094 * 指定しない場合は使用しない(false)です。 095 * true指定はrendererColumns="*"と同じため、そちらを利用してください。 096 * 097 * @param usernd レンデラーを利用するかどうか 098 */ 099 public void setUseRenderer( final String usernd ) { 100 putParam( ViewJsonParam.JSON_RENDERER_KEY , 101 nval( getRequestParameter( usernd ),null ) ); 102 } 103 104 /** 105 * 【TAG】JSON出力で、レンデラを利用するカラムを指定します。 106 * 107 * @og.tag 108 * レンデラを利用するカラムを指定します。 109 * 110 * @og.rev 5.9.27.0 (2017/12/01) 追加 111 * 112 * @param cols データ配列の名称 113 */ 114 public void setRendererColumns( final String cols ) { 115 putParam( ViewJsonParam.JSON_RENDERER_COLS_KEY , 116 nval( getRequestParameter( cols ),null ) ); 117 } 118 119 /** 120 * 【TAG】JSON出力で、nullデータの出力を行わないかどうかを指定します(初期値:false)。 121 * 122 * @og.tag 123 * JSONのデータが、nullの場合、出力するかどうかを指定します。 124 * true を指定すると、nullデータは、出力しません。 125 * (初期値:false) 126 * 127 * @og.rev 6.7.7.0 (2017/03/31) 新規追加 128 * 129 * @param nullOmit nullデータの出力を行わないかどうか 130 */ 131 public void setUseNullOmit( final String nullOmit ) { 132 putParam( ViewJsonParam.JSON_NULLOMIT_KEY , 133 nval( getRequestParameter( nullOmit ),null ) ); 134 } 135 136 /** 137 * 【TAG】JSON出力で、ゼロデータの出力を行わないかどうかを指定します(初期値:false)。 138 * 139 * @og.tag 140 * JSONのデータが、ゼロの場合、出力するかどうかを指定します。 141 * true を指定すると、ゼロデータとnullデータを、出力しません。 142 * (初期値:false) 143 * 144 * @og.rev 6.7.7.0 (2017/03/31) 新規追加 145 * 146 * @param zeroOmit ゼロデータの出力を行わないかどうか 147 */ 148 public void setUseZeroOmit( final String zeroOmit ) { 149 putParam( ViewJsonParam.JSON_ZEROOMIT_KEY , 150 nval( getRequestParameter( zeroOmit ),null ) ); 151 } 152 153 /** 154 * 【TAG】JSON出力で、データ部の名前を指定します。 155 * 156 * @og.tag 157 * データ配列の名称を指定します。 158 * 指定しない場合は「DATA」です。 159 * 160 * 161 * @param name データ配列の名称 162 */ 163 public void setDataName( final String name ) { 164 putParam( ViewJsonParam.JSON_DATANAME_KEY , 165 nval( getRequestParameter( name ),null ) ); 166 } 167 168 /** 169 * タグの名称を、返します。 170 * 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。 171 * 172 * 173 * @return タグの名称 174 */ 175 @Override 176 protected String getTagName() { 177 return "jsonParam" ; 178 } 179 180 /** 181 * シリアライズ用のカスタムシリアライズ書き込みメソッド。 182 * 183 * @serialData 一部のオブジェクトは、シリアライズされません 184 * 185 * @param strm ObjectOutputStreamオブジェクト 186 * @throws IOException 入出力エラーが発生した場合 187 */ 188 private void writeObject( final ObjectOutputStream strm ) throws IOException { 189 strm.defaultWriteObject(); 190 } 191 192 /** 193 * シリアライズ用のカスタムシリアライズ読み込みメソッド 194 * 195 * ここでは、transient 宣言された内部変数の内、初期化が必要なフィールドのみ設定します。 196 * 197 * @serialData 一部のオブジェクトは、シリアライズされません。 198 * 199 * @param strm ObjectInputStreamオブジェクト 200 * @see #release2() 201 * @throws IOException シリアライズに関する入出力エラーが発生した場合 202 * @throws ClassNotFoundException クラスを見つけることができなかった場合 203 */ 204 private void readObject( final ObjectInputStream strm ) throws IOException , ClassNotFoundException { 205 strm.defaultReadObject(); 206 } 207}