Class QFieldMetaData

java.lang.Object
com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData
All Implemented Interfaces:
QMetaDataObject, Serializable, Cloneable
public class QFieldMetaData extends Object implements Cloneable, QMetaDataObject
Meta-data to represent a single field in a table.
See Also:

  • Constructor Details

    • QFieldMetaData

      public QFieldMetaData()

    • QFieldMetaData

      public QFieldMetaData(String name, QFieldType type)

    • QFieldMetaData

      public QFieldMetaData(com.github.hervian.reflection.Fun.With1ParamAndVoid<T> getterRef) throws QException
      Initialize a fieldMetaData from a reference to a getter on an entity. e.g., new QFieldMetaData(Order::getOrderNo).
      Throws:
      QException

    • QFieldMetaData

      public QFieldMetaData(Method getter) throws QException
      Initialize a fieldMetaData from a getter method from an entity
      Throws:
      QException

  • Method Details

    • clone

      public QFieldMetaData clone()
      Overrides:
      clone in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • withName

      public QFieldMetaData withName(String name)

    • getType

      public QFieldType getType()
      Getter for type

    • setType

      public void setType(QFieldType type)
      Setter for type

    • withType

      public QFieldMetaData withType(QFieldType type)

    • getLabel

      public String getLabel()
      Getter for label

    • setLabel

      public void setLabel(String label)
      Setter for label

    • withLabel

      public QFieldMetaData withLabel(String label)

    • getBackendName

      public String getBackendName()
      Getter for backendName

    • setBackendName

      public void setBackendName(String backendName)
      Setter for backendName

    • withBackendName

      public QFieldMetaData withBackendName(String backendName)

    • getPossibleValueSourceName

      public String getPossibleValueSourceName()

    • setPossibleValueSourceName

      public void setPossibleValueSourceName(String possibleValueSourceName)

    • withPossibleValueSourceName

      public QFieldMetaData withPossibleValueSourceName(String possibleValueSourceName)

    • getDefaultValue

      public Serializable getDefaultValue()
      Getter for defaultValue

    • setDefaultValue

      public void setDefaultValue(Serializable defaultValue)
      Setter for defaultValue

    • withDefaultValue

      public QFieldMetaData withDefaultValue(Serializable defaultValue)

    • getIsRequired

      public boolean getIsRequired()
      Getter for isRequired

    • setIsRequired

      public void setIsRequired(boolean isRequired)
      Setter for isRequired

    • withIsRequired

      public QFieldMetaData withIsRequired(boolean isRequired)

    • getIsEditable

      public boolean getIsEditable()
      Getter for isEditable

    • setIsEditable

      public void setIsEditable(boolean isEditable)
      Setter for isEditable

    • withIsEditable

      public QFieldMetaData withIsEditable(boolean isEditable)

    • getDisplayFormat

      public String getDisplayFormat()
      Getter for displayFormat

    • setDisplayFormat

      public void setDisplayFormat(String displayFormat)
      Setter for displayFormat

    • withDisplayFormat

      public QFieldMetaData withDisplayFormat(String displayFormat)
      Fluent setter for displayFormat

    • hasAdornmentType

      public boolean hasAdornmentType(AdornmentType adornmentType)
      does this field have the given addornment

    • getAdornments

      public List<FieldAdornment> getAdornments()
      Getter for adornments

    • getAdornment

      public Optional<FieldAdornment> getAdornment(AdornmentType adornmentType)
      Getter for adornments

    • setAdornments

      public void setAdornments(List<FieldAdornment> adornments)
      Setter for adornments

    • withFieldAdornments

      public QFieldMetaData withFieldAdornments(List<FieldAdornment> adornments)
      Fluent setter for adornments

    • withFieldAdornment

      public QFieldMetaData withFieldAdornment(FieldAdornment adornment)
      Fluent setter for adornments

    • withFieldAdornment

      public QFieldMetaData withFieldAdornment(AdornmentType adornmentType)
      Fluent setter for adornments

    • getMaxLength

      public Integer getMaxLength()
      Getter for maxLength

    • setMaxLength

      public void setMaxLength(Integer maxLength)
      Setter for maxLength

    • withMaxLength

      public QFieldMetaData withMaxLength(Integer maxLength)
      Fluent setter for maxLength

    • getBehaviors

      public Set<FieldBehavior<?>> getBehaviors()
      Getter for behaviors

    • getBehaviorOrDefault

      public <T extends FieldBehavior<T>> T getBehaviorOrDefault(QInstance instance, Class<T> behaviorType)
      Get the FieldBehavior object of a given behaviorType (class) - but - if one isn't set, then use the default from that type.

    • getBehaviorOnlyIfSet

      public <T extends FieldBehavior<T>> T getBehaviorOnlyIfSet(Class<T> behaviorType)
      Get the FieldBehavior object of a given behaviorType (class) - and if one isn't set, then return null.

    • setBehaviors

      public void setBehaviors(Set<FieldBehavior<?>> behaviors)
      Setter for behaviors

    • withBehaviors

      public QFieldMetaData withBehaviors(Set<FieldBehavior<?>> behaviors)
      Fluent setter for behaviors

    • withBehavior

      public QFieldMetaData withBehavior(FieldBehavior<?> behavior)
      Fluent setter for behaviors

    • getFieldSecurityLock

      public FieldSecurityLock getFieldSecurityLock()
      Getter for fieldSecurityLock

    • setFieldSecurityLock

      public void setFieldSecurityLock(FieldSecurityLock fieldSecurityLock)
      Setter for fieldSecurityLock

    • withFieldSecurityLock

      public QFieldMetaData withFieldSecurityLock(FieldSecurityLock fieldSecurityLock)
      Fluent setter for fieldSecurityLock

    • getIsHeavy

      public boolean getIsHeavy()
      Getter for isHeavy

    • setIsHeavy

      public void setIsHeavy(boolean isHeavy)
      Setter for isHeavy

    • withIsHeavy

      public QFieldMetaData withIsHeavy(boolean isHeavy)
      Fluent setter for isHeavy

    • getPossibleValueSourceFilter

      public QQueryFilter getPossibleValueSourceFilter()
      Getter for possibleValueSourceFilter

    • setPossibleValueSourceFilter

      public void setPossibleValueSourceFilter(QQueryFilter possibleValueSourceFilter)
      Setter for possibleValueSourceFilter

    • withPossibleValueSourceFilter

      public QFieldMetaData withPossibleValueSourceFilter(QQueryFilter possibleValueSourceFilter)
      Fluent setter for possibleValueSourceFilter

    • getSupplementalMetaData

      public Map<String,QSupplementalFieldMetaData> getSupplementalMetaData()
      Getter for supplementalMetaData

    • getSupplementalMetaData

      public QSupplementalFieldMetaData getSupplementalMetaData(String type)
      Getter for supplementalMetaData

    • setSupplementalMetaData

      public void setSupplementalMetaData(Map<String,QSupplementalFieldMetaData> supplementalMetaData)
      Setter for supplementalMetaData

    • withSupplementalMetaData

      public QFieldMetaData withSupplementalMetaData(Map<String,QSupplementalFieldMetaData> supplementalMetaData)
      Fluent setter for supplementalMetaData

    • withSupplementalMetaData

      public QFieldMetaData withSupplementalMetaData(QSupplementalFieldMetaData supplementalMetaData)
      Fluent setter for supplementalMetaData

    • getIsHidden

      public boolean getIsHidden()
      Getter for isHidden

    • setIsHidden

      public void setIsHidden(boolean isHidden)
      Setter for isHidden

    • withIsHidden

      public QFieldMetaData withIsHidden(boolean isHidden)
      Fluent setter for isHidden

    • getHelpContents

      public List<QHelpContent> getHelpContents()
      Getter for helpContents

    • setHelpContents

      public void setHelpContents(List<QHelpContent> helpContents)
      Setter for helpContents

    • withHelpContents

      public QFieldMetaData withHelpContents(List<QHelpContent> helpContents)
      Fluent setter for helpContents

    • withHelpContent

      public QFieldMetaData withHelpContent(QHelpContent helpContent)
      Fluent setter for adding 1 helpContent

    • removeHelpContent

      public void removeHelpContent(Set<HelpRole> roles)
      remove a single helpContent based on its set of roles

    • getInlinePossibleValueSource

      public QPossibleValueSource getInlinePossibleValueSource()
      Getter for inlinePossibleValueSource

    • setInlinePossibleValueSource

      public void setInlinePossibleValueSource(QPossibleValueSource inlinePossibleValueSource)
      Setter for inlinePossibleValueSource

    • withInlinePossibleValueSource

      public QFieldMetaData withInlinePossibleValueSource(QPossibleValueSource inlinePossibleValueSource)
      Fluent setter for inlinePossibleValueSource

    • getGridColumns

      public Integer getGridColumns()
      Getter for gridColumns

    • setGridColumns

      public void setGridColumns(Integer gridColumns)
      Setter for gridColumns

    • withGridColumns

      public QFieldMetaData withGridColumns(Integer gridColumns)
      Fluent setter for gridColumns