com.hof.parameters

Class DynamicParameterOptions

java.lang.Object

com.hof.parameters.DynamicParameterOptions

All Implemented Interfaces:

java.io.Serializable

public class DynamicParameterOptions
extends java.lang.Object
implements java.io.Serializable

Used by ParameterValueLoader to store any dynamic panels, sections, parameters or values that will be passed to the front-end after an event is triggered by a ParameterPanelCollection's events.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DynamicParameterOptions()

Method Summary

Methods

Modifier and Type	Method and Description
void	addKeyToRemove(java.lang.String dynamicKey) When passed to the front end any keys that have been added will be removed.
void	addPanel(java.lang.String dynamicKey, ParameterPanel panel) Adds a panel to the response object, any panels that are added here will be added to the client-side panels collection
void	addParameter(java.lang.String dynamicKey, java.lang.String panelKey, java.lang.String sectionKey, Parameter parameter) Adds a parameter to the panel/section defined
void	addSection(java.lang.String dynamicKey, java.lang.String panelKey, ParameterSection section) Any section added here will be added to the client-side panel collection, provided it can find the panelKey matches a panel in that collection.
void	addValue(java.lang.String property, com.hof.mi.models.report.CustomValue<?> value) Add an individual value to the values map
java.util.Set<java.lang.String>	getDynamicKeys()
java.util.Set<java.lang.String>	getDynamicKeysToRemove()
java.util.List<ParameterPanel>	getPanels()
java.util.Map<java.lang.String,com.hof.parameters.DynamicParameterOptions.SectionContainer>	getParameters()
java.util.Map<java.lang.String,java.util.List<ParameterSection>>	getSections()
java.util.Map<java.lang.String,java.util.List<com.hof.mi.models.report.CustomValue<?>>>	getValues()
void	setDynamicKeys(java.util.Set<java.lang.String> dynamicKeys)
void	setDynamicKeysToRemove(java.util.Set<java.lang.String> dynamicKeysToRemove)
void	setPanels(java.util.List<ParameterPanel> panels)
void	setParameters(java.util.Map<java.lang.String,com.hof.parameters.DynamicParameterOptions.SectionContainer> parameters)
void	setSections(java.util.Map<java.lang.String,java.util.List<ParameterSection>> sections)
void	setValues(java.util.Map<java.lang.String,java.util.List<com.hof.mi.models.report.CustomValue<?>>> values) Overwrites the values object.
org.json.JSONObject	toJSON()

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicParameterOptions

public DynamicParameterOptions()

Method Detail

addPanel

public void addPanel(java.lang.String dynamicKey,
            ParameterPanel panel)

Adds a panel to the response object, any panels that are added here will be added to the client-side panels collection

Parameters:

dynamicKey - - Used to let the front-end know which "dynamicKeys" are changing so that existing panels/sections/parameters using that type can be removed before adding

panel -

addSection

public void addSection(java.lang.String dynamicKey,
              java.lang.String panelKey,
              ParameterSection section)

Any section added here will be added to the client-side panel collection, provided it can find the panelKey matches a panel in that collection. If the panelKey doesn't match it will be removed

Parameters:

dynamicKey - - Used to let the front-end know which "dynamicKeys" are changing so that existing panels/sections/parameters using that type can be removed before adding

panelKey - - Determines which panel to put this section into

section -

addValue

public void addValue(java.lang.String property,
            com.hof.mi.models.report.CustomValue<?> value)

Add an individual value to the values map

Parameters:

property - - The property that this value can be selected for

value - - The value

setValues

public void setValues(java.util.Map<java.lang.String,java.util.List<com.hof.mi.models.report.CustomValue<?>>> values)

Overwrites the values object.

Parameters:

values -

addParameter

public void addParameter(java.lang.String dynamicKey,
                java.lang.String panelKey,
                java.lang.String sectionKey,
                Parameter parameter)

Adds a parameter to the panel/section defined

Parameters:

dynamicKey - - Used to let the front-end know which "dynamicKeys" are changing so that existing panels/sections/parameters using that type can be removed before adding

panelKey - - Determines which panel that contains the section we are adding this parameter to

sectionKey - - Determines which section this parameter will be added to

parameter -

toJSON

public org.json.JSONObject toJSON()

getDynamicKeysToRemove

public java.util.Set<java.lang.String> getDynamicKeysToRemove()

addKeyToRemove

public void addKeyToRemove(java.lang.String dynamicKey)

When passed to the front end any keys that have been added will be removed.

Parameters:

dynamicKey -

setDynamicKeysToRemove

public void setDynamicKeysToRemove(java.util.Set<java.lang.String> dynamicKeysToRemove)

getPanels

public java.util.List<ParameterPanel> getPanels()

setPanels

public void setPanels(java.util.List<ParameterPanel> panels)

getSections

public java.util.Map<java.lang.String,java.util.List<ParameterSection>> getSections()

setSections

public void setSections(java.util.Map<java.lang.String,java.util.List<ParameterSection>> sections)

getParameters

public java.util.Map<java.lang.String,com.hof.parameters.DynamicParameterOptions.SectionContainer> getParameters()

setParameters

public void setParameters(java.util.Map<java.lang.String,com.hof.parameters.DynamicParameterOptions.SectionContainer> parameters)

getDynamicKeys

public java.util.Set<java.lang.String> getDynamicKeys()

setDynamicKeys

public void setDynamicKeys(java.util.Set<java.lang.String> dynamicKeys)

getValues

public java.util.Map<java.lang.String,java.util.List<com.hof.mi.models.report.CustomValue<?>>> getValues()