こちらは四番目の最下層であり、パラメーターインターフェイスにより記述されます。ユーザーインプットウィジェットは、実装classにより表示されます。Yellowfinには数多くの実装があり、その大部分はParameterlmpl classをインスタンス化し、正しいインプットタイプを設定することで使用できます。Yellowfinはこの情報を、そのビューエンジンを使用するhtmlを生成するために使用します。
Parameterlmplの重要なメソッドを、以下に示します。
| メソッド | 説明 |
| public void setInputType(InputType type) | enum InputType内で定義された型にパラメーター型を設定するために使用します。例えば、InputType.SELECTは、ドロップダウンを表示します。 |
| public void setName(String name) | パラメーターの名前が、インプット要素の左側にラベルとして表示されます。 |
| public void setDescription(String desc) | 説明がラベルの下に表示されます。 |
| public void setProperty(String property) | ユーザーインプットは、JSONオブジェクトのこのプロパティ内に設定され、送信時にサーバへ返されます。 |
public void setMinAllowed(int min) public void setMaxAllowed(int max) | インプットが最小値や最大値の範囲外にある場合にエラーメッセージを表示します。これは数値入力値に適用されます。 |
public void addViewOption(String property, Object value) public void setViewOptions(Map<String, Object> viewOptions) | 表示されたインプットウィジェットは、これらのメソッドを使用してオプションを設定することで、カスタマイズすることができます。利用可能なビューとそのオプションを、インプットタイプに項目に示します。 |
public void addDisplayRule(ParameterDisplayRule rule) public void setDisplayRules(List<ParameterDisplayRule> displayRules) | 表示ルールは、ユーザーインプットに基づき、パネルを表示すべきかどうかを判断します。詳細は、ヘルパーオブジェクトの項目で紹介します。 |
public void addPossibleValue(String val, String desc) public void addPossibleValue(String val, String desc, String colour) public void setPossibleValues(List<CustomValue<?>> possibleValues) | これらのメソッドは、インプットタイプにドロップダウンリストのような利用な可能なオプション値を設定するために使用されます。addPossibleValueもまた、整数値を受け付けるためにオーバーロードされます。値、説明、色は、CustomValueオブジェクトを構築するために使用され、その後、オプションを表示するために使用されます。Stringは値フィールドであり、データベースに選択されたオプションとして保存されます。説明は、表示目的のみです。 |
| public void setParameterClassName(String className) | パラメーターに適用されるCSS classを設定します。 |
| public void setCssRules(Set<CssRule> cssRules) | パラメータースタイリングのより細かい制御に使用できるCSSルールを定義します。詳細は、ヘルパーオブジェクト項目で紹介します。 |
public void addParameterValueDisplay(String key, ParameterValueDisplay pvd) | ParameterValueDisplayオブジェクトは、特定の入力値に対して、パラメーターがどのように表示されるのか定義するために使用することができます。入力値は、「キー」メソッドパラメーター内で指定されます。例えば、トグルスイッチの場合、現在の選択が「false」の場合、スイッチのイメージや色を変更するために使用することができます。ParameterValueDisplayの詳細は、ヘルパーオブジェクト項目で紹介します。 |
public void setList(boolean) public void setListOptions(ListOptions listOptions) | setListは、指定された型のパラメーターの一覧を生成するかどうかを判断するために使用されます。例えば、TEXTBOX型をtrueに設定した場合、「追加」ボタンを使用して無期限に蓄積できるテキストボックスの一覧を生成します。一覧を表示するオプションは、ListOptionsオブジェクトを使用して定義されます。詳細は、ヘルパーオブジェクト項目で紹介します。 |
public void setValidationRules(ParameterValidation rules) public void setObjectValidationRules(Map<String, ParameterValidation> rules) | これらのメソッドは、フロントエンド検証ルールを設定するために使用されます。例えばこれは、インプットフィールドが空でないことを確認するために使用することができます。オブシェクト検証メソッドは、JSONオブジェクトを検証するために使用されます。例えば、フィールドに一致するパラメーターは、2つのフィールド間のマッピングをJSONオブジェクトとして保持することができます。 {"from": "field1", "to": "field2" }
|
public void setValueDependencies(List<ValueDependent> deps) public void addValueDependency(String prop, PropertyLocation loc) public void addValueDependency(ValueDependent dep) | |
public void setEvent(String event) public void setEventParameters(List<ValueDependent> eventParameters) public void addEventParameter(ValueDependent parameter) public void addEventParameter(String prop, PropertyLocation loc) public void setEventData(Map<String, Object> eventData) public void addEventData(String key, Object value) |
|
public String getDynamicKey() public void setDynamicKey(String dynamicKey) |