Response インターフェイス

public abstract interface Response

CustomTag タグから生成された応答へのインターフェイスです。このインターフェイスには、出力を記述し、クエリを生成し、呼び出し側ページに変数を設定するためのメソッドが含まれています。

メソッド

戻り値
構文
説明
Query
 
addQuery(String name, String[] columns) 
 
呼び出し側のテンプレートにクエリを追加します。
void
 
setVariable(String name, String value) 
 
呼び出し側テンプレートに変数を設定します。
void
 
write(String output) 
 
ユーザに返すテキストを出力します。
void
 
writeDebug(String output) 
 
デバッグ ストリームにテキスト出力を書き込みます。

addQuery

説明

呼び出し側のテンプレートにクエリを追加します。さらに、テンプレート内の CFML タグも、このクエリを利用することができます。addQuery を呼び出した後は、クエリが空 (1 行もなし) になります。クエリをデータで満たすには、Query のメンバ関数 addRow および setData を呼び出します。

テンプレートに追加されたクエリを返します。

カテゴリ

Response インターフェイス

構文

public Query addQuery(String name, String[] columns)
 

戻り値

IllegalArgumentException − 名前パラメータが無効な CFML 変数名である場合に返されます。

参照

addRow, setData

パラメータ

パラメータ
説明
name
テンプレートに追加するクエリの名前
columns
クエリの列の名前

次の例では、呼び出しテンプレートに People という名前のクエリが追加されます。クエリは、2 列 (FirstName と LastName) と 2 行から構成されています。

// 列名で文字列配列を作成します (列インデックスも確認します)。
String[] columns = { "FirstName", "LastName" } ;
int iFirstName = 1, iLastName = 2 ;

// これらの列を含むクエリを作成します。
Query query = response.addQuery( "People", columns ) ;

// データをクエリに追加します。
int iRow = query.addRow() ;
query.setData( iRow, iFirstName, "John" ) ;
query.setData( iRow, iLastName, "Smith" ) ;
iRow = query.addRow() ;
query.setData( iRow, iFirstName, "Jane" ) ;
query.setData( iRow, iLastName, "Doe" ) ; 

setVariable

説明

呼び出し側テンプレートに変数を設定します。テンプレートに、指定した変数名がすでに存在していると、その値は変更されます。指定した変数名がない場合は、新しい変数が作成されます。

カテゴリ

Response インターフェイス

構文

public void setVariable(String name, String value)
 

戻り値

IllegalArgumentException name パラメータが無効な CFML 変数名の場合に返されます。

パラメータ

パラメータ
説明
name
設定する変数の名前
value
変数に設定する値

次の例では、カスタム タグによって実行された操作の結果に基づいて、MessageSent という名前の変数値が設定されます。

boolean bMessageSent ;
  ...attempt to send the message...

  if ( bMessageSent == true )
  {
    response.setVariable( "MessageSent", "Yes" ) ;
  }
  else
  {
    response.setVariable( "MessageSent", "No" ) ;
  }

write

説明

ユーザに返すテキストを出力します。

カテゴリ

Response インターフェイス

構文

public void write(String output)
 

パラメータ

パラメータ
説明
output
出力するテキスト

次の例は、DESTINATION 属性の値を出力します。

response.write( "DESTINATION = " + 
  request.getAttribute("DESTINATION") ) ;

writeDebug

説明

デバッグ ストリームにテキスト出力を書き込みます。このテキストは、タグに DEBUG 属性が含まれている場合のみエンドユーザに表示されます。Request.debug メンバ関数を使うと、この属性が含まれているかどうかをチェックすることができます。

カテゴリ

Response インターフェイス

構文

public void writeDebug(String output)
 

参照

debug

パラメータ

パラメータ
説明
output
出力するテキスト

次の例では、DEBUG 属性があるかどうかをチェックし、存在する場合は簡単なデバッグ メッセージが出力されます。

if ( request.debug() )
{
  response.writeDebug( "debug info" ) ;
}