common
クラス CommonForm

java.lang.Object
  common.CommonForm

すべての実装インタフェース:

java.io.Serializable

直系の既知のサブクラス:

ConfirmForm, XMLForm

public class CommonForm

extends java.lang.Object

implements java.io.Serializable

[共通]Form(画面表示Helper)クラス
各画面の処理はこのクラスを継承した子クラスに記述する

Form(画面表示Helper)クラス-コーディング規約
1. common.CommonFormクラスを親クラスとして実装する
2. 画面表示に必要なDataクラスをpubicなフィールドとして定義する
3. common.CommonFormクラスのactionError(Actionエラークラス)フィールドを使用してエラー処理を行う

関連項目:

直列化された形式

フィールドの概要

ActionError

actionError Actionエラークラス

コンストラクタの概要

CommonForm()
デフォルトコンストラクタ。

メソッドの概要

void	autoCheckScreenParam(javax.servlet.http.HttpServletRequest request, java.lang.String pathinfo, java.lang.String pattern, XMLData xml) (HTTPパラメータが固定値の場合)画面入力値に対して整合性チェックを行い、 Actionエラークラスと項目の背景色を設定する。
void	autoListCheckScreenParam(javax.servlet.http.HttpServletRequest request, java.lang.String pathinfo, java.lang.String pattern, XMLListData xmlList) (HTTPパラメータが固定値の場合)配列型の画面入力値に対して整合性チェックを行い、 Actionエラークラスと項目の背景色を設定する。
protected java.lang.String	blankTrim(java.lang.String str) 文字列の両端から空白→全角空白→空白を除去する。
protected int	checkDateParam(java.lang.String text) 日付[YYYY/MM or M/DD or D]パラメータのチェックを行う。
protected int	checkDoubleParam(java.lang.String text, int intLength, int decLength) 数値[9999.999]パラメータのチェックを行う。
protected int	checkDoubleValue(java.lang.String doubleStr, java.lang.String minValueStr, java.lang.String maxValueStr) 数値(double型)が許容値に収まっているかチェックする。
protected int	checkIntValue(java.lang.String intStr, java.lang.String minValueStr, java.lang.String maxValueStr) 数値(int型)が許容値に収まっているかチェックする。
protected int	checkTextByte(java.lang.String text, int minLength, int maxLength) 文字列が許容バイト数に収まっているかチェックする。
ActionError	getActionError() Actionエラークラスの取得。
protected java.lang.String	getEncodeParameter(javax.servlet.http.HttpServletRequest request, java.lang.String paramName) エンコードされたパラメータを取得する。
protected java.lang.String[]	getEncodeParameterValues(javax.servlet.http.HttpServletRequest request, java.lang.String paramName) エンコードされた複数のパラメータを取得する。
java.lang.String	getErrorMessage() エラーメッセージ群を取得する。
java.lang.String	getMessage() メッセージの取得。
java.lang.String	getOpenerFormName() 親ウィンドウのフォーム名の取得。
char	getShowMode() 表示モードの取得。
void	initMessage() メッセージの初期化。
protected void	initOpenerFormName() 親ウィンドウのフォーム名の初期化。
protected void	initShowMode() 表示モードの初期化。
protected boolean	isHalfNumber(java.lang.String text) 半角数字のみを文字列に含むとき true を返す。
protected boolean	isSpace(java.lang.String str) 文字列が null または ""(空文字) または " "(半角空白のみ) のとき true を返す。
protected boolean	isSymbol(java.lang.String text) 不正記号(｢'｣,｢<｣,｢>｣,｢"｣)を文字列に含むとき true を返す。
protected java.lang.String	paddingZero(java.lang.String numStr, int numLength) 数値を上位0詰めにする。
protected void	printDEBUG(java.lang.String debug) デバッグ情報を出力する。
java.lang.String	printMSTOption(java.util.List mstList, java.lang.String selectId) マスターListのOPTIONタグを表示する。
java.lang.String	printMSTOption(java.util.Map mstMap, java.lang.String selectId) マスターMapのOPTIONタグを表示する。
protected java.lang.String	replaceMatchAll(java.lang.String inputStr, java.lang.String oldStr, java.lang.String newStr) 文字列の置換(一括)を行う。
protected java.lang.String	rn(java.lang.String str) 文字列が null のとき ""(空文字) に変換する。
void	setActionError(ActionError actionError) Actionエラークラスの設定。
void	setListScreenParam(javax.servlet.http.HttpServletRequest request, XMLListData xmlList) 配列型の画面入力値をFormクラスのXMLListDataクラスに格納する(+setCommonScreenParamメソッドの呼び出し)。
void	setMessage(java.lang.String message) メッセージの設定。
void	setOpenerFormName(java.lang.String openerFormName) 親ウィンドウのフォーム名の設定。
void	setScreenParam(javax.servlet.http.HttpServletRequest request, XMLData xml) 画面入力値をFormクラスのXMLDataクラスに格納する(+setCommonScreenParamメソッドの呼び出し)。
void	setShowMode(char showMode) 表示モードの設定。

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

actionError

public ActionError actionError

Actionエラークラス

コンストラクタの詳細

CommonForm

public CommonForm()

デフォルトコンストラクタ。

メソッドの詳細

setActionError

public void setActionError(ActionError actionError)

Actionエラークラスの設定。

パラメータ:

actionError - Actionエラークラス

getActionError

public ActionError getActionError()

Actionエラークラスの取得。

戻り値:

Actionエラークラス

setShowMode

public void setShowMode(char showMode)

表示モードの設定。

パラメータ:

showMode - 表示モード[参照(結果)：S、更新：U、新規作成(入力)：I、削除：D]

getShowMode

public char getShowMode()

表示モードの取得。

戻り値:

表示モード[参照(結果)：S、更新：U、新規作成(入力)：I、削除：D]

initShowMode

protected void initShowMode()

表示モードの初期化。

setOpenerFormName

public void setOpenerFormName(java.lang.String openerFormName)

親ウィンドウのフォーム名の設定。

パラメータ:

openerFormName - 親ウィンドウのフォーム名

getOpenerFormName

public java.lang.String getOpenerFormName()

親ウィンドウのフォーム名の取得。

戻り値:

親ウィンドウのフォーム名

initOpenerFormName

protected void initOpenerFormName()

親ウィンドウのフォーム名の初期化。

setMessage

public void setMessage(java.lang.String message)

メッセージの設定。

パラメータ:

message - メッセージ

getMessage

public java.lang.String getMessage()

メッセージの取得。

戻り値:

メッセージ

initMessage

public void initMessage()

メッセージの初期化。

getErrorMessage

public java.lang.String getErrorMessage()

エラーメッセージ群を取得する。

戻り値:

エラーメッセージ群

printMSTOption

public java.lang.String printMSTOption(java.util.Map mstMap,
                                       java.lang.String selectId)

マスターMapのOPTIONタグを表示する。

パラメータ:

mstMap - マスターMap

selectId - 選択ID

戻り値:

HTML SELECTのOPTIONタグ

printMSTOption

public java.lang.String printMSTOption(java.util.List mstList,
                                       java.lang.String selectId)

マスターListのOPTIONタグを表示する。

パラメータ:

mstList - マスターList

selectId - 選択ID

戻り値:

HTML SELECTのOPTIONタグ

setScreenParam

public void setScreenParam(javax.servlet.http.HttpServletRequest request,
                           XMLData xml)
                    throws java.lang.Exception

画面入力値をFormクラスのXMLDataクラスに格納する(+setCommonScreenParamメソッドの呼び出し)。

パラメータ:

request - リクエスト

xml - XMLDataクラス

例外:

java.lang.Exception

setListScreenParam

public void setListScreenParam(javax.servlet.http.HttpServletRequest request,
                               XMLListData xmlList)
                        throws java.lang.Exception

配列型の画面入力値をFormクラスのXMLListDataクラスに格納する(+setCommonScreenParamメソッドの呼び出し)。

パラメータ:

request - リクエスト

xmlList - XMLListDataクラス

例外:

java.lang.Exception

autoCheckScreenParam

public void autoCheckScreenParam(javax.servlet.http.HttpServletRequest request,
                                 java.lang.String pathinfo,
                                 java.lang.String pattern,
                                 XMLData xml)
                          throws java.lang.Exception

(HTTPパラメータが固定値の場合)画面入力値に対して整合性チェックを行い、 Actionエラークラスと項目の背景色を設定する。

パラメータ:

request - リクエスト

pathinfo - pathinfo(Actionクラスキー)

pattern - パターン(デフォルト:"main")

xml - (データを格納済みの)XMLDataクラス

例外:

java.lang.Exception

autoListCheckScreenParam

public void autoListCheckScreenParam(javax.servlet.http.HttpServletRequest request,
                                     java.lang.String pathinfo,
                                     java.lang.String pattern,
                                     XMLListData xmlList)
                              throws java.lang.Exception

(HTTPパラメータが固定値の場合)配列型の画面入力値に対して整合性チェックを行い、 Actionエラークラスと項目の背景色を設定する。

パラメータ:

request - リクエスト

pathinfo - pathinfo(Actionクラスキー)

pattern - パターン(デフォルト:"main")

xmlList - (データを格納済みの)XMLListDataクラス

例外:

java.lang.Exception

blankTrim

protected java.lang.String blankTrim(java.lang.String str)
                              throws java.lang.Exception

文字列の両端から空白→全角空白→空白を除去する。
処理内容：trim() → 前後の全角空白の除去 → trim()

パラメータ:

str - 文字列

戻り値:

前後の空白が削除された文字列

例外:

java.lang.Exception

rn

protected java.lang.String rn(java.lang.String str)
                       throws java.lang.Exception

文字列が null のとき ""(空文字) に変換する。

パラメータ:

str - 変換する文字列

戻り値:

変換後の文字列

例外:

java.lang.Exception

replaceMatchAll

protected java.lang.String replaceMatchAll(java.lang.String inputStr,
                                           java.lang.String oldStr,
                                           java.lang.String newStr)
                                    throws java.lang.Exception

文字列の置換(一括)を行う。

パラメータ:

inputStr - 入力文字列

oldStr - 以前の文字列

newStr - 新しい文字列

戻り値:

出力文字列
inputStrが空白の場合、numStrをそのまま返す

例外:

java.lang.Exception

isSpace

protected boolean isSpace(java.lang.String str)
                   throws java.lang.Exception

文字列が null または ""(空文字) または " "(半角空白のみ) のとき true を返す。

パラメータ:

str - チェックする文字列

戻り値:

true：null または "" または " "
false：null または "" または " "以外

例外:

java.lang.Exception

checkDoubleParam

protected int checkDoubleParam(java.lang.String text,
                               int intLength,
                               int decLength)
                        throws java.lang.Exception

数値[9999.999]パラメータのチェックを行う。

パラメータ:

text - チェック文字列

intLength - 整数部分の桁数

decLength - 小数部分の桁数

戻り値:

-1:フォーマットチェックエラー
0:正常

例外:

java.lang.Exception

checkDoubleValue

protected int checkDoubleValue(java.lang.String doubleStr,
                               java.lang.String minValueStr,
                               java.lang.String maxValueStr)
                        throws java.lang.Exception

数値(double型)が許容値に収まっているかチェックする。

パラメータ:

doubleStr - チェックする数値(double型)

minValueStr - 最小値(double型)(チェック不要:null)

maxValueStr - 最大値(double型)(チェック不要:null)

戻り値:

-2:フォーマットチェックエラー
-1:最小値を下回っている
0:許容値
1:最大値を上回っている

例外:

java.lang.Exception

checkIntValue

protected int checkIntValue(java.lang.String intStr,
                            java.lang.String minValueStr,
                            java.lang.String maxValueStr)
                     throws java.lang.Exception

数値(int型)が許容値に収まっているかチェックする。

パラメータ:

intStr - チェックする数値(int型)

minValueStr - 最小値(int型)(チェック不要:null)

maxValueStr - 最大値(int型)(チェック不要:null)

戻り値:

-2:フォーマットチェックエラー
-1:最小値を下回っている
0:許容値
1:最大値を上回っている

例外:

java.lang.Exception

checkTextByte

protected int checkTextByte(java.lang.String text,
                            int minLength,
                            int maxLength)
                     throws java.lang.Exception

文字列が許容バイト数に収まっているかチェックする。

パラメータ:

text - チェックする文字列

minLength - 最小バイト数(チェック不要:-1)

maxLength - 最大バイト数(チェック不要:-1)

戻り値:

-1:最小バイト数を下回っている
0:許容バイト数
1:最大バイト数を上回っている

例外:

java.lang.Exception

isSymbol

protected boolean isSymbol(java.lang.String text)
                    throws java.lang.Exception

不正記号(｢'｣,｢<｣,｢>｣,｢"｣)を文字列に含むとき true を返す。

パラメータ:

text - チェックする文字列

戻り値:

true：記号有り
false：記号無し

例外:

java.lang.Exception

isHalfNumber

protected boolean isHalfNumber(java.lang.String text)
                        throws java.lang.Exception

半角数字のみを文字列に含むとき true を返す。

パラメータ:

text - チェックする文字列

戻り値:

true：半角数字のみを文字列に含む
false：半角数字以外を文字列に含む

例外:

java.lang.Exception

checkDateParam

protected int checkDateParam(java.lang.String text)
                      throws java.lang.Exception

日付[YYYY/MM or M/DD or D]パラメータのチェックを行う。

パラメータ:

text - チェックする文字列

戻り値:

-2:フォーマットチェックエラー
-1:妥当性チェックエラー
0:正常

例外:

java.lang.Exception

paddingZero

protected java.lang.String paddingZero(java.lang.String numStr,
                                       int numLength)
                                throws java.lang.Exception

数値を上位0詰めにする。

パラメータ:

numStr - 数値文字列

numLength - 数値の桁数

戻り値:

上位0詰めにした数値文字列
numStrが(空白)または(半角数字以外を文字列に含む)場合、numStrをそのまま返す

例外:

java.lang.Exception

getEncodeParameter

protected java.lang.String getEncodeParameter(javax.servlet.http.HttpServletRequest request,
                                              java.lang.String paramName)
                                       throws java.lang.Exception

エンコードされたパラメータを取得する。

パラメータ:

request - リクエスト

paramName - パラメータ名

戻り値:

エンコードされたパラメータ

例外:

java.lang.Exception

getEncodeParameterValues

protected java.lang.String[] getEncodeParameterValues(javax.servlet.http.HttpServletRequest request,
                                                      java.lang.String paramName)
                                               throws java.lang.Exception

エンコードされた複数のパラメータを取得する。

パラメータ:

request - リクエスト

paramName - パラメータ名

戻り値:

エンコードされた複数のパラメータ

例外:

java.lang.Exception

printDEBUG

protected void printDEBUG(java.lang.String debug)

デバッグ情報を出力する。

パラメータ:

debug -