Class QVirtualFieldMetaData

java.lang.Object

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

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

All Implemented Interfaces:

QMetaDataObject, Serializable, Cloneable

public class QVirtualFieldMetaData
extends QFieldMetaData
implements Cloneable

Subclass of QFieldMetaData that is used for virtual fields - that is - fields which don't exist in the backend system, but may instead be the result of calculations or other non-stored data.

Optionally carries a FieldFunction that specifies a transformation applied to a source field's value (e.g., extracting the weekday from a date).

The isQueryCriteria and isQuerySelectable flags control whether the virtual field may be used as a filter criterion and if it is included in query output, respectively.

For a field to be isQueryCriteria, it MUST use a fieldFunction. However, to be isQuerySelectable, it MAY either use a fieldFunction, or alternatively, its table can have a TableCustomizers.POST_QUERY_RECORD.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
QVirtualFieldMetaData()	Default no-arg constructor.
QVirtualFieldMetaData(String name, QFieldType type)	Constructs a QVirtualFieldMetaData with the given field name and type.

Method Summary

Modifier and Type	Method	Description
QVirtualFieldMetaData	clone()	Returns a clone of this virtual field metadata.
FieldFunction	getFieldFunction()	Getter for fieldFunction
boolean	getIsQueryCriteria()	Getter for isQueryCriteria
boolean	getIsQuerySelectable()	Getter for isQuerySelectable
void	setFieldFunction(FieldFunction fieldFunction)	Setter for fieldFunction
void	setIsQueryCriteria(boolean isQueryCriteria)	Setter for isQueryCriteria
void	setIsQuerySelectable(boolean isQuerySelectable)	Setter for isQuerySelectable
QVirtualFieldMetaData	withBackendName(String backendName)
QVirtualFieldMetaData	withBehavior(FieldBehavior<?> behavior)	Fluent setter for behaviors
QVirtualFieldMetaData	withBehaviors(Set<FieldBehavior<?>> behaviors)	Fluent setter for behaviors
QVirtualFieldMetaData	withDefaultValue(Serializable defaultValue)
QVirtualFieldMetaData	withDisplayFormat(String displayFormat)	Fluent setter for displayFormat
QVirtualFieldMetaData	withFieldAdornment(AdornmentType adornmentType)	Fluent setter for adornments
QVirtualFieldMetaData	withFieldAdornment(FieldAdornment adornment)	Fluent setter for adornments
QVirtualFieldMetaData	withFieldAdornments(List<FieldAdornment> adornments)	Fluent setter for adornments
QVirtualFieldMetaData	withFieldFunction(FieldFunction fieldFunction)	Fluent setter for fieldFunction
QVirtualFieldMetaData	withFieldSecurityLock(FieldSecurityLock fieldSecurityLock)	Fluent setter for fieldSecurityLock
QVirtualFieldMetaData	withGridColumns(Integer gridColumns)	Fluent setter for gridColumns
QVirtualFieldMetaData	withHelpContent(QHelpContent helpContent)	Fluent setter for adding 1 helpContent
QVirtualFieldMetaData	withHelpContents(List<QHelpContent> helpContents)	Fluent setter for helpContents
QVirtualFieldMetaData	withInlinePossibleValueSource(QPossibleValueSource inlinePossibleValueSource)	Fluent setter for inlinePossibleValueSource
QVirtualFieldMetaData	withIsEditable(boolean isEditable)
QVirtualFieldMetaData	withIsHeavy(boolean isHeavy)	Fluent setter for isHeavy
QVirtualFieldMetaData	withIsHidden(boolean isHidden)	Fluent setter for isHidden
QVirtualFieldMetaData	withIsQueryCriteria(boolean isQueryCriteria)	Fluent setter for isQueryCriteria
QVirtualFieldMetaData	withIsQuerySelectable(boolean isQuerySelectable)	Fluent setter for isQuerySelectable
QVirtualFieldMetaData	withIsRequired(boolean isRequired)
QVirtualFieldMetaData	withLabel(String label)
QVirtualFieldMetaData	withMaxLength(Integer maxLength)	Fluent setter for maxLength
QVirtualFieldMetaData	withName(String name)	Fluent setter for name; overridden to return QVirtualFieldMetaData for method chaining.
QVirtualFieldMetaData	withPossibleValueSourceFilter(QQueryFilter possibleValueSourceFilter)	Fluent setter for possibleValueSourceFilter
QVirtualFieldMetaData	withPossibleValueSourceName(String possibleValueSourceName)
QVirtualFieldMetaData	withSupplementalMetaData(QSupplementalFieldMetaData supplementalMetaData)	Fluent setter for supplementalMetaData
QVirtualFieldMetaData	withSupplementalMetaData(Map<String,QSupplementalFieldMetaData> supplementalMetaData)	Fluent setter for supplementalMetaData
QVirtualFieldMetaData	withType(QFieldType type)

Methods inherited from class com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData

getAdornment, getAdornments, getBackendName, getBehaviorOnlyIfSet, getBehaviorOrDefault, getBehaviors, getDefaultValue, getDisplayFormat, getFieldSecurityLock, getGridColumns, getHelpContents, getInlinePossibleValueSource, getIsEditable, getIsHeavy, getIsHidden, getIsRequired, getLabel, getMaxLength, getName, getPossibleValueSourceFilter, getPossibleValueSourceName, getSupplementalMetaData, getSupplementalMetaData, getType, hasAdornmentType, removeHelpContent, setAdornments, setBackendName, setBehaviors, setDefaultValue, setDisplayFormat, setFieldSecurityLock, setGridColumns, setHelpContents, setInlinePossibleValueSource, setIsEditable, setIsHeavy, setIsHidden, setIsRequired, setLabel, setMaxLength, setName, setPossibleValueSourceFilter, setPossibleValueSourceName, setSupplementalMetaData, setType, toString

Methods inherited from class java.lang.Object

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

Constructor Details

QVirtualFieldMetaData

public QVirtualFieldMetaData()

Default no-arg constructor.

QVirtualFieldMetaData

public QVirtualFieldMetaData(String name,
 QFieldType type)

Constructs a QVirtualFieldMetaData with the given field name and type.

Method Details

clone

public QVirtualFieldMetaData clone()

Returns a clone of this virtual field metadata.

Overrides:

clone in class QFieldMetaData

withName

public QVirtualFieldMetaData withName(String name)

Fluent setter for name; overridden to return QVirtualFieldMetaData for method chaining.

Overrides:

withName in class QFieldMetaData

withType

public QVirtualFieldMetaData withType(QFieldType type)

Overrides:

withType in class QFieldMetaData

withLabel

public QVirtualFieldMetaData withLabel(String label)

Overrides:

withLabel in class QFieldMetaData

withBackendName

public QVirtualFieldMetaData withBackendName(String backendName)

Overrides:

withBackendName in class QFieldMetaData

withPossibleValueSourceName

public QVirtualFieldMetaData withPossibleValueSourceName(String possibleValueSourceName)

Overrides:

withPossibleValueSourceName in class QFieldMetaData

withDefaultValue

public QVirtualFieldMetaData withDefaultValue(Serializable defaultValue)

Overrides:

withDefaultValue in class QFieldMetaData

withIsRequired

public QVirtualFieldMetaData withIsRequired(boolean isRequired)

Overrides:

withIsRequired in class QFieldMetaData

withIsEditable

public QVirtualFieldMetaData withIsEditable(boolean isEditable)

Overrides:

withIsEditable in class QFieldMetaData

withDisplayFormat

public QVirtualFieldMetaData withDisplayFormat(String displayFormat)

Description copied from class: QFieldMetaData

Fluent setter for displayFormat

Overrides:

withDisplayFormat in class QFieldMetaData

withFieldAdornments

public QVirtualFieldMetaData withFieldAdornments(List<FieldAdornment> adornments)

Description copied from class: QFieldMetaData

Fluent setter for adornments

Overrides:

withFieldAdornments in class QFieldMetaData

withFieldAdornment

public QVirtualFieldMetaData withFieldAdornment(FieldAdornment adornment)

Description copied from class: QFieldMetaData

Fluent setter for adornments

Overrides:

withFieldAdornment in class QFieldMetaData

withFieldAdornment

public QVirtualFieldMetaData withFieldAdornment(AdornmentType adornmentType)

Description copied from class: QFieldMetaData

Fluent setter for adornments

Overrides:

withFieldAdornment in class QFieldMetaData

withMaxLength

public QVirtualFieldMetaData withMaxLength(Integer maxLength)

Description copied from class: QFieldMetaData

Fluent setter for maxLength

Overrides:

withMaxLength in class QFieldMetaData

withBehaviors

public QVirtualFieldMetaData withBehaviors(Set<FieldBehavior<?>> behaviors)

Description copied from class: QFieldMetaData

Fluent setter for behaviors

Overrides:

withBehaviors in class QFieldMetaData

withBehavior

public QVirtualFieldMetaData withBehavior(FieldBehavior<?> behavior)

Description copied from class: QFieldMetaData

Fluent setter for behaviors

Overrides:

withBehavior in class QFieldMetaData

withFieldSecurityLock

public QVirtualFieldMetaData withFieldSecurityLock(FieldSecurityLock fieldSecurityLock)

Description copied from class: QFieldMetaData

Fluent setter for fieldSecurityLock

Overrides:

withFieldSecurityLock in class QFieldMetaData

withIsHeavy

public QVirtualFieldMetaData withIsHeavy(boolean isHeavy)

Description copied from class: QFieldMetaData

Fluent setter for isHeavy

Overrides:

withIsHeavy in class QFieldMetaData

withPossibleValueSourceFilter

public QVirtualFieldMetaData withPossibleValueSourceFilter(QQueryFilter possibleValueSourceFilter)

Description copied from class: QFieldMetaData

Fluent setter for possibleValueSourceFilter

Overrides:

withPossibleValueSourceFilter in class QFieldMetaData

withSupplementalMetaData

public QVirtualFieldMetaData withSupplementalMetaData(Map<String,QSupplementalFieldMetaData> supplementalMetaData)

Description copied from class: QFieldMetaData

Fluent setter for supplementalMetaData

Overrides:

withSupplementalMetaData in class QFieldMetaData

withSupplementalMetaData

public QVirtualFieldMetaData withSupplementalMetaData(QSupplementalFieldMetaData supplementalMetaData)

Description copied from class: QFieldMetaData

Fluent setter for supplementalMetaData

Overrides:

withSupplementalMetaData in class QFieldMetaData

withIsHidden

public QVirtualFieldMetaData withIsHidden(boolean isHidden)

Description copied from class: QFieldMetaData

Fluent setter for isHidden

Overrides:

withIsHidden in class QFieldMetaData

withHelpContents

public QVirtualFieldMetaData withHelpContents(List<QHelpContent> helpContents)

Description copied from class: QFieldMetaData

Fluent setter for helpContents

Overrides:

withHelpContents in class QFieldMetaData

withHelpContent

public QVirtualFieldMetaData withHelpContent(QHelpContent helpContent)

Description copied from class: QFieldMetaData

Fluent setter for adding 1 helpContent

Overrides:

withHelpContent in class QFieldMetaData

withInlinePossibleValueSource

public QVirtualFieldMetaData withInlinePossibleValueSource(QPossibleValueSource inlinePossibleValueSource)

Description copied from class: QFieldMetaData

Fluent setter for inlinePossibleValueSource

Overrides:

withInlinePossibleValueSource in class QFieldMetaData

withGridColumns

public QVirtualFieldMetaData withGridColumns(Integer gridColumns)

Description copied from class: QFieldMetaData

Fluent setter for gridColumns

Overrides:

withGridColumns in class QFieldMetaData

getFieldFunction

public FieldFunction getFieldFunction()

Getter for fieldFunction

See Also:

• withFieldFunction(FieldFunction)

setFieldFunction

public void setFieldFunction(FieldFunction fieldFunction)

Setter for fieldFunction

See Also:

• withFieldFunction(FieldFunction)

withFieldFunction

public QVirtualFieldMetaData withFieldFunction(FieldFunction fieldFunction)

Fluent setter for fieldFunction

Parameters:

fieldFunction - The FieldFunction that transforms a source field's value to produce this virtual field's value.

Returns:

this

getIsQueryCriteria

public boolean getIsQueryCriteria()

Getter for isQueryCriteria

See Also:

• withIsQueryCriteria(boolean)

setIsQueryCriteria

public void setIsQueryCriteria(boolean isQueryCriteria)

Setter for isQueryCriteria

See Also:

• withIsQueryCriteria(boolean)

withIsQueryCriteria

public QVirtualFieldMetaData withIsQueryCriteria(boolean isQueryCriteria)

Fluent setter for isQueryCriteria

Parameters:

isQueryCriteria - Whether this virtual field may be used as a filter criterion in queries; defaults to false.

Returns:

this

getIsQuerySelectable

public boolean getIsQuerySelectable()

Getter for isQuerySelectable

See Also:

• withIsQuerySelectable(boolean)

setIsQuerySelectable

public void setIsQuerySelectable(boolean isQuerySelectable)

Setter for isQuerySelectable

See Also:

• withIsQuerySelectable(boolean)

withIsQuerySelectable

public QVirtualFieldMetaData withIsQuerySelectable(boolean isQuerySelectable)

Fluent setter for isQuerySelectable

Parameters:

isQuerySelectable - Whether this virtual field may be included in query output (i.e., selected); defaults to false.

Returns:

this