common
クラス CommonAction

java.lang.Object
  拡張basic.BasicAction
      拡張common.CommonAction
すべての実装インタフェース:
ActionHandle
直系の既知のサブクラス:
CommonRequestManager, XMLAction

public abstract class CommonAction
extends BasicAction

[共通]Actionクラス
各画面の処理はこのクラスを継承した子クラスに記述する

Actionクラス-コーディング規約
1. common.CommonActionクラスを親クラスとして実装する
2. actionPerformedメソッドを必ず記述する
3. デバッグ情報はprintDEBUGメソッドで出力する(System.out.printlnメソッドは使わない)


コンストラクタの概要
CommonAction()
           
 
メソッドの概要
abstract  java.lang.String actionPerformed(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext context)
          各画面からの処理を実行する。
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  ActionError checkScreenParam(ActionError actionError, javax.servlet.http.HttpServletRequest request, java.lang.String pathinfo, java.lang.String pattern)
          画面入力値に対して整合性チェックを行う(HTTPパラメータが固定値の場合)。
protected  ActionError checkScreenParam(ActionError actionError, javax.servlet.http.HttpServletRequest request, java.lang.String pathinfo, java.lang.String pattern, int varSize, java.util.Set varSet)
          画面入力値に対して整合性チェックを行う(HTTPパラメータが可変値の場合)。
protected  int checkTextByte(java.lang.String text, int minLength, int maxLength)
          文字列が許容バイト数に収まっているかチェックする。
protected  java.sql.Connection getConnection(javax.servlet.http.HttpServletRequest request)
          DBコネクションをプールから取得する。
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)
          エンコードされた複数のパラメータを取得する。
protected  boolean isClicked(javax.servlet.http.HttpServletRequest request, java.lang.String name)
          ボタンが押されたかどうか判定する。
protected  boolean isClicked(javax.servlet.http.HttpServletRequest request, java.lang.String name, java.lang.String value)
          ボタンが押されたかどうか判定する。
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)
          デバッグ情報を出力する。
protected  java.lang.String replaceMatchAll(java.lang.String inputStr, java.lang.String oldStr, java.lang.String newStr)
          文字列の置換(一括)を行う。
protected  void returnConnection(java.sql.Connection connection)
          DBコネクションをプールに返す。
protected  java.lang.String rn(java.lang.String str)
          文字列が null のとき ""(空文字) に変換する。
protected  java.lang.String setConfirmForm(javax.servlet.http.HttpServletRequest request, java.lang.String message)
          確認画面フォームにメッセージをセットし、確認画面のJSPへのマップキー("confirm")を返す。
protected  java.lang.String setConfirmForm(javax.servlet.http.HttpServletRequest request, java.lang.String message, java.lang.String openerFormName)
          確認画面フォームにメッセージをセットし、確認画面のJSPへのマップキー("confirm")を返す。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

CommonAction

public CommonAction()
メソッドの詳細

setConfirmForm

protected java.lang.String setConfirmForm(javax.servlet.http.HttpServletRequest request,
                                          java.lang.String message)
                                   throws java.lang.Exception
確認画面フォームにメッセージをセットし、確認画面のJSPへのマップキー("confirm")を返す。

パラメータ:
request - リクエスト
message - 確認画面に表示するメッセージ
戻り値:
確認画面のJSPへのマップキー("confirm")
例外:
java.lang.Exception

setConfirmForm

protected java.lang.String setConfirmForm(javax.servlet.http.HttpServletRequest request,
                                          java.lang.String message,
                                          java.lang.String openerFormName)
                                   throws java.lang.Exception
確認画面フォームにメッセージをセットし、確認画面のJSPへのマップキー("confirm")を返す。

パラメータ:
request - リクエスト
message - 確認画面に表示するメッセージ
openerFormName - 親ウィンドウのフォーム名
戻り値:
確認画面のJSPへのマップキー("confirm")
例外:
java.lang.Exception

checkScreenParam

protected ActionError checkScreenParam(ActionError actionError,
                                       javax.servlet.http.HttpServletRequest request,
                                       java.lang.String pathinfo,
                                       java.lang.String pattern)
                                throws java.lang.Exception
画面入力値に対して整合性チェックを行う(HTTPパラメータが固定値の場合)。

パラメータ:
actionError - Actionエラークラス
request - リクエスト
pathinfo - pathinfo(Actionクラスキー)
pattern - パターン(デフォルト:"main")
戻り値:
Actionエラークラス({pathinfo(Actionクラスキー)の指定が誤っている場合}または{設定ファイルが不正な場合}:null)
例外:
java.lang.Exception

checkScreenParam

protected ActionError checkScreenParam(ActionError actionError,
                                       javax.servlet.http.HttpServletRequest request,
                                       java.lang.String pathinfo,
                                       java.lang.String pattern,
                                       int varSize,
                                       java.util.Set varSet)
                                throws java.lang.Exception
画面入力値に対して整合性チェックを行う(HTTPパラメータが可変値の場合)。

パラメータ:
actionError - Actionエラークラス
request - リクエスト
pathinfo - pathinfo(Actionクラスキー)
pattern - パターン(デフォルト:"main")
varSize - _可変値の要素数(不要の場合:-1)
varSet - _可変値のSet(不要の場合:null)
戻り値:
Actionエラークラス({pathinfo(Actionクラスキー)の指定が誤っている場合}または{設定ファイルが不正な場合}:null)
例外:
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

isClicked

protected boolean isClicked(javax.servlet.http.HttpServletRequest request,
                            java.lang.String name)
                     throws java.lang.Exception
ボタンが押されたかどうか判定する。 [input type="submit"]用

パラメータ:
request - リクエスト
name - ボタンのname属性
戻り値:
ボタンが押されたかどうか
例外:
java.lang.Exception

isClicked

protected boolean isClicked(javax.servlet.http.HttpServletRequest request,
                            java.lang.String name,
                            java.lang.String value)
                     throws java.lang.Exception
ボタンが押されたかどうか判定する。 [input type="button", a href="〜"]用

パラメータ:
request - リクエスト
name - ボタンのname属性
value - ボタンのvalue属性
戻り値:
ボタンが押されたかどうか
例外:
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

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

actionPerformed

public abstract java.lang.String actionPerformed(javax.servlet.http.HttpServletRequest request,
                                                 javax.servlet.http.HttpServletResponse response,
                                                 javax.servlet.ServletContext context)
                                          throws java.lang.Exception
各画面からの処理を実行する。
このクラスを継承した子クラスに必ず記述する。

定義:
インタフェース ActionHandle 内の actionPerformed
定義:
クラス BasicAction 内の actionPerformed
パラメータ:
request - リクエスト
response - レスポンス
context - サーブレットコンテキスト
戻り値:
フォワードするJSPへのマップキー(resultmap.xml)
例外:
java.lang.Exception

getConnection

protected java.sql.Connection getConnection(javax.servlet.http.HttpServletRequest request)
                                     throws java.lang.Exception
DBコネクションをプールから取得する。
ActionクラスでDBコネクションを管理するケースで使用する

パラメータ:
request - リクエスト(DBコネクションが取得できない場合のエラーメッセージに使用する)
戻り値:
DBコネクション
例外:
java.lang.Exception

returnConnection

protected void returnConnection(java.sql.Connection connection)
                         throws java.lang.Exception
DBコネクションをプールに返す。

パラメータ:
connection - DBコネクション
例外:
java.lang.Exception

printDEBUG

protected void printDEBUG(java.lang.String debug)
デバッグ情報を出力する。

パラメータ:
debug -