|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectjp.mosp.common.common.BaseVo
public class BaseVo
Voの基本機能を提供する。
MosPフレームワークでは、HTTPリクエストによって送られたパラメータを
Voインスタンスに設定し、ビジネスロジックを実行した後、UIに表示したい
内容をVoに設定してViewに処理を委譲することを想定している。
つまり、UIとビジネスロジックとの橋渡しをするのがVoの役割となる。
各アプリケーションにおいて、当クラスを拡張してVoクラスを
作成することで、MosPフレームワークを有効に利用できる。
Voは、基本的にフィールド及びアクセサメソッドを有する値保持用の
クラスとして定義する。
BaseVoは、MosPフレームワークにおいて共通で用いられるフィールド及び
そのアクセサメソッド等を実装する。
フィールドの概要 | |
---|---|
protected String[][] |
aryMenu
メニュー配列。 |
protected Properties |
cfg
MosPアプリケーション設定(/WEB-INF/mosp.properties)。 |
protected String |
cmd
リクエストされたコマンド。 |
protected Document |
docXml
レスポンスとしてXMLを返す場合に利用する。 |
protected ArrayList<jp.mosp.common.common.BaseVo.DetailsVo> |
errDetails
エラーフィールド(明細)。 |
protected ArrayList<String> |
errFields
エラーフィールド。 |
protected List<String> |
errMessage
エラーメッセージ。 |
protected boolean |
isValid
妥当性確認用フラグ。 |
protected Properties |
msg
メッセージ設定(/WEB-INF/message.properties)。 |
protected Properties |
nam
文言設定(/WEB-INF/naming.properties)。 |
protected boolean |
needDirectJs
javascript出力要否フラグ。 |
protected String |
retUrl
フォワード先URL。 |
protected String |
subTitle
サブタイトル。 |
protected String |
xmlRetCode
レスポンスと返すXMLに付加するリターンコード。 |
コンストラクタの概要 | |
---|---|
BaseVo()
VOの初期設定を行う。 |
|
BaseVo(Properties cfg,
Properties msg,
Properties nam,
String cmd,
CmAspUserDto aspUser,
CmUserDto user)
VOの初期設定を行う。 |
メソッドの概要 | |
---|---|
void |
addErrDetails(int rowNo,
String fieldId)
エラーフィールド(明細)を追加する。 |
void |
addErrField(String errorFieldId)
エラーフィールドを追加する。 |
void |
addErrMessage(String errorMessage)
エラーメッセージを追加する。 |
void |
addExtraCss(String extraCss)
個別cssファイルURLを追加する。 |
void |
addExtraJs(String extraJs)
個別javascriptファイルURLを追加する。 |
protected void |
appendElement(Element parentElement,
Element childElement)
Element追加。 |
protected void |
appendTextElement(Element parentElement,
String tagName,
String data)
TextElement追加。 |
protected void |
checkCode(String value,
String name,
int rowNo,
String id)
文字列タイプ確認(半角英数字)(明細)。 |
protected void |
checkCode(String value,
String name,
String id)
文字列タイプ確認(半角英数字)。 |
protected void |
checkCompare(String value1,
String value2,
int compareFlag,
String name,
String id1,
String id2)
値比較。 |
protected void |
checkDate(int year,
int month,
int day,
String name,
int rowNo,
String id)
日付妥当性確認(明細)。 |
protected void |
checkDate(int year,
int month,
int day,
String name,
String id)
日付妥当性確認。 |
void |
checkDateBeforeAfter(Date beforeDate,
Date afterDate,
boolean isSameValid,
String beforeName,
String afterName,
String idYear,
String idMonth,
String idDay)
日付大小確認。 |
protected void |
checkDecimal(String value,
int integer,
int decimal,
String name,
String id,
boolean isDetails,
int rowNo)
文字列タイプ確認(少数)。 |
protected void |
checkLength(String value,
int maxLength,
String name,
int rowNo,
String id)
文字列長確認(最大文字数)(明細)。 |
protected void |
checkLength(String value,
int maxLength,
String name,
String id)
文字列長確認(最大文字数)。 |
protected void |
checkNumber(String value,
String name,
int rowNo,
String id)
文字列タイプ確認(数字)(明細)。 |
protected void |
checkNumber(String value,
String name,
String id)
文字列タイプ確認(数字)。 |
protected void |
checkNumeric(String value,
String name,
int rowNo,
String id)
文字列タイプ確認(数値:double)(明細)。 |
protected void |
checkNumeric(String value,
String name,
String id)
文字列タイプ確認(数値:double)。 |
protected void |
checkPassword(String oldPassword,
String currentPass,
String id)
旧パスワード確認。 |
protected void |
checkPhone(String value,
String name,
String id)
文字列タイプ確認(半角英数字)。 |
protected void |
checkRegex(String value,
String regex,
String name,
int rowNo,
String id)
文字列タイプ確認(任意)(明細)。 |
protected void |
checkRegex(String value,
String regex,
String name,
String id)
文字列タイプ確認(任意)。 |
protected void |
checkRequired(String value,
String name,
int rowNo,
String id)
必須確認(明細)。 |
protected void |
checkRequired(String value,
String name,
String id)
必須確認。 |
protected void |
checkTerm(Date date,
Date startDate,
Date endDate,
String name,
int rowNo,
String id)
日付期間妥当性確認(明細)。 |
protected void |
checkTerm(Date date,
Date startDate,
Date endDate,
String name,
String id)
日付期間妥当性確認。 |
protected void |
checkTime(int hour,
int minute,
int second,
String name,
int rowNo,
String id)
時間妥当性確認(明細)。 |
protected void |
checkTime(int hour,
int minute,
int second,
String name,
String id)
時間妥当性確認。 |
void |
clearErrField()
エラーフィールド除去。 |
void |
clearMessage()
メッセージ除去。 |
protected Element |
createElement(String tagName)
Element作成。 |
protected void |
endValidation()
妥当性確認終了時処理。 |
static String |
escapeHTML(String aStr)
HTMLエスケープ。 |
protected Date[] |
getAryField(Date[] aryField)
配列フィールド取得。 |
protected String[] |
getAryField(String[] aryField)
配列フィールド取得。 |
protected String[][] |
getAryField(String[][] aryField)
配列フィールド取得。 |
String[][] |
getAryMenu()
メニュー配列を取得する。 |
String |
getAspName()
ASPユーザー名を取得する。 |
String |
getAspUserId()
ASPユーザーIDを取得する。 |
String |
getClassName()
クラス名を取得する。 |
String |
getCommonCss()
共通cssファイルURLを取得する。 |
String |
getCopy()
アプリケーション著作権表示を取得する。 |
Date |
getDate(String year,
String month,
String day)
日付取得。 |
protected Date |
getDateField(Date dateField)
日付フィールド取得。 |
String |
getDirectJs(Class<?> cls)
javascript取得。 |
String |
getDirectJs(Class<?> cls,
Object obj)
javascript取得。 |
Document |
getDocXml()
XMLドキュメントを取得する。 |
double |
getDoubleParam(String value)
doubleリクエストパラメータ取得。 |
List<String> |
getErrMessage()
エラーメッセージを取得する。 |
String |
getEscAspName()
ASPユーザー名を取得する。 |
String |
getEscAspUserId()
ASPユーザーIDを取得する。 |
String |
getEscCommonCss()
共通cssファイルURLを取得する。 |
String |
getEscCopy()
アプリケーション著作権表示を取得する。 |
String |
getEscMessage()
メッセージを取得する。 |
String |
getEscProcSeq()
処理シーケンスを取得する。 |
String |
getEscTitle()
アプリケーションタイトルを取得する。 |
String |
getEscUserId()
ユーザーIDを取得する。 |
String |
getEscUserName()
ユーザー名を取得する。 |
String |
getEscVersion()
アプリケーションバージョンを取得する。 |
List<String> |
getExtraCss()
個別cssファイルURLを取得する。 |
List<String> |
getExtraJs()
個別javascriptファイルURLを取得する。 |
float |
getFloatParam(String value)
floatリクエストパラメータ取得。 |
protected String |
getFormatNumber(double value,
String format)
整形数値取得。 |
int |
getIntParam(String value)
intリクエストパラメータ取得。 |
boolean |
getIsDialog()
ダイアログフラグを取得する。 |
String |
getLogoPath()
ロゴファイルのパスを取得する。 |
long |
getLongParam(String value)
longリクエストパラメータ取得。 |
String |
getMessage()
メッセージを取得する。 |
String |
getName(String key)
文言取得。 |
String |
getProcSeq()
処理シーケンスを取得する。 |
String |
getRetUrl()
フォワード先URLを取得する。 |
protected String |
getStrDay(Date dateField)
日付フィールド取得。 |
String |
getStrDocXml()
XML文字列取得。 |
protected String |
getStrMonth(Date dateField)
日付フィールド取得。 |
protected String |
getStrYear(Date dateField)
日付フィールド取得。 |
String |
getSubTitle()
subTitle を取得する。 |
Date |
getTime(String time)
日付取得。 |
String |
getTitle()
アプリケーションタイトルを取得する。 |
String |
getUserId()
ユーザーIDを取得する。 |
String |
getUserName()
ユーザー名を取得する。 |
String |
getVersion()
アプリケーションバージョンを取得する。 |
String |
getXmlRetCode()
XMLリターンコードを取得する。 |
void |
initVo(Properties cfg,
Properties msg,
Properties nam,
String cmd,
CmAspUserDto aspUser,
CmUserDto user)
VO初期化。 |
void |
initVo(Properties cfg,
Properties msg,
String cmd,
CmAspUserDto aspUser,
CmUserDto user)
VO初期化。 |
protected Element |
initXmlDoc()
XMLDocument初期化。 |
void |
setAspName(String aspName)
ASPユーザー名を設定する。 |
void |
setAspUserId(String aspUserId)
ASPユーザーIDを設定する。 |
void |
setCommonCss(String commonCss)
共通cssファイルURLを設定する。 |
void |
setCopy(String copy)
アプリケーション著作権表示を設定する。 |
void |
setErrMessage(List<String> errMessage)
エラーメッセージを設定する。 |
void |
setExtraCss(String extraCss)
個別cssファイルURLを設定する。 |
void |
setExtraJs(String extraJs)
個別javascriptファイルURLを設定する。 |
protected void |
setFieldsName()
項目名称を設定する。 |
void |
setIsDialog(boolean isDialog)
ダイアログフラグを設定する。 |
void |
setMessage(String message)
メッセージを設定する。 |
void |
setProcSeq(String procSeq)
処理シーケンスを設定する。 |
void |
setRetUrl(String retUrl)
フォワード先URLを設定する。 |
protected void |
setSubTitle()
サブタイトルを設定する。 |
void |
setTitle(String title)
アプリケーションタイトルを設定する。 |
void |
setUserId(String userId)
ユーザーIDを設定する。 |
void |
setUserName(String userName)
ユーザー名を設定する。 |
void |
setVersion(String version)
アプリケーションバージョンを設定する。 |
protected void |
setViewPath(String className)
MosPフレームワーク表示用ファイルパス設定 |
void |
setXmlRetCode(String xmlRetCode)
XMLリターンコードを設定する。 |
protected void |
startValidation()
妥当性確認開始時処理。 |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
フィールドの詳細 |
---|
protected String cmd
protected boolean isValid
protected Properties cfg
protected Properties msg
protected Properties nam
protected List<String> errMessage
protected ArrayList<String> errFields
protected ArrayList<jp.mosp.common.common.BaseVo.DetailsVo> errDetails
protected boolean needDirectJs
getDirectJs(Class, Object)
でjavascript出力要否判定基準となる。
protected String retUrl
protected transient Document docXml
protected String xmlRetCode
protected String subTitle
HtmlUtility.getSubTitle(BaseVo)
で、用いられる。
protected String[][] aryMenu
HtmlUtility.getSubTitle(BaseVo)
で、用いられる。
コンストラクタの詳細 |
---|
public BaseVo()
needDirectJs
設定(false)
public BaseVo(Properties cfg, Properties msg, Properties nam, String cmd, CmAspUserDto aspUser, CmUserDto user)
cfg
- 設定ファイルmsg
- メッセージファイルnam
- 文言ファイルcmd
- コマンドaspUser
- ASPユーザーuser
- ユーザーメソッドの詳細 |
---|
public void initVo(Properties cfg, Properties msg, String cmd, CmAspUserDto aspUser, CmUserDto user)
cfg
- 設定ファイルmsg
- メッセージファイルcmd
- コマンドaspUser
- ASPユーザーuser
- ユーザーpublic void initVo(Properties cfg, Properties msg, Properties nam, String cmd, CmAspUserDto aspUser, CmUserDto user)
initVo(Properties, Properties, String, CmAspUserDto, CmUserDto)
に加え、nam
を設定する。
cfg
- 設定ファイルmsg
- メッセージファイルnam
- 文言ファイルcmd
- コマンドaspUser
- ASPユーザーuser
- ユーザーprotected void setFieldsName()
nam
から文言を取得し、項目名称を設定する。BaseVo
を拡張したクラスでオーバーライドして用いる。
protected void setSubTitle()
public String getTitle()
initVo(Properties, Properties, String, CmAspUserDto, CmUserDto)
でmosp.propertiesから値を取得し、設定される。
public String getEscTitle()
VoInterface
内の getEscTitle
public void setTitle(String title)
title
- アプリケーションタイトルpublic String getVersion()
public String getEscVersion()
VoInterface
内の getEscVersion
public void setVersion(String version)
version
- アプリケーションバージョンpublic String getCopy()
public String getEscCopy()
VoInterface
内の getEscCopy
public void setCopy(String copy)
copy
- アプリケーション著作権表示public String getAspUserId()
public String getEscAspUserId()
public void setAspUserId(String aspUserId)
aspUserId
- ASPユーザーIDpublic String getAspName()
public String getEscAspName()
public void setAspName(String aspName)
aspName
- ASPユーザー名public String getUserId()
public String getEscUserId()
public void setUserId(String userId)
userId
- ユーザーIDpublic String getUserName()
public String getEscUserName()
public void setUserName(String userName)
userName
- ユーザー名public String getCommonCss()
public String getEscCommonCss()
VoInterface
内の getEscCommonCss
public void setCommonCss(String commonCss)
commonCss
- 共通cssファイルURLpublic List<String> getExtraJs()
VoInterface
内の getExtraJs
public void setExtraJs(String extraJs)
extraJs
- 個別javascriptファイルURLpublic void addExtraJs(String extraJs)
extraJs
- 個別javascriptファイルURLpublic List<String> getExtraCss()
VoInterface
内の getExtraCss
public void setExtraCss(String extraCss)
extraCss
- 個別cssファイルURLpublic void addExtraCss(String extraCss)
extraCss
- 個別cssファイルURLpublic String getMessage()
public String getEscMessage()
VoInterface
内の getEscMessage
public void setMessage(String message)
VoInterface
内の setMessage
message
- public String getProcSeq()
public String getEscProcSeq()
VoInterface
内の getEscProcSeq
public void setProcSeq(String procSeq)
VoInterface
内の setProcSeq
procSeq
- 処理シーケンスpublic void setErrMessage(List<String> errMessage)
VoInterface
内の setErrMessage
errMessage
- エラーメッセージリストpublic List<String> getErrMessage()
VoInterface
内の getErrMessage
public String getRetUrl()
public void setRetUrl(String retUrl)
retUrl
- フォワード先URLpublic String getXmlRetCode()
VoInterface
内の getXmlRetCode
public void setXmlRetCode(String xmlRetCode)
xmlRetCode
- XMLリターンコードpublic Document getDocXml()
public boolean getIsDialog()
VoInterface
内の getIsDialog
public void setIsDialog(boolean isDialog)
isDialog
- ダイアログフラグpublic String getClassName()
VoInterface
内の getClassName
public String getSubTitle()
subTitle
を取得する。
public String[][] getAryMenu()
public void addErrMessage(String errorMessage)
VoInterface
内の addErrMessage
errorMessage
- エラーメッセージpublic void addErrField(String errorFieldId)
VoInterface
内の addErrField
errorFieldId
- エラーフィールドpublic void addErrDetails(int rowNo, String fieldId)
VoInterface
内の addErrDetails
rowNo
- 行番号fieldId
- エラーフィールドpublic void clearMessage()
public void clearErrField()
protected void startValidation()
protected void endValidation() throws MospException
MospException
protected void checkRequired(String value, String name, String id) throws MospException
value
- 確認対象文字列name
- 確認対象名称id
- 確認対象フィールドID
MospException
protected void checkRequired(String value, String name, int rowNo, String id) throws MospException
value
- 確認対象文字列name
- 確認対象名称rowNo
- 行番号id
- 確認対象フィールドID
MospException
protected void checkCode(String value, String name, String id) throws MospException
value
- 確認対象文字列name
- 確認対象名称id
- 確認対象フィールドID
MospException
protected void checkCode(String value, String name, int rowNo, String id) throws MospException
value
- 確認対象文字列name
- 確認対象名称rowNo
- 行番号id
- 確認対象フィールドID
MospException
protected void checkNumber(String value, String name, String id) throws MospException
value
- 確認対象文字列name
- 確認対象名称id
- 確認対象フィールドID
MospException
protected void checkNumber(String value, String name, int rowNo, String id) throws MospException
value
- 確認対象文字列name
- 確認対象名称rowNo
- 行番号id
- 確認対象フィールドID
MospException
protected void checkRegex(String value, String regex, String name, String id) throws MospException
value
- 確認対象文字列regex
- 正規表現文字列name
- 確認対象名称id
- 確認対象フィールドID
MospException
protected void checkRegex(String value, String regex, String name, int rowNo, String id) throws MospException
value
- 確認対象文字列regex
- 正規表現文字列name
- 確認対象名称rowNo
- 行番号id
- 確認対象フィールドID
MospException
protected void checkNumeric(String value, String name, String id) throws MospException
value
- 確認対象文字列name
- 確認対象名称id
- 確認対象フィールドID
MospException
protected void checkNumeric(String value, String name, int rowNo, String id) throws MospException
value
- 確認対象文字列name
- 確認対象名称rowNo
- 行番号id
- 確認対象フィールドID
MospException
protected void checkLength(String value, int maxLength, String name, String id) throws MospException
value
- 確認対象文字列maxLength
- 最大文字数name
- 確認対象名称id
- 確認対象フィールドID
MospException
protected void checkLength(String value, int maxLength, String name, int rowNo, String id) throws MospException
value
- 確認対象文字列maxLength
- 最大文字数name
- 確認対象名称rowNo
- 行番号id
- 確認対象フィールドID
MospException
protected void checkDate(int year, int month, int day, String name, String id) throws MospException
year
- 年month
- 月(1〜12)day
- 日name
- 確認対象名称id
- 確認対象フィールドID
MospException
protected void checkDate(int year, int month, int day, String name, int rowNo, String id) throws MospException
year
- 年month
- 月(1〜12)day
- 日name
- 確認対象名称rowNo
- 行番号id
- 確認対象フィールドID
MospException
protected void checkTerm(Date date, Date startDate, Date endDate, String name, String id) throws MospException
date
- 確認対象日startDate
- 開始日endDate
- 終了日name
- 確認対象名称id
- 確認対象フィールドID
MospException
protected void checkTerm(Date date, Date startDate, Date endDate, String name, int rowNo, String id) throws MospException
date
- 確認対象日startDate
- 開始日endDate
- 終了日name
- 確認対象名称rowNo
- 行番号id
- 確認対象フィールドID
MospException
protected void checkTime(int hour, int minute, int second, String name, String id) throws MospException
hour
- 時minute
- 分second
- 秒name
- 確認対象名称id
- 確認対象フィールドID
MospException
protected void checkTime(int hour, int minute, int second, String name, int rowNo, String id) throws MospException
hour
- 時minute
- 分second
- 秒name
- 確認対象名称rowNo
- 行番号id
- 確認対象フィールドID
MospException
protected void checkCompare(String value1, String value2, int compareFlag, String name, String id1, String id2) throws MospException
value1
- 比較値1value2
- 比較値2compareFlag
- 確認フラグ(0:値同一でtrue、1:値同一でfalse)name
- 確認対象名称id1
- 確認対象フィールドID1id2
- 確認対象フィールドID2
MospException
public void checkDateBeforeAfter(Date beforeDate, Date afterDate, boolean isSameValid, String beforeName, String afterName, String idYear, String idMonth, String idDay) throws MospException
beforeDate
- 日付(前)afterDate
- 日付(後)isSameValid
- 同一日有効フラグ(true:同一日有効、false:同一日不可)
MospException
protected void checkPhone(String value, String name, String id) throws MospException
value
- 確認対象文字列name
- 確認対象名称id
- 確認対象フィールドID
MospException
protected void checkDecimal(String value, int integer, int decimal, String name, String id, boolean isDetails, int rowNo) throws MospException
value
- 確認対象文字列integer
- 整数部桁数decimal
- 小数部桁数name
- 確認対象名称id
- 確認対象フィールドIDisDetails
- 明細フラグrowNo
- 行番号
MospException
protected void checkPassword(String oldPassword, String currentPass, String id) throws MospException
oldPassword
- 旧パスワードcurrentPass
- 現在のパスワードid
- 確認対象フィールドID
MospException
public int getIntParam(String value)
value
- intリクエストパラメータ値
public long getLongParam(String value)
value
- longリクエストパラメータ値
public float getFloatParam(String value)
value
- intリクエストパラメータ値
public double getDoubleParam(String value)
value
- doubleリクエストパラメータ値
public Date getTime(String time) throws MospException
time
- 時間(hh:MM)
MospException
public Date getDate(String year, String month, String day) throws MospException
year
- 年month
- 月day
- 日
MospException
protected String[] getAryField(String[] aryField)
aryField
- 対象配列
protected String[][] getAryField(String[][] aryField)
aryField
- 対象配列
protected Date[] getAryField(Date[] aryField)
aryField
- 対象配列
protected Date getDateField(Date dateField)
dateField
- 対象日付
protected String getStrYear(Date dateField)
dateField
- 対象日付
protected String getStrMonth(Date dateField)
dateField
- 対象日付
protected String getStrDay(Date dateField)
dateField
- 対象日付
protected String getFormatNumber(double value, String format)
value
- 対象値format
- フォーマット文字列
public static String escapeHTML(String aStr)
aStr
- エスケープ対象文字列
protected Element initXmlDoc() throws ParserConfigurationException
docXml
の準備を行う。
ParserConfigurationException
protected Element createElement(String tagName)
tagName
- タグ名protected void appendElement(Element parentElement, Element childElement)
parentElement
- 追加先エレメントchildElement
- 追加エレメントprotected void appendTextElement(Element parentElement, String tagName, String data)
parentElement
- 追加先エレメントtagName
- 追加タグ名data
- 追加データpublic String getStrDocXml() throws TransformerException
docXml
を文字列に変換する。
TransformerException
public String getDirectJs(Class<?> cls, Object obj) throws IllegalAccessException
VoInterface
内の getDirectJs
cls
- クラスobj
- オブジェクト
IllegalAccessException
public String getDirectJs(Class<?> cls) throws IllegalAccessException
VoInterface
内の getDirectJs
cls
- クラス
IllegalAccessException
public String getLogoPath()
cfg
にロゴファイルパスが未設定の場合、
或いは空白の場合は、NULLを返す。
public String getName(String key)
nam
から文言を取得する。
key
- 設定キー
protected void setViewPath(String className)
className
- 対象VOクラス名
BaseVo
を継承している対象VOの表示用ファイルパスを設定するメソッド。
BaseVo()
を呼び出した後、getClassName()
をパラメータにセットすることで、
対象VOに直接jsp、css、jsのファイルパスをハードコードしなくても呼び出すことができる。
その代わり、ファイルの場所は必ず規約通りの場所にしなければならない。
もちろん、このメソッドを利用せず、従来の方法を利用することも可能である。
ファイルの場所の規約はViewFileLocationUtility.ViewFileLocationUtility(String)
を参照すること。
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |