com.hof.parameters

Class ParameterDisplayRule

java.lang.Object

com.hof.parameters.ParameterDisplayRule

All Implemented Interfaces:

java.io.Serializable

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

One may need to hide or show a Parameter based on user input. This can be done using ParameterDisplayRule, which lets one define the Parameters which another Parameter should be listening to and which values should make it show or hide.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterDisplayRule()
ParameterDisplayRule(java.lang.String property, java.lang.Object value)
ParameterDisplayRule(java.lang.String logic, java.lang.String property, boolean negative)
ParameterDisplayRule(java.lang.String logic, java.lang.String property, java.lang.Object[] values, boolean negative)
ParameterDisplayRule(java.lang.String logic, java.lang.String property, java.lang.Object[] values, boolean negative, PropertyLocation location) Construct a Display Rule.
ParameterDisplayRule(java.lang.String logic, java.lang.String property, java.lang.Object value, boolean negative)
ParameterDisplayRule(java.lang.String logic, java.lang.String property, java.lang.Object value, boolean negative, PropertyLocation location)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRule(ParameterDisplayRule newRule)
void	addValues(java.lang.Object... objects)
java.util.List<ParameterDisplayRule>	getDisplayRules() Can have child display rules if we are looking at a complex rule.
java.lang.String	getLogic() is this an AND or OR from the previous piece of logic
java.lang.String	getProperty() Property to compare to, a listener will be created on this property
PropertyLocation	getPropertyLocation() Used to determine which model a property will be located in, useful if there are duplicate properties in multiple sections/panels.
java.util.List<java.lang.Object>	getValues() Values that we want or don't want
boolean	isNegative() Determines if we are searching for the value, or not for the value For example values: ['5'] negative: false the if statement would be if(i == 5) values: ['5'], negative:true The if statement would be if(i != 5)
void	setDisplayRules(java.util.List<ParameterDisplayRule> rules)
void	setLogic(java.lang.String logic)
void	setNegative(boolean negative)
void	setProperty(java.lang.String property)
void	setPropertyLocation(PropertyLocation propertyLocation)
void	setValues(java.util.List<java.lang.Object> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterDisplayRule

public ParameterDisplayRule()

ParameterDisplayRule

public ParameterDisplayRule(java.lang.String property,
                    java.lang.Object value)

ParameterDisplayRule

public ParameterDisplayRule(java.lang.String logic,
                    java.lang.String property,
                    java.lang.Object value,
                    boolean negative)

ParameterDisplayRule

public ParameterDisplayRule(java.lang.String logic,
                    java.lang.String property,
                    boolean negative)

ParameterDisplayRule

public ParameterDisplayRule(java.lang.String logic,
                    java.lang.String property,
                    java.lang.Object value,
                    boolean negative,
                    PropertyLocation location)

ParameterDisplayRule

public ParameterDisplayRule(java.lang.String logic,
                    java.lang.String property,
                    java.lang.Object[] values,
                    boolean negative)

ParameterDisplayRule

public ParameterDisplayRule(java.lang.String logic,
                    java.lang.String property,
                    java.lang.Object[] values,
                    boolean negative,
                    PropertyLocation location)

Construct a Display Rule. All other constructors are for convenience.

Parameters:

logic - Used to specify the operator when there are multiple "child" display rules within this instance of ParameterDisplayRule. Logic may be AND or OR. If there are three child rules and logic is AND, each rule will be evaluated individually and the results will be combined as : Rule1Result && Rule2Result && Rule3Result

Logic will be ignored if there are no "child" display rules. If there are child rules, the "parent" will not be evaluated. It will be used only as a container for the child rules.

property - specifies the "other" parameter to be inspected by this display rule. Every Parameter instance has an identifier for its value. For example, whatever the user types into a Text Input parameter may be referenced using the identifier "SOURCE" if it is specified as its property.

values - is an array of values for comparison. Each value in the array is compared against the "other" parameter for equality. They are then combined using the OR operator.

negative - inverts the result obtained after comparing vals against the "other" parameter.
If values = {null, 0}

negative	result
true	property != null && property != 0
false	property == null || property == 0

location - An instance of PropertyLocation, used to determine where the "other" parameter is located. This is useful if there are parameters having the same property in multiple sections/panels. If this is null, it is assumed the property is in the same location as the parent of this ParameterDisplayRule.

Method Detail

addValues

public void addValues(java.lang.Object... objects)

addRule

public void addRule(ParameterDisplayRule newRule)

getLogic

public java.lang.String getLogic()

is this an AND or OR from the previous piece of logic

setLogic

public void setLogic(java.lang.String logic)

getProperty

public java.lang.String getProperty()

Property to compare to, a listener will be created on this property

setProperty

public void setProperty(java.lang.String property)

getValues

public java.util.List<java.lang.Object> getValues()

Values that we want or don't want

setValues

public void setValues(java.util.List<java.lang.Object> values)

getDisplayRules

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

Can have child display rules if we are looking at a complex rule. If there are child display rules, all values should be pushed into those, as any values at this level will be ignored, it will only evaluate values or display rules

setDisplayRules

public void setDisplayRules(java.util.List<ParameterDisplayRule> rules)

isNegative

public boolean isNegative()

Determines if we are searching for the value, or not for the value For example values: ['5'] negative: false the if statement would be if(i == 5) values: ['5'], negative:true The if statement would be if(i != 5)

setNegative

public void setNegative(boolean negative)

getPropertyLocation

public PropertyLocation getPropertyLocation()

Used to determine which model a property will be located in, useful if there are duplicate properties in multiple sections/panels. Returns the location to find the property we are comparing to. If this is null it is assumed the property is in the same location as the parent of this ParameterDisplayRule

setPropertyLocation

public void setPropertyLocation(PropertyLocation propertyLocation)