org.apache.struts.action
クラス ActionMapping

java.lang.Object
  拡張org.apache.struts.action.ActionMapping
すべての実装インタフェース:
java.io.Serializable
直系の既知のサブクラス:
ActionMappingBase, RequestActionMapping, SessionActionMapping

public class ActionMapping
extends java.lang.Object
implements java.io.Serializable

ActionMappingはコントローラサーブレットであるActionServletが知っている情報(リクエストとアクションクラスのインスタンスとのマッピング)を表します。 このクラスのオブジェクトはアクションクラスのperform()メソッドに渡されるので、アクションクラスは直接マッピングの情報にアクセスすることが可能です。

ActionMappingは少なくとも以下のプロパティを持ちます。 追加プロパティは、サブクラスで適切なpublicアクセスのゲッター、セッターメソッドを提供することで簡単に追加することができます。

バージョン:
$Revision: 1.2 $ $Date: 2003/03/22 07:55:10 $
作成者:
Craig R. McClanahan
関連項目:
直列化された形式
翻訳者:
おかだひでひさ [日本語訳のコメントは、report@jajakarta.orgに送ってください。]

フィールドの概要
protected  java.lang.String attribute
          生成されたアクションフォームBeanが存在する場合に、それが保持されているリクエストまたはセッションの属性名です。
protected  java.lang.String forward
          RequestDispatcher.forward()によって呼び出され、リクエストを処理するサーブレットやJSPリソースのコンテキスト相対パスです。
protected  ActionForwards forwards
          このマッピングに関連付けられているActionForwardオブジェクトの集合です。
protected  java.lang.String include
          RequestDispatcher.include()によって呼び出され、リクエストを処理するサーブレットやJSPリソースのコンテキスト相対パスです。
protected  java.lang.String input
          入力パラメータの検証エラーが発生した場合に制御を戻す入力フォームのコンテキスト相対パスです。
protected  Action instance
          このマッピングのために初期化されたActionクラスのインスタンスです。
protected  ActionMappings mappings
          このマッピングオブジェクトをその一部とするActionMappingsコレクションです。
protected  java.lang.String multipartClass
          このマッピングへのマルチパートリクエストを処理するために使用される、 MultipartRequestHandler実装クラスの完全修飾名です。
protected  java.lang.String name
          このアクションに関連付けられているアクションフォームBeanの名前です。
protected  java.lang.String parameter
          このマッピングのために汎用的に使用できるパラメータです。
protected  java.lang.String path
          このアクションへマップされる、コンテキスト相対リクエストパスです。
protected  java.lang.String prefix
          このアクションのためのパラメータを選択するのに使用するパラメータ名のプレフィックスです。
protected  java.lang.String scope
          このマッピングに関連付けられているアクションフォームBeanを保持しているスコープの識別子です。
protected  java.lang.String suffix
          このアクションのためのパラメータを選択するのに使用するパラメータ名のサフィックスです。
protected  java.lang.String type
          このマッピングに向けられたリクエストを処理するのに使用される、Action実装クラスの完全修飾名です。
protected  boolean unknown
          このマッピングがアプリケーションのデフォルトに設定される場合はtrueです。
protected  boolean validate
          アクションフォームBeanのvalidate()メソッドが呼ばれる場合はtrueです。
 
コンストラクタの概要
ActionMapping()
           
 
メソッドの概要
 void addForward(ActionForward forward)
          このマッピングに関連付けられる新しいActionForwardを追加します。
 ActionForm createFormInstance()
          推奨されていません。 アクションフォームインスタンスの生成はコントローラServletによって行われます。
 ActionForward findForward(java.lang.String name)
          指定された名前のActionForwardがあれば、それを返します。
 java.lang.String[] findForwards()
          このマッピングに定義された全てのローカルフォワードの論理名を返します。
 java.lang.String getActionClass()
          推奨されていません。 getType()を使うようにして下さい。
 java.lang.String getAttribute()
          アクションフォームBeanのための属性名を返します。
 java.lang.String getFormAttribute()
          推奨されていません。 getAttribute()を使うようにして下さい。
 java.lang.String getFormClass()
          推奨されていません。 Beanの名前を用いて対応するアクションフォームBeanを取得するようにして下さい。
 java.lang.String getFormPrefix()
          推奨されていません。 getPrefix()を使うようにして下さい。
 java.lang.String getFormScope()
          推奨されていません。 getScope()を使うようにして下さい。
 java.lang.String getFormSuffix()
          推奨されていません。 getSuffix()を使うようにして下さい。
 java.lang.String getForward()
          このマッピングのフォワードパスを返します。
 java.lang.String getInclude()
          このマッピングのインクルードパスを返します。
 java.lang.String getInput()
          このマッピングの入力フォームのパスを返します。
 java.lang.String getInputForm()
          推奨されていません。 getInput()を使うようにして下さい。
 ActionMappings getMappings()
          このマッピングインスタンスが含まれているActionMappingsコレクションを返します。
 java.lang.String getMultipartClass()
          マルチパートリクエストを処理するために使用するクラスの名前を取得します。
 java.lang.String getName()
          このマッピングのアクションフォームBeanの名前を返します。
 java.lang.String getParameter()
          このマッピングの汎用的な設定パラメータを返します。
 java.lang.String getPath()
          このマッピングを選択するために利用されるリクエストURIを返します。
 java.lang.String getPrefix()
          このマッピングのプレフィックスを返します。
 java.lang.String getScope()
          このマッピングのスコープを返します。
 java.lang.String getSuffix()
          このマッピングのサフィックスを返します。
 java.lang.String getType()
          完全修飾されたアクションクラス名を返します。
 boolean getUnknown()
          このマッピングのunknownフラグを返します。
 boolean getValidate()
          このマッピングのvalidateフラグを返します。
 void removeForward(ActionForward forward)
          このマッピングに関連付けられているActionForwardを削除します。
 void setActionClass(java.lang.String actionClass)
          推奨されていません。 setType()を使うようにして下さい。
 void setAttribute(java.lang.String attribute)
          アクションフォームBeanのための属性名を設定します。
 void setFormAttribute(java.lang.String formAttribute)
          推奨されていません。 setAttribute()を使うようにして下さい。
 void setFormClass(java.lang.String formClass)
          推奨されていません。 対応するActionFormBeanを変更してください。
 void setFormPrefix(java.lang.String formPrefix)
          推奨されていません。 setPrefix(String)を使うようにして下さい。
 void setFormScope(java.lang.String formScope)
          推奨されていません。 setScope(String)を使うようにして下さい。
 void setFormSuffix(java.lang.String formSuffix)
          推奨されていません。 setSuffix(String)を使うようにして下さい。
 void setForward(java.lang.String forward)
          このマッピングのフォワードパスを設定します。
 void setInclude(java.lang.String include)
          このマッピングのインクルードパスを設定します。
 void setInput(java.lang.String input)
          このマッピングの入力フォームのパスを設定します。
 void setInputForm(java.lang.String inputForm)
          推奨されていません。 setInput(String)を使うようにして下さい。
 void setMappings(ActionMappings mappings)
          このマッピングインスタンスが含まれているActionMappingsコレクションを設定します。
 void setMultipartClass(java.lang.String multipartClass)
          マルチパートリクエストを処理するために使用するクラスの名前を設定します。
 void setName(java.lang.String name)
          このマッピングのアクションフォームBeanの名前を設定します。
 void setParameter(java.lang.String parameter)
          このマッピングの汎用的な設定パラメータを設定します。
 void setPath(java.lang.String path)
          このマッピングを選択するために利用されるリクエストURIを設定します。
 void setPrefix(java.lang.String prefix)
          このマッピングのプレフィックスを設定します。
 void setScope(java.lang.String scope)
          このマッピングのスコープを設定します。
 void setSuffix(java.lang.String suffix)
          このマッピングのサフィックスを設定します。
 void setType(java.lang.String type)
          完全修飾されたアクションクラスの名前を設定します。
 void setUnknown(boolean unknown)
          このマッピングのunknownフラグを設定します。
 void setValidate(boolean validate)
          このマッピングのvalidateフラグを設定します。
 java.lang.String toString()
          このマッピングの文字列表現を返します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

attribute

protected java.lang.String attribute
生成されたアクションフォームBeanが存在する場合に、それが保持されているリクエストまたはセッションの属性名です。


forward

protected java.lang.String forward
RequestDispatcher.forward()によって呼び出され、リクエストを処理するサーブレットやJSPリソースのコンテキスト相対パスです。 このプロパティが設定されている場合、typeプロパティで指定したアクションクラスの生成や呼び出しは実行されません。


forwards

protected ActionForwards forwards
このマッピングに関連付けられているActionForwardオブジェクトの集合です。


include

protected java.lang.String include
RequestDispatcher.include()によって呼び出され、リクエストを処理するサーブレットやJSPリソースのコンテキスト相対パスです。 このプロパティが設定されている場合、typeプロパティで指定したアクションクラスの生成や呼び出しは実行されません。


input

protected java.lang.String input
入力パラメータの検証エラーが発生した場合に制御を戻す入力フォームのコンテキスト相対パスです。


instance

protected Action instance
このマッピングのために初期化されたActionクラスのインスタンスです。


mappings

protected ActionMappings mappings
このマッピングオブジェクトをその一部とするActionMappingsコレクションです。


multipartClass

protected java.lang.String multipartClass
このマッピングへのマルチパートリクエストを処理するために使用される、 MultipartRequestHandler実装クラスの完全修飾名です。


name

protected java.lang.String name
このアクションに関連付けられているアクションフォームBeanの名前です。


parameter

protected java.lang.String parameter
このマッピングのために汎用的に使用できるパラメータです。


path

protected java.lang.String path
このアクションへマップされる、コンテキスト相対リクエストパスです。パスは"/"で始まり、もし拡張子があっても、それは含みません。


prefix

protected java.lang.String prefix
このアクションのためのパラメータを選択するのに使用するパラメータ名のプレフィックスです。


scope

protected java.lang.String scope
このマッピングに関連付けられているアクションフォームBeanを保持しているスコープの識別子です。


suffix

protected java.lang.String suffix
このアクションのためのパラメータを選択するのに使用するパラメータ名のサフィックスです。


type

protected java.lang.String type
このマッピングに向けられたリクエストを処理するのに使用される、Action実装クラスの完全修飾名です。


unknown

protected boolean unknown
このマッピングがアプリケーションのデフォルトに設定される場合はtrueです。


validate

protected boolean validate
アクションフォームBeanのvalidate()メソッドが呼ばれる場合はtrueです。

コンストラクタの詳細

ActionMapping

public ActionMapping()
メソッドの詳細

getActionClass

public java.lang.String getActionClass()
推奨されていません。 getType()を使うようにして下さい。

このマッピングで使用されるアクションクラスの名前を返します。


setActionClass

public void setActionClass(java.lang.String actionClass)
推奨されていません。 setType()を使うようにして下さい。

このマッピングで使用するアクションクラスの名前を設定します。

パラメータ:
actionClass - 新しいアクションクラスの名前

getAttribute

public java.lang.String getAttribute()
アクションフォームBeanのための属性名を返します。


setAttribute

public void setAttribute(java.lang.String attribute)
アクションフォームBeanのための属性名を設定します。

パラメータ:
attribute - 新しい属性名

getFormAttribute

public java.lang.String getFormAttribute()
推奨されていません。 getAttribute()を使うようにして下さい。

このマッピングで使用するフォームのセッション属性のキーがある場合、それを返します。


setFormAttribute

public void setFormAttribute(java.lang.String formAttribute)
推奨されていません。 setAttribute()を使うようにして下さい。

このマッピングで使用するフォームのセッション属性のキーを設定します。

パラメータ:
formAttribute - フォームの新しいセッション属性キー

getFormClass

public java.lang.String getFormClass()
推奨されていません。 Beanの名前を用いて対応するアクションフォームBeanを取得するようにして下さい。

このマッピングで使用するアクションフォームBeanのクラス名を返します。


setFormClass

public void setFormClass(java.lang.String formClass)
推奨されていません。 対応するActionFormBeanを変更してください。

このマッピングで使用するアクションフォームBeanのクラス名を設定します。

パラメータ:
formClass - 新しいアクションフォームBeanの名前

getFormPrefix

public java.lang.String getFormPrefix()
推奨されていません。 getPrefix()を使うようにして下さい。

このマッピングのためのパラメータ名のプレフィックスを返します。


setFormPrefix

public void setFormPrefix(java.lang.String formPrefix)
推奨されていません。 setPrefix(String)を使うようにして下さい。

このマッピングのためのパラメータ名のプレフィックスを設定します。

パラメータ:
formPrefix - 新しいフォームプレフィックス

getFormScope

public java.lang.String getFormScope()
推奨されていません。 getScope()を使うようにして下さい。

アクセスされるアクションフォームBeanを保持するスコープを返します。


setFormScope

public void setFormScope(java.lang.String formScope)
推奨されていません。 setScope(String)を使うようにして下さい。

アクセスされるアクションフォームBeanを保持するスコープを設定します。

パラメータ:
formScope - 新しいスコープ("request" または "session")

getFormSuffix

public java.lang.String getFormSuffix()
推奨されていません。 getSuffix()を使うようにして下さい。

このマッピングのためのパラメータ名のサフィックスを返します。


setFormSuffix

public void setFormSuffix(java.lang.String formSuffix)
推奨されていません。 setSuffix(String)を使うようにして下さい。

このマッピングのためのパラメータ名のサレフィックスを設定します。

パラメータ:
formSuffix - 新しいフォームサフィックス

getForward

public java.lang.String getForward()
このマッピングのフォワードパスを返します。


setForward

public void setForward(java.lang.String forward)
このマッピングのフォワードパスを設定します。

パラメータ:
forward - このマッピングのフォワードパス

getInclude

public java.lang.String getInclude()
このマッピングのインクルードパスを返します。


setInclude

public void setInclude(java.lang.String include)
このマッピングのインクルードパスを設定します。

パラメータ:
include - このマッピングのインクルードパス

getInput

public java.lang.String getInput()
このマッピングの入力フォームのパスを返します。


setInput

public void setInput(java.lang.String input)
このマッピングの入力フォームのパスを設定します。

パラメータ:
input - 新しい入力フォームのパスです。

getInputForm

public java.lang.String getInputForm()
推奨されていません。 getInput()を使うようにして下さい。

このマッピングの入力フォームのURIを返します。


setInputForm

public void setInputForm(java.lang.String inputForm)
推奨されていません。 setInput(String)を使うようにして下さい。

このマッピングの入力フォームのURIを設定します。

パラメータ:
inputForm - 新しい入力フォームのURI

getMappings

public ActionMappings getMappings()
このマッピングインスタンスが含まれているActionMappingsコレクションを返します。


getMultipartClass

public java.lang.String getMultipartClass()
マルチパートリクエストを処理するために使用するクラスの名前を取得します。

戻り値:
使用するMultipartRequestHandler実装クラスの完全修飾名

setMappings

public void setMappings(ActionMappings mappings)
このマッピングインスタンスが含まれているActionMappingsコレクションを設定します。

パラメータ:
mappings - 新しいActionMappingsコレクション

setMultipartClass

public void setMultipartClass(java.lang.String multipartClass)
マルチパートリクエストを処理するために使用するクラスの名前を設定します。

パラメータ:
multipartClass - 使用するMultipartRequestHandler実装クラスの完全修飾名。nullの場合、web.xmlで指定されているグローバルクラスが使用されます。

getName

public java.lang.String getName()
このマッピングのアクションフォームBeanの名前を返します。


setName

public void setName(java.lang.String name)
このマッピングのアクションフォームBeanの名前を設定します。

パラメータ:
name - 新しいフォームBeanの名前

getParameter

public java.lang.String getParameter()
このマッピングの汎用的な設定パラメータを返します。


setParameter

public void setParameter(java.lang.String parameter)
このマッピングの汎用的な設定パラメータを設定します。

パラメータ:
parameter - 新しい設定パラメータ

getPath

public java.lang.String getPath()
このマッピングを選択するために利用されるリクエストURIを返します。


setPath

public void setPath(java.lang.String path)
このマッピングを選択するために利用されるリクエストURIを設定します。

パラメータ:
path - 新しいリクエストURI

getPrefix

public java.lang.String getPrefix()
このマッピングのプレフィックスを返します。


setPrefix

public void setPrefix(java.lang.String prefix)
このマッピングのプレフィックスを設定します。

パラメータ:
prefix - 新しいプレフィックス

getScope

public java.lang.String getScope()
このマッピングのスコープを返します。


setScope

public void setScope(java.lang.String scope)
このマッピングのスコープを設定します。

パラメータ:
scope - 新しいスコープ

getSuffix

public java.lang.String getSuffix()
このマッピングのサフィックスを返します。


setSuffix

public void setSuffix(java.lang.String suffix)
このマッピングのサフィックスを設定します。

パラメータ:
suffix - 新しいサフィックス

getType

public java.lang.String getType()
完全修飾されたアクションクラス名を返します。


setType

public void setType(java.lang.String type)
完全修飾されたアクションクラスの名前を設定します。

パラメータ:
type - 新しいクラス名

getUnknown

public boolean getUnknown()
このマッピングのunknownフラグを返します。


setUnknown

public void setUnknown(boolean unknown)
このマッピングのunknownフラグを設定します。

パラメータ:
unknown - 新しいunknownフラグ

getValidate

public boolean getValidate()
このマッピングのvalidateフラグを返します。


setValidate

public void setValidate(boolean validate)
このマッピングのvalidateフラグを設定します。

パラメータ:
validate - 新しいvalidateフラグ

addForward

public void addForward(ActionForward forward)
このマッピングに関連付けられる新しいActionForwardを追加します。

パラメータ:
forward - 追加するアクションフォワード

createFormInstance

public ActionForm createFormInstance()
推奨されていません。 アクションフォームインスタンスの生成はコントローラServletによって行われます。

初期化されたフォームクラスのインスタンスを生成し、返します。 もし何らかの理由でインスタンス化に失敗した場合、nullを返します。


findForward

public ActionForward findForward(java.lang.String name)
指定された名前のActionForwardがあれば、それを返します。なければnullを返します。 もし、指定された名前のローカルフォワーディングは定義されていないが、このマッピングに関連付けられているグローバルフォワードのコレクションが存在する場合、 そのグローバルコレクションも、検索されます。

パラメータ:
name - 返されるフォワードの名前

findForwards

public java.lang.String[] findForwards()
このマッピングに定義された全てのローカルフォワードの論理名を返します。 もしフォワードが1つもない場合は長さ0の配列を返します。


removeForward

public void removeForward(ActionForward forward)
このマッピングに関連付けられているActionForwardを削除します。

パラメータ:
forward - 削除するActionForward

toString

public java.lang.String toString()
このマッピングの文字列表現を返します。



このドキュメントは、Ja-Jakartaにより訳されました。コメントがある場合は、report@jajakarta.orgまでお願いします。
Copyright (C) 2000-2002 - Apache Software Foundation