Class FieldFunction

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.fields.functions.FieldFunction

All Implemented Interfaces:

Serializable, Cloneable

public class FieldFunction
extends Object
implements Serializable, Cloneable

Application of a Function to a field - e.g., to take its raw or pure value as stored in the backend, and apply a function to it (as in the math sense), to get out a different value.

Used in virtual fields and query criteria to transform or extract a derived value from a raw field.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FieldFunction()

Method Summary

Modifier and Type	Method	Description
FieldFunction	clone()	Returns a deep clone of this FieldFunction, including a shallow copy of the arguments map.
Map<String,Serializable>	getArguments()	Getter for arguments
<C extends Serializable> C	getArgumentValueOrDefault(Class<C> type, String name)	Returns the argument value for the given parameter name, or the parameter's declared default value if no argument was supplied.
String	getFieldName()	Getter for fieldName
FieldFunctionTypeIdentifier	getFunctionTypeIdentifier()	Getter for functionTypeIdentifier
String	getFunctionTypeIdentifierName()	just serialize the identifier name - not an object.
void	setArguments(Map<String,Serializable> arguments)	Setter for arguments
void	setFieldName(String fieldName)	Setter for fieldName
void	setFunctionTypeIdentifier(FieldFunctionTypeIdentifier functionTypeIdentifier)	Setter for functionTypeIdentifier
FieldFunction	withArguments(Map<String,Serializable> arguments)	Fluent setter for arguments
FieldFunction	withFieldName(String fieldName)	Fluent setter for fieldName
FieldFunction	withFunctionTypeIdentifier(FieldFunctionTypeIdentifier functionTypeIdentifier)	Fluent setter for functionTypeIdentifier

Methods inherited from class java.lang.Object

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

Constructor Details

FieldFunction

public FieldFunction()

Method Details

getArgumentValueOrDefault

public <C extends Serializable> C getArgumentValueOrDefault(Class<C> type,
 String name)

Returns the argument value for the given parameter name, or the parameter's declared default value if no argument was supplied.

getFieldName

public String getFieldName()

Getter for fieldName

See Also:

• withFieldName(String)

setFieldName

public void setFieldName(String fieldName)

Setter for fieldName

See Also:

• withFieldName(String)

withFieldName

public FieldFunction withFieldName(String fieldName)

Fluent setter for fieldName

Parameters:

fieldName - The name of the field (on the record) to which this function should be applied.

Returns:

this

clone

public FieldFunction clone()

Returns a deep clone of this FieldFunction, including a shallow copy of the arguments map.

Overrides:

clone in class Object

getFunctionTypeIdentifier

public FieldFunctionTypeIdentifier getFunctionTypeIdentifier()

Getter for functionTypeIdentifier

See Also:

• Note: Marked as JSON Ignore - we'll just serialize the name via #getFunctionTypeIdentifierName()} and deserialize it via FieldFunctionDeserializer.

getFunctionTypeIdentifierName

public String getFunctionTypeIdentifierName()

just serialize the identifier name - not an object. See getFunctionTypeIdentifier()

setFunctionTypeIdentifier

public void setFunctionTypeIdentifier(FieldFunctionTypeIdentifier functionTypeIdentifier)

Setter for functionTypeIdentifier

See Also:

• withFunctionTypeIdentifier(FieldFunctionTypeIdentifier)

withFunctionTypeIdentifier

public FieldFunction withFunctionTypeIdentifier(FieldFunctionTypeIdentifier functionTypeIdentifier)

Fluent setter for functionTypeIdentifier

Parameters:

functionTypeIdentifier - The identifier that specifies which function type should be applied to the field.

Returns:

this

getArguments

public Map<String,Serializable> getArguments()

Getter for arguments

See Also:

• withArguments(Map)

setArguments

public void setArguments(Map<String,Serializable> arguments)

Setter for arguments

See Also:

• withArguments(Map)

withArguments

public FieldFunction withArguments(Map<String,Serializable> arguments)

Fluent setter for arguments

Parameters:

arguments - Map of argument names to their values (e.g., fromIndex=1, length=5), interpreted by the function type.

Returns:

this