com.hof.parameters

Class ParameterSection

java.lang.Object

com.hof.parameters.ParameterSection

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ETLStepConfigSection

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

This interface should be used to define user sections for UserInputParameters that will allow us to setup sections of an interface on the backend that will be passed to a javascript generator that will convert into a usable interface

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,?>	data
protected java.lang.String	dynamicKey
protected ParameterValueLoader	parameterValueLoader ParameterValueLoader that can be used to

Constructor Summary

Constructors

Constructor and Description
ParameterSection()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.Object	convertParameterToJSON(java.lang.String original) Helper method to converts JSON to it's equivilent java object (for lists, maps and booleans) so that the javascript interepting it isn't just sent a string like "[1,2,3]"
abstract java.util.Map<java.lang.String,?>	getData() Data object for the level, should contain data relevant for the Parameters
abstract java.util.List<ParameterDisplayRule>	getDisplayRules() Displays to determine whether or not the Section should be visible
java.lang.String	getDynamicKey()
abstract java.lang.String	getName() Display name of the object
abstract java.util.List<Parameter>	getParameters() List of the options that will be displayed on the interface
java.util.List<Parameter>	getParameters(java.lang.String type) Return all params of a specific type in this Section.
java.lang.String	getParameterSectionClassName() Return a styleclass for a Parameter Section
abstract java.lang.String	getSectionKey() Returns the key for the model, should be unique within a ParameterPanel Is used to access the data object on the interface
abstract GeneralPanelOptions	getSectionOptions() General options that are used by multiple levels in the Parameter hierarchy
boolean	isDynamic()
void	setDynamicKey(java.lang.String dynamicKey)
void	setPanelLocation(java.lang.String panelKey) Method to set the parents location, is called automatically during toJSON so that the section should have a parent parameter
void	setParameterValueLoader(ParameterValueLoader pvl)
void	setSortOrder(int sortOrder) Update the sort order so that we can ensure that the interface will be in the correct order Not Used for JS interface
org.json.JSONObject	toJSON()

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,?> data

parameterValueLoader

protected ParameterValueLoader parameterValueLoader

ParameterValueLoader that can be used to

Constructor Detail

ParameterSection

public ParameterSection()

Method Detail

getDynamicKey

public java.lang.String getDynamicKey()

setDynamicKey

public void setDynamicKey(java.lang.String dynamicKey)

getSectionKey

public abstract java.lang.String getSectionKey()

Returns the key for the model, should be unique within a ParameterPanel Is used to access the data object on the interface

getName

public abstract java.lang.String getName()

Display name of the object

getParameterSectionClassName

public java.lang.String getParameterSectionClassName()

Return a styleclass for a Parameter Section

getParameters

public abstract java.util.List<Parameter> getParameters()

List of the options that will be displayed on the interface

getDisplayRules

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

Displays to determine whether or not the Section should be visible

getSectionOptions

public abstract GeneralPanelOptions getSectionOptions()

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

getData

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

Data object for the level, should contain data relevant for the Parameters

setPanelLocation

public void setPanelLocation(java.lang.String panelKey)

Method to set the parents location, is called automatically during toJSON so that the section should have a parent parameter

Parameters:

panelKey -

setSortOrder

public void setSortOrder(int sortOrder)

Update the sort order so that we can ensure that the interface will be in the correct order Not Used for JS interface

Parameters:

sortOrder -

setParameterValueLoader

public void setParameterValueLoader(ParameterValueLoader pvl)

isDynamic

public boolean isDynamic()

toJSON

public org.json.JSONObject toJSON()

convertParameterToJSON

protected java.lang.Object convertParameterToJSON(java.lang.String original)

Helper method to converts JSON to it's equivilent java object (for lists, maps and booleans) so that the javascript interepting it isn't just sent a string like "[1,2,3]"

Parameters:

original -

getParameters

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

Return all params of a specific type in this Section.

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