Class ValueRangeBehavior

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.fields.ValueRangeBehavior

All Implemented Interfaces:

FieldBehavior<ValueRangeBehavior>

public class ValueRangeBehavior
extends Object
implements FieldBehavior<ValueRangeBehavior>

Validate the min invalid input: '&' max value for numeric fields. For each min invalid input: '&' max, there are 4 possible settings: - value - the number that is compared. - allowEqualTo - defaults to true. controls if invalid input: '<' (>) or ≤ (≥) - behavior - defaults to ERROR. optionally can be "CLIP" instead. - clipAmount - if clipping, and not allowing equalTo, how much off the limit value should be added or subtracted. Defaults to 1. Convenient `withMin()` and `withMax()` methods exist for setting all 4 properties for each of min or max. Else, fluent-setters are recommended.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ValueRangeBehavior.Behavior

Constructor Summary

Constructors

Constructor	Description
ValueRangeBehavior()	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	allowMultipleBehaviorsOfThisType()	control if multiple behaviors of this type should be allowed together on a field.
void	apply(ValueBehaviorApplier.Action action, List<QRecord> recordList, QInstance instance, QTableMetaData table, QFieldMetaData field)	Apply this behavior to a list of records
ValueRangeBehavior	getDefault()	In case a behavior of this type wasn't set on the field, what should the default of this type be?
boolean	getMaxAllowEqualTo()	Getter for maxAllowEqualTo
ValueRangeBehavior.Behavior	getMaxBehavior()	Getter for maxBehavior
BigDecimal	getMaxClipAmount()	Getter for maxClipAmount
Number	getMaxValue()	Getter for maxValue
boolean	getMinAllowEqualTo()	Getter for minAllowEqualTo
ValueRangeBehavior.Behavior	getMinBehavior()	Getter for minBehavior
BigDecimal	getMinClipAmount()	Getter for minClipAmount
Number	getMinValue()	Getter for minValue
void	setMaxAllowEqualTo(boolean maxAllowEqualTo)	Setter for maxAllowEqualTo
void	setMaxBehavior(ValueRangeBehavior.Behavior maxBehavior)	Setter for maxBehavior
void	setMaxClipAmount(BigDecimal maxClipAmount)	Setter for maxClipAmount
void	setMaxValue(Number maxValue)	Setter for maxValue
void	setMinAllowEqualTo(boolean minAllowEqualTo)	Setter for minAllowEqualTo
void	setMinBehavior(ValueRangeBehavior.Behavior minBehavior)	Setter for minBehavior
void	setMinClipAmount(BigDecimal minClipAmount)	Setter for minClipAmount
void	setMinValue(Number minValue)	Setter for minValue
List<String>	validateBehaviorConfiguration(QTableMetaData tableMetaData, QFieldMetaData fieldMetaData)	allow this behavior to be validated during QInstance validation.
ValueRangeBehavior	withMax(Number value, boolean allowEqualTo, ValueRangeBehavior.Behavior behavior, BigDecimal clipAmount)
ValueRangeBehavior	withMaxAllowEqualTo(boolean maxAllowEqualTo)	Fluent setter for maxAllowEqualTo
ValueRangeBehavior	withMaxBehavior(ValueRangeBehavior.Behavior maxBehavior)	Fluent setter for maxBehavior
ValueRangeBehavior	withMaxClipAmount(BigDecimal maxClipAmount)	Fluent setter for maxClipAmount
ValueRangeBehavior	withMaxValue(Number maxValue)	Fluent setter for maxValue
ValueRangeBehavior	withMin(Number value, boolean allowEqualTo, ValueRangeBehavior.Behavior behavior, BigDecimal clipAmount)
ValueRangeBehavior	withMinAllowEqualTo(boolean minAllowEqualTo)	Fluent setter for minAllowEqualTo
ValueRangeBehavior	withMinBehavior(ValueRangeBehavior.Behavior minBehavior)	Fluent setter for minBehavior
ValueRangeBehavior	withMinClipAmount(BigDecimal minClipAmount)	Fluent setter for minClipAmount
ValueRangeBehavior	withMinValue(Number minValue)	Fluent setter for minValue

Methods inherited from class java.lang.Object

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

Constructor Details

ValueRangeBehavior

public ValueRangeBehavior()

Constructor

Method Details

getDefault

public ValueRangeBehavior getDefault()

Description copied from interface: FieldBehavior

In case a behavior of this type wasn't set on the field, what should the default of this type be?

Specified by:

getDefault in interface FieldBehavior<ValueRangeBehavior>

apply

public void apply(ValueBehaviorApplier.Action action,
 List<QRecord> recordList,
 QInstance instance,
 QTableMetaData table,
 QFieldMetaData field)

Description copied from interface: FieldBehavior

Apply this behavior to a list of records

Specified by:

apply in interface FieldBehavior<ValueRangeBehavior>

allowMultipleBehaviorsOfThisType

public boolean allowMultipleBehaviorsOfThisType()

Description copied from interface: FieldBehavior

control if multiple behaviors of this type should be allowed together on a field.

Specified by:

allowMultipleBehaviorsOfThisType in interface FieldBehavior<ValueRangeBehavior>

validateBehaviorConfiguration

public List<String> validateBehaviorConfiguration(QTableMetaData tableMetaData,
 QFieldMetaData fieldMetaData)

Description copied from interface: FieldBehavior

allow this behavior to be validated during QInstance validation. return a list of validation errors, if there are any.

Specified by:

validateBehaviorConfiguration in interface FieldBehavior<ValueRangeBehavior>

withMin

public ValueRangeBehavior withMin(Number value,
 boolean allowEqualTo,
 ValueRangeBehavior.Behavior behavior,
 BigDecimal clipAmount)

withMax

public ValueRangeBehavior withMax(Number value,
 boolean allowEqualTo,
 ValueRangeBehavior.Behavior behavior,
 BigDecimal clipAmount)

getMinValue

public Number getMinValue()

Getter for minValue

setMinValue

public void setMinValue(Number minValue)

Setter for minValue

withMinValue

public ValueRangeBehavior withMinValue(Number minValue)

Fluent setter for minValue

getMaxValue

public Number getMaxValue()

Getter for maxValue

setMaxValue

public void setMaxValue(Number maxValue)

Setter for maxValue

withMaxValue

public ValueRangeBehavior withMaxValue(Number maxValue)

Fluent setter for maxValue

getMinAllowEqualTo

public boolean getMinAllowEqualTo()

Getter for minAllowEqualTo

setMinAllowEqualTo

public void setMinAllowEqualTo(boolean minAllowEqualTo)

Setter for minAllowEqualTo

withMinAllowEqualTo

public ValueRangeBehavior withMinAllowEqualTo(boolean minAllowEqualTo)

Fluent setter for minAllowEqualTo

getMaxAllowEqualTo

public boolean getMaxAllowEqualTo()

Getter for maxAllowEqualTo

setMaxAllowEqualTo

public void setMaxAllowEqualTo(boolean maxAllowEqualTo)

Setter for maxAllowEqualTo

withMaxAllowEqualTo

public ValueRangeBehavior withMaxAllowEqualTo(boolean maxAllowEqualTo)

Fluent setter for maxAllowEqualTo

getMinBehavior

public ValueRangeBehavior.Behavior getMinBehavior()

Getter for minBehavior

setMinBehavior

public void setMinBehavior(ValueRangeBehavior.Behavior minBehavior)

Setter for minBehavior

withMinBehavior

public ValueRangeBehavior withMinBehavior(ValueRangeBehavior.Behavior minBehavior)

Fluent setter for minBehavior

getMaxBehavior

public ValueRangeBehavior.Behavior getMaxBehavior()

Getter for maxBehavior

setMaxBehavior

public void setMaxBehavior(ValueRangeBehavior.Behavior maxBehavior)

Setter for maxBehavior

withMaxBehavior

public ValueRangeBehavior withMaxBehavior(ValueRangeBehavior.Behavior maxBehavior)

Fluent setter for maxBehavior

getMinClipAmount

public BigDecimal getMinClipAmount()

Getter for minClipAmount

setMinClipAmount

public void setMinClipAmount(BigDecimal minClipAmount)

Setter for minClipAmount

withMinClipAmount

public ValueRangeBehavior withMinClipAmount(BigDecimal minClipAmount)

Fluent setter for minClipAmount

getMaxClipAmount

public BigDecimal getMaxClipAmount()

Getter for maxClipAmount

setMaxClipAmount

public void setMaxClipAmount(BigDecimal maxClipAmount)

Setter for maxClipAmount

withMaxClipAmount

public ValueRangeBehavior withMaxClipAmount(BigDecimal maxClipAmount)

Fluent setter for maxClipAmount