SearchExpressionHandlerWrapper (Jakarta EE Platform API)

java.lang.ObjectSE
- jakarta.faces.component.search.SearchExpressionHandler
- - jakarta.faces.component.search.SearchExpressionHandlerWrapper

実装されたすべてのインターフェース:
FacesWrapper<SearchExpressionHandler>
```
public abstract class SearchExpressionHandlerWrapper
extends SearchExpressionHandler
implements FacesWrapper<SearchExpressionHandler>
```
既存の SearchExpressionHandler インスタンスに特別な動作を提供したい開発者がサブクラス化できる SearchExpressionHandler の簡単な実装を提供します。すべてのメソッドのデフォルトの実装は、ラップされた SearchExpressionHandler インスタンスを呼び出すことです。使用箇所: このクラスを継承し、ラップされている実装をコンストラクターにプッシュし、getWrapped() を使用してラップされているインスタンスにアクセスします。
導入:
2.3

フィールドのサマリー
- クラス jakarta.faces.component.search.SearchExpressionHandler から継承されたフィールド
  EXPRESSION_SEPARATOR_CHARS, KEYWORD_PREFIX

コンストラクターの概要

コンストラクター
コンストラクターと説明
`SearchExpressionHandlerWrapper(SearchExpressionHandler wrapped)` この検索式ハンドラーが装飾されている場合、装飾を行う実装は、ラップされる実装をこのコンストラクターにプッシュする必要があります。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`char[]`	`getExpressionSeperatorChars(FacesContext context)` 一連の式で式を区切るために使用される文字を返します。
`SearchExpressionHandler`	`getWrapped()` このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。
`void`	`invokeOnComponent(SearchExpressionContext searchExpressionContext, StringSE expression, ContextCallback callback)` 指定された式の複数の `UIComponent` を解決します。
`void`	`invokeOnComponent(SearchExpressionContext searchExpressionContext, UIComponent previous, StringSE expression, ContextCallback callback)` 指定された式の複数の `UIComponent` を解決します。
`boolean`	`isPassthroughExpression(SearchExpressionContext searchExpressionContext, StringSE expression)` 指定された式が「パススルー式」かどうかを確認します。
`boolean`	`isValidExpression(SearchExpressionContext searchExpressionContext, StringSE expression)` 指定された式が有効な式であるかどうかを確認します。
`StringSE`	`resolveClientId(SearchExpressionContext searchExpressionContext, StringSE expression)` 指定された式に対して単一の clientId またはパススルー式に解決されます。
`ListSE<StringSE>`	`resolveClientIds(SearchExpressionContext searchExpressionContext, StringSE expressions)` 指定された式に対して、clientIds またはパススルー式を使用して `List`SE に解決します。
`void`	`resolveComponent(SearchExpressionContext searchExpressionContext, StringSE expression, ContextCallback callback)` 指定された式の単一の `UIComponent` を解決します。
`void`	`resolveComponents(SearchExpressionContext searchExpressionContext, StringSE expressions, ContextCallback callback)` 指定された式の複数の `UIComponent` を解決します。
`StringSE[]`	`splitExpressions(FacesContext context, StringSE expressions)` 可能性のある複数の式を持つ `SearchExpressionHandler.getExpressionSeperatorChars(jakarta.faces.context.FacesContext)` に基づいて、文字列を配列に分割します。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - SearchExpressionHandlerWrapper
```
public SearchExpressionHandlerWrapper(SearchExpressionHandler wrapped)
```
    この検索式ハンドラーが装飾されている場合、装飾を行う実装は、ラップされる実装をこのコンストラクターにプッシュする必要があります。getWrapped() は、ラップされている実装を返します。
    パラメーター:
    wrapped - ラップされる実装。
    導入:
    2.3
- メソッドの詳細
  - getWrapped
```
public SearchExpressionHandler getWrapped()
```
    インターフェースからコピーされた説明: FacesWrapper
    このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。
    次で指定:
    インターフェース FacesWrapper<SearchExpressionHandler> の getWrapped
    戻り値:
    ラップされたインスタンス。
  - resolveClientId
```
public StringSE resolveClientId(SearchExpressionContext searchExpressionContext,
                              StringSE expression)
```
    クラスからコピーされた説明: SearchExpressionHandler
    指定された式に対して単一の clientId またはパススルー式に解決されます。
    次で指定:
    クラス SearchExpressionHandler の resolveClientId
    パラメーター:
    searchExpressionContext - SearchExpressionContext
    expression - 検索式
    戻り値:
    解決された clientId またはパススルー式。式を解決できず、SearchExpressionHint.IGNORE_NO_RESULT が渡された場合は、null が返されます。
  - resolveClientIds
```
public ListSE<StringSE> resolveClientIds(SearchExpressionContext searchExpressionContext,
                                     StringSE expressions)
```
    クラスからコピーされた説明: SearchExpressionHandler
    指定された式に対して、clientIds またはパススルー式を使用して ListSE に解決します。式は SearchExpressionHandler.splitExpressions(jakarta.faces.context.FacesContext, java.lang.String) によって分割され、1 つずつ解決されます。
    次で指定:
    クラス SearchExpressionHandler の resolveClientIds
    パラメーター:
    searchExpressionContext - SearchExpressionContext
    expressions - 検索式
    戻り値:
    解決された clientIds およびパススルー式。
  - resolveComponent
```
public void resolveComponent(SearchExpressionContext searchExpressionContext,
                             StringSE expression,
                             ContextCallback callback)
```
    クラスからコピーされた説明: SearchExpressionHandler
    指定された式の単一の UIComponent を解決します。コンポーネントが解決されると、ContextCallback が呼び出されます。
    次で指定:
    クラス SearchExpressionHandler の resolveComponent
    パラメーター:
    searchExpressionContext - SearchExpressionContext
    expression - 検索式
    callback - 解決されたコンポーネントのコールバック
  - resolveComponents
```
public void resolveComponents(SearchExpressionContext searchExpressionContext,
                              StringSE expressions,
                              ContextCallback callback)
```
    クラスからコピーされた説明: SearchExpressionHandler
    指定された式の複数の UIComponent を解決します。式は SearchExpressionHandler.splitExpressions(jakarta.faces.context.FacesContext, java.lang.String) によって分割され、1 つずつ解決されます。解決されたコンポーネントごとに、ContextCallback が呼び出されます。
    次で指定:
    クラス SearchExpressionHandler の resolveComponents
    パラメーター:
    searchExpressionContext - SearchExpressionContext
    expressions - 検索式
    callback - 解決された各コンポーネントのコールバック
  - invokeOnComponent
```
public void invokeOnComponent(SearchExpressionContext searchExpressionContext,
                              StringSE expression,
                              ContextCallback callback)
```
    クラスからコピーされた説明: SearchExpressionHandler
    指定された式の複数の UIComponent を解決します。解決されたコンポーネントごとに、ContextCallback が呼び出されます。このメソッドは、API で最も重要なメソッドです。キーワードと ID の再帰を処理するアルゴリズムを実装します。
    オーバーライド:
    クラス SearchExpressionHandler の invokeOnComponent
    パラメーター:
    searchExpressionContext - SearchExpressionContext
    expression - 検索式
    callback - 解決されたコンポーネントのコールバック
  - invokeOnComponent
```
public void invokeOnComponent(SearchExpressionContext searchExpressionContext,
                              UIComponent previous,
                              StringSE expression,
                              ContextCallback callback)
```
    クラスからコピーされた説明: SearchExpressionHandler
    指定された式の複数の UIComponent を解決します。解決されたコンポーネントごとに、ContextCallback が呼び出されます。このメソッドは、API で最も重要なメソッドです。キーワードと ID の再帰を処理するアルゴリズムを実装します。
    次で指定:
    クラス SearchExpressionHandler の invokeOnComponent
    パラメーター:
    searchExpressionContext - SearchExpressionContext
    previous - 検索のベースとなる、以前に解決されたコンポーネント
    expression - 検索式
    callback - 解決されたコンポーネントのコールバック
  - isValidExpression
```
public boolean isValidExpression(SearchExpressionContext searchExpressionContext,
                                 StringSE expression)
```
    クラスからコピーされた説明: SearchExpressionHandler
    指定された式が有効な式であるかどうかを確認します。
    次の場合、式は無効です。
    リクエストされたキーワードに一致する SearchKeywordResolver はありません
    キーワードまたは ID がリーフキーワードの後に配置されている (@none:@form)
    次で指定:
    クラス SearchExpressionHandler の isValidExpression
    パラメーター:
    searchExpressionContext - SearchExpressionContext
    expression - 表現
    戻り値:
    指定された式が有効な式である場合
  - isPassthroughExpression
```
public boolean isPassthroughExpression(SearchExpressionContext searchExpressionContext,
                                       StringSE expression)
```
    クラスからコピーされた説明: SearchExpressionHandler
    指定された式が「パススルー式」かどうかを確認します。パススルー式はキーワードのみでなければなりません。このキーワードは SearchKeywordResolver によって解決されず、そのままの状態で返されます。クライアントは後で解決する責任があります。
    次で指定:
    クラス SearchExpressionHandler の isPassthroughExpression
    パラメーター:
    searchExpressionContext - SearchExpressionContext
    expression - 表現
    戻り値:
    指定された式がパススルー式である場合
  - splitExpressions
```
public StringSE[] splitExpressions(FacesContext context,
                                 StringSE expressions)
```
    クラスからコピーされた説明: SearchExpressionHandler
    可能性のある複数の式を持つ SearchExpressionHandler.getExpressionSeperatorChars(jakarta.faces.context.FacesContext) に基づいて、文字列を配列に分割します。
    次で指定:
    クラス SearchExpressionHandler の splitExpressions
    パラメーター:
    context - 現在のリクエストの FacesContext
    expressions - 文字列としての式
    戻り値:
    配列としての式
  - getExpressionSeperatorChars
```
public char[] getExpressionSeperatorChars(FacesContext context)
```
    クラスからコピーされた説明: SearchExpressionHandler
    一連の式で式を区切るために使用される文字を返します。デフォルトの実装は SearchExpressionHandler.EXPRESSION_SEPARATOR_CHARS を返します。
    オーバーライド:
    クラス SearchExpressionHandler の getExpressionSeperatorChars
    パラメーター:
    context - 現在のリクエストの FacesContext
    戻り値:
    区切り文字

クラス SearchExpressionHandlerWrapper

フィールドのサマリー

クラス jakarta.faces.component.search.SearchExpressionHandler から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

SearchExpressionHandlerWrapper

メソッドの詳細

getWrapped

resolveClientId

resolveClientIds

resolveComponent

resolveComponents

invokeOnComponent

invokeOnComponent

isValidExpression

isPassthroughExpression

splitExpressions

getExpressionSeperatorChars