com.hof.parameters

Class ParameterPanel

java.lang.Object

com.hof.parameters.ParameterPanel

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ETLStepConfigPanel

public abstract class ParameterPanel
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,?>>	data Data map for this level, will most likely just contain maps of section data
protected java.lang.String	dynamicKey

Constructor Summary

Constructors

Constructor and Description
ParameterPanel()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,?>	getData()
abstract java.lang.String	getDescription() Description of the panel
abstract java.util.List<ParameterDisplayRule>	getDisplayRules() Display rules for the panel, should be used when you want to show/hide a panel based on values entered by the user within this panel
java.lang.String	getDynamicKey()
abstract GeneralPanelOptions	getGeneralOptions() General options that are used by multiple levels in the Parameter hierarchy
abstract java.lang.String	getName() Display name of the panel
abstract java.lang.String	getPanelKey() Defines the panel key, should be used to define the location of the Panel, shouldbe unique within a ParameterPanelCollection
java.lang.String	getParameterPanelClassName() Return a style class for a ParameterPanel
java.util.List<Parameter>	getParameters(java.lang.String type) Return all params of a specific type from all sections in this Panel. Use this method only if all Parameters in this panel have unique Property names. Parameters having the same key across sections will yield only one result.
abstract java.util.List<ParameterSection>	getSections() Sections within the panel
void	setDynamicKey(java.lang.String dynamicKey)
void	setSortOrder(int sortOrder)
org.json.JSONObject	toJSON() toJSON method, should only add things that will be relevant to the panel, will also update the sub panels locations automaticaly

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

dynamicKey

protected java.lang.String dynamicKey

data

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,?>> data

Data map for this level, will most likely just contain maps of section data

Constructor Detail

ParameterPanel

public ParameterPanel()

Method Detail

getDynamicKey

public java.lang.String getDynamicKey()

setDynamicKey

public void setDynamicKey(java.lang.String dynamicKey)

getPanelKey

public abstract java.lang.String getPanelKey()

Defines the panel key, should be used to define the location of the Panel, shouldbe unique within a ParameterPanelCollection

getName

public abstract java.lang.String getName()

Display name of the panel

getParameterPanelClassName

public java.lang.String getParameterPanelClassName()

Return a style class for a ParameterPanel

getDescription

public abstract java.lang.String getDescription()

Description of the panel

getSections

public abstract java.util.List<ParameterSection> getSections()

Sections within the panel

getDisplayRules

public abstract java.util.List<ParameterDisplayRule> getDisplayRules()

Display rules for the panel, should be used when you want to show/hide a panel based on values entered by the user within this panel

getGeneralOptions

public abstract GeneralPanelOptions getGeneralOptions()

General options that are used by multiple levels in the Parameter hierarchy

getData

public java.util.Map<java.lang.String,?> getData()

setSortOrder

public void setSortOrder(int sortOrder)

toJSON

public org.json.JSONObject toJSON()

toJSON method, should only add things that will be relevant to the panel, will also update the sub panels locations automaticaly

getParameters

public java.util.List<Parameter> getParameters(java.lang.String type)

Return all params of a specific type from all sections in this Panel.
Use this method only if all Parameters in this panel have unique Property names.
Parameters having the same key across sections will yield only one result.

Parameters:

type - - Type of parameter to search for. If this is null, the method returns all params. Otherwise this should be a Special Input Type or the string representation of an InputType