ActionFormは1つ以上のActionMappings
* に関連づけることのできるJavaBeanです。
* このBeanのプロパティは、対応するアクションのexecute
* メソッドが呼び出される前に、
* 対応するリクエストパラメータで初期化されます。
An ActionForm is a JavaBean optionally associated with
* one or more ActionMappings. Such a bean will have had its
* properties initialized from the corresponding request parameters before
* the corresonding action's execute method is called.
Beanのプロパティが設定されると、
* アクションのexecuteメソッドが呼び出される前にこのBeanの
* validateメソッドが呼び出されます。
* これはユーザから提示されたプロパティが正しくて妥当であるかを確かめる機会を
* Beanに与えます。
* このメソッドで問題が発見された場合、
* 発生した問題をカプセル化したエラーメッセージオブジェクトを返し、
* コントローラServletは対応する入力フォームにコントロールを返します。
* また、全てのプロパティが条件に合っていて、
* 対応するアクションのexecute
* メソッドが呼び出されるべきである場合は
* validateメソッドはnullを返します。
When the properties of this bean have been populated, but before the
* execute method of the action is called, this bean's
* validate method will be called, which gives the bean a chance
* to verify that the properties submitted by the user are correct and valid.
* If this method finds problems, it returns an error messages object that
* encapsulates those problems, and the controller servlet will return control
* to the corresponding input form. Otherwise, the validate
* method returns null, indicating that everything is acceptable
* and the corresponding Action's execute method should be
* called.
このクラスをインスタンス化するためにサブクラスを作成する必要があります。 * サブクラスは公開したい全てのBeanプロパティのためのgetterメソッドと * setterメソッドを提供し、 * さらににpublicメソッドや * protectedメソッドを機能の変更に応じてオーバライドすべきです。 *
* {@primaryThis class must be subclassed in order to be instantiated. Subclasses * should provide property getter and setter methods for all of the bean * properties they wish to expose, plus override any of the public or * protected methods for which they wish to provide modified functionality. *
} * *ActionFormsはJavaBeansですので、
* JavaBean仕様を満たすようサブクラスも
* Serializableを実装すべきです。
* いくつかのコンテナでは、
* ActionFormsが頼みにしているイントロスペクションAPIを用いるために、
* オブジェクトがJavaBeanの全ての要件を満たすことが要求されます。
Because ActionForms are JavaBeans, subclasses should also implement
* Serializable, as required by the JavaBean specification.
* Some containers require that an object meet all JavaBean requirements
* in order to use the introspection API upon which ActionForms rely.
nullのこともあります。
* {@primary The MultipartRequestHandler for this form, can be
* null.}
*/
protected transient MultipartRequestHandler multipartRequestHandler;
// ------------------------------------------------------------- Properties
/**
* 結びつけられているコントローラServletのインスタンスを返します。
* {@primary Return the controller servlet instance to which we are attached.}
*/
protected ActionServlet getServlet() {
return (this.servlet);
}
/**
* 結びつけられているコントローラServletのインスタンスを
* ActionServletWrapperとして返します。
* {@primary Return the controller servlet instance to which we are attached.
* as an ActionServletWrapper.}
* @see org.apache.struts.action.ActionServletWrapper
* @since Struts 1.0.1
*/
public ActionServletWrapper getServletWrapper() {
return new ActionServletWrapper(getServlet());
}
/**
* このフォームのMultipartRequestHandlerを返します。
* この背景にある理由は、
* MultipartRequestHandlerのfinish()メソッドと
* rollback()メソッドを使用することによって、
* フォームBeanの開発者がマルチパートのリクエストのライフサイクルを操作できるようにするためです。
* このフォームのenctypeが"multipart/request-data"
* でない場合はこのメソッドはnullを返します。
* {@annotation "multipart/form-data"が正しいと思います。}
* {@primary Return the MultipartRequestHandler for this form
* The reasoning behind this is to give form bean developers
* control over the lifecycle of their multipart requests
* through the use of the finish() and/or rollback() methods
* of MultipartRequestHandler. This method will return
* null if this form's enctype is not
* "multipart/request-data".}
* @see org.apache.struts.upload.MultipartRequestHandler
*/
public MultipartRequestHandler getMultipartRequestHandler() {
return multipartRequestHandler;
}
/**
* 結びつけられているコントローラServletのインスタンスをセットします
* （servletがnullでない場合）。
* また、割り当てられた全てのリソースを解放します
* （servletがnullである場合）。
* {@primary Set the controller servlet instance to which we are attached (if
* servlet is non-null), or release any allocated resources
* (if servlet is null).}
*
* @param servlet もしあれば、新しいコントローラServlet
* {@primary The new controller servlet, if any}
*/
public void setServlet(ActionServlet servlet) {
this.servlet = servlet;
}
/**
* ファイルアップロードを扱う際に使用するために与えられたHandlerを設定します。
* {@primary Set the Handler provides to use in dealing with file uploads.}
* {@note providesはprovidedの間違いと考えて訳しています。}
* @param multipartRequestHandler ファイルアップロードに使用するHandler。
* {@primary The Handler to use for fileuploads.}
*/
public void setMultipartRequestHandler(MultipartRequestHandler multipartRequestHandler) {
this.multipartRequestHandler = multipartRequestHandler;
}
// --------------------------------------------------------- Public Methods
/**
* Beanの全てのプロパティをデフォルトの状態にリセットします。
* このメソッドはコントローラServlet
* がプロパティを設定する前に呼び出されます。
* {@primary Reset all bean properties to their default state. This method is
* called before the properties are repopulated by the controller servlet.}
* * デフォルトの実装はこのメソッドのHTTPバージョンにフォワードします。 * {@primary
* The default implementation attempts to forward to the HTTP * version of this method.} * * @param mapping このインスタンスを選択するために用いられたマッピング * {@primary The mapping used to select this instance} * @param request 処理しているServletリクエスト * {@primary The servlet request we are processing} */ public void reset(ActionMapping mapping, ServletRequest request) { try { reset(mapping, (HttpServletRequest) request); } catch (ClassCastException e) { ; } } /** * Beanの全てのプロパティをデフォルトの状態にリセットします。 * このメソッドはコントローラServlet * がプロパティを設定する前に呼び出されます。 * {@primary Reset all bean properties to their default state. This method is * called before the properties are repopulated by the controller servlet.} *
* デフォルトの実装は何もしません。 * サブクラスは全てのBeanプロパティをデフォルトの値にリセットするためにこのメソッドをオーバライドすべきです。 *
* {@primary* The default implementation does nothing. Subclasses should override * this method to reset all bean properties to default values. *
} ** 「更新」タイプのページに関しては、 * このメソッドはフォームの値を初期化する場所としてはふさわしくありません * （値の初期化はセットアップ用のActionの中で行なうべきです）。 * チェックボックスの値をfalseに設定することについて主に気にする必要がありますが、 * ほとんどの場合はこのメソッドを実装しないでおいて構いません。 *
* {@primary* This method is not the appropriate place to initialize form values * for an "update" type page (this should be done in a setup Action). You mainly * need to worry about setting checkbox values to false; most of the time you * can leave this method unimplemented. *
} * * @param mapping このインスタンスを選択するために用いられたマッピング * {@primary The mapping used to select this instance} * @param request 処理しているServletリクエスト * {@primary The servlet request we are processing} */ public void reset(ActionMapping mapping, HttpServletRequest request) { ; // Default implementation does nothing } /** * 非HTTPリクエストにセットされているプロパティの妥当性を検証して、 * 見つかった全ての検証エラーをカプセル化した *ActionErrorsオブジェクトを返します。
* エラーが見つからなかった場合はnull
* もしくはエラーメッセージが何も記録されていない
* ActionErrorsオブジェクトを返します。
* {@primary Validate the properties that have been set for this non-HTTP request,
* and return an ActionErrors object that encapsulates any
* validation errors that have been found. If no errors are found, return
* null or an ActionErrors object with no
* recorded error messages.}
* * デフォルトの実装はこのメソッドのHTTPバージョンにフォワードします。 * {@primary
* The default implementation attempts to forward to the HTTP version of
* this method.}
*
* @param mapping このインスタンスを選択するために用いられたマッピング
* {@primary The mapping used to select this instance}
* @param request 処理しているServletリクエスト
* {@primary The servlet request we are processing}
*/
public ActionErrors validate(ActionMapping mapping,
ServletRequest request) {
try {
return (validate(mapping, (HttpServletRequest) request));
} catch (ClassCastException e) {
return (null);
}
}
/**
* HTTPリクエストにセットされているプロパティの妥当性を検証して、
* 見つかった全ての検証エラーをカプセル化した
* ActionErrorsオブジェクトを返します。
* エラーが見つからなかった場合はnull
* もしくはエラーメッセージが何も記録されていない
* ActionErrorsオブジェクトを返します。
* {@primary Validate the properties that have been set for this HTTP request,
* and return an ActionErrors object that encapsulates any
* validation errors that have been found. If no errors are found,
* return null or an ActionErrors object with
* no recorded error messages.}
*
* デフォルトの実装は何の検証も行なわずにnullを返します。
* サブクラスは独自の妥当性の検証を行なうためにこのメソッドをオーバライドしなくてはいけません。
* {@primary
* The default ipmlementation performs no validation and returns
* null. Subclasses must override this method to provide
* any validation they wish to perform.}
*
* @param mapping このインスタンスを選択するために用いられたマッピング
* {@primary The mapping used to select this instance}
* @param request 処理しているServletリクエスト
* {@primary The servlet request we are processing}
*/
public ActionErrors validate(ActionMapping mapping,
HttpServletRequest request) {
return (null);
}
}