Class QTableMetaData

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData

All Implemented Interfaces:

QAppChildMetaData, MetaDataProducerOutput, MetaDataWithName, MetaDataWithPermissionRules, SourceQBitAware, QMetaDataObject, TopLevelMetaDataInterface, Serializable

public class QTableMetaData
extends Object
implements QAppChildMetaData, Serializable, MetaDataWithPermissionRules, TopLevelMetaDataInterface, SourceQBitAware

Meta-Data to define a table in a QQQ instance.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,List<QHelpContent>>	helpContent

Constructor Summary

Constructors

Constructor	Description
QTableMetaData()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addField(QFieldMetaData field)
void	addSection(QFieldSection fieldSection)
void	addSelfToInstance(QInstance qInstance)	call the appropriate methods on a QInstance to add ourselves to it.
List<AssociatedScript>	getAssociatedScripts()	Getter for associatedScripts
Optional<Association>	getAssociationByName(String name)	Getter for an association by name
List<Association>	getAssociations()	Getter for associations
QAuditRules	getAuditRules()	Getter for auditRules
QTableAutomationDetails	getAutomationDetails()	Getter for automationDetails
QTableBackendDetails	getBackendDetails()	Getter for backendDetails
String	getBackendName()	Getter for backendName
CacheOf	getCacheOf()	Getter for cacheOf
Optional<QCodeReference>	getCustomizer(String customizerName)
Map<String,QCodeReference>	getCustomizers()
Set<Capability>	getDisabledCapabilities()	Getter for disabledCapabilities
Set<Capability>	getEnabledCapabilities()	Getter for enabledCapabilities
List<ExposedJoin>	getExposedJoins()	Getter for exposedJoins
QFieldMetaData	getField(String fieldName)
Map<String,QFieldMetaData>	getFields()
Map<String,List<QHelpContent>>	getHelpContent()	Getter for helpContent
QIcon	getIcon()	Getter for icon
boolean	getIsHidden()	Getter for isHidden
String	getLabel()	Getter for label
String	getName()	Getter for name
QPermissionRules	getPermissionRules()	Getter for permissionRules
String	getPrimaryKeyField()
List<String>	getRecordLabelFields()	Getter for recordLabelFields
String	getRecordLabelFormat()	Getter for recordLabelFormat
List<RecordSecurityLock>	getRecordSecurityLocks()	Getter for recordSecurityLocks
QFieldSection	getSection(String name)	Getter for sections
List<QFieldSection>	getSections()	Getter for sections
ShareableTableMetaData	getShareableTableMetaData()	Getter for shareableTableMetaData
String	getSourceQBitName()	Getter for sourceQBitName
Map<String,QSupplementalTableMetaData>	getSupplementalMetaData()	Getter for supplementalMetaData
QSupplementalTableMetaData	getSupplementalMetaData(String type)	Getter for supplementalMetaData
List<UniqueKey>	getUniqueKeys()	Getter for uniqueKeys
boolean	isCapabilityEnabled(QBackendMetaData backend, Capability capability)	Test if a capability is enabled - checking both at the table level and at the backend level.
void	removeHelpContent(String slot, Set<HelpRole> roles)	remove a helpContent for a slot based on its set of roles
void	setAssociatedScripts(List<AssociatedScript> associatedScripts)	Setter for associatedScripts
void	setAssociations(List<Association> associations)	Setter for associations
void	setAuditRules(QAuditRules auditRules)	Setter for auditRules
void	setAutomationDetails(QTableAutomationDetails automationDetails)	Setter for automationDetails
void	setBackendDetails(QTableBackendDetails backendDetails)	Setter for backendDetails
void	setBackendName(String backendName)	Setter for backendName
void	setCacheOf(CacheOf cacheOf)	Setter for cacheOf
void	setCustomizers(Map<String,QCodeReference> customizers)	Setter for customizers
void	setDisabledCapabilities(Set<Capability> disabledCapabilities)	Setter for disabledCapabilities
void	setEnabledCapabilities(Set<Capability> enabledCapabilities)	Setter for enabledCapabilities
void	setExposedJoins(List<ExposedJoin> exposedJoins)	Setter for exposedJoins
void	setFields(Map<String,QFieldMetaData> fields)	Setter for fields
void	setHelpContent(Map<String,List<QHelpContent>> helpContent)	Setter for helpContent
void	setIcon(QIcon icon)	Setter for icon
void	setIsHidden(boolean isHidden)	Setter for isHidden
void	setLabel(String label)	Setter for label
void	setName(String name)	Setter for name
void	setPermissionRules(QPermissionRules permissionRules)	Setter for permissionRules
void	setPrimaryKeyField(String primaryKeyField)
void	setRecordLabelFields(List<String> recordLabelFields)	Setter for recordLabelFields
void	setRecordLabelFormat(String recordLabelFormat)	Setter for recordLabelFormat
void	setRecordSecurityLocks(List<RecordSecurityLock> recordSecurityLocks)	Setter for recordSecurityLocks
void	setSections(List<QFieldSection> sections)	Setter for sections
void	setShareableTableMetaData(ShareableTableMetaData shareableTableMetaData)	Setter for shareableTableMetaData
void	setSourceQBitName(String sourceQBitName)	Setter for sourceQBitName
void	setSupplementalMetaData(Map<String,QSupplementalTableMetaData> supplementalMetaData)	Setter for supplementalMetaData
void	setUniqueKeys(List<UniqueKey> uniqueKeys)	Setter for uniqueKeys
String	toString()
QTableMetaData	withAssociatedScript(AssociatedScript associatedScript)	Fluent setter for associatedScripts
QTableMetaData	withAssociatedScripts(List<AssociatedScript> associatedScripts)	Fluent setter for associatedScripts
QTableMetaData	withAssociation(Association association)	Fluent setter for associations
QTableMetaData	withAssociations(List<Association> associations)	Fluent setter for associations
QTableMetaData	withAuditRules(QAuditRules auditRules)	Fluent setter for auditRules
QTableMetaData	withAutomationDetails(QTableAutomationDetails automationDetails)	Fluent Setter for automationDetails
QTableMetaData	withBackendDetails(QTableBackendDetails backendDetails)	Fluent Setter for backendDetails
QTableMetaData	withBackendName(String backendName)
QTableMetaData	withCacheOf(CacheOf cacheOf)	Fluent setter for cacheOf
QTableMetaData	withCapabilities(Capability... enabledCapabilities)	Fluent setter for enabledCapabilities
QTableMetaData	withCapabilities(Set<Capability> enabledCapabilities)	Alternative fluent setter for enabledCapabilities
QTableMetaData	withCapability(Capability capability)	Alternative fluent setter for a single enabledCapabilities
QTableMetaData	withCustomizer(TableCustomizers tableCustomizer, QCodeReference customizer)
QTableMetaData	withCustomizer(String role, QCodeReference customizer)
QTableMetaData	withCustomizers(Map<String,QCodeReference> customizers)
QTableMetaData	withDisabledCapabilities(Set<Capability> disabledCapabilities)	Fluent setter for disabledCapabilities
QTableMetaData	withEnabledCapabilities(Set<Capability> enabledCapabilities)	Fluent setter for enabledCapabilities
QTableMetaData	withExposedJoin(ExposedJoin exposedJoin)	Fluent setter for exposedJoins
QTableMetaData	withExposedJoins(List<ExposedJoin> exposedJoins)	Fluent setter for exposedJoins
QTableMetaData	withField(QFieldMetaData field)
QTableMetaData	withFields(List<QFieldMetaData> fields)
QTableMetaData	withFields(Map<String,QFieldMetaData> fields)
QTableMetaData	withFieldsFromEntity(Class<? extends QRecordEntity> entityClass)
QTableMetaData	withHelpContent(String slot, QHelpContent helpContent)	Fluent setter for adding 1 helpContent (for a slot)
QTableMetaData	withHelpContent(Map<String,List<QHelpContent>> helpContent)	Fluent setter for helpContent
QTableMetaData	withIcon(QIcon icon)	Fluent setter for icon
QTableMetaData	withIsHidden(boolean isHidden)	Fluent Setter for isHidden
QTableMetaData	withLabel(String label)
QTableMetaData	withName(String name)
QTableMetaData	withoutCapabilities(Capability... disabledCapabilities)	Fluent setter for disabledCapabilities
QTableMetaData	withoutCapabilities(Set<Capability> disabledCapabilities)	Alternative fluent setter for disabledCapabilities
QTableMetaData	withoutCapability(Capability capability)	Alternative fluent setter for a single disabledCapabilities
QTableMetaData	withPermissionRules(QPermissionRules permissionRules)	Fluent setter for permissionRules
QTableMetaData	withPrimaryKeyField(String primaryKeyField)
QTableMetaData	withRecordLabelFields(String... recordLabelFields)	Fluent setter for recordLabelFields
QTableMetaData	withRecordLabelFields(List<String> recordLabelFields)	Fluent setter for recordLabelFields
QTableMetaData	withRecordLabelFormat(String recordLabelFormat)	Fluent setter for recordLabelFormat
QTableMetaData	withRecordLabelFormatAndFields(String format, String... fields)	fluent setter for both recordLabelFormat and recordLabelFields
QTableMetaData	withRecordSecurityLock(RecordSecurityLock recordSecurityLock)	Fluent setter for recordSecurityLocks
QTableMetaData	withRecordSecurityLocks(List<RecordSecurityLock> recordSecurityLocks)	Fluent setter for recordSecurityLocks
QTableMetaData	withSection(QFieldSection fieldSection)
QTableMetaData	withSectionOfFields(QFieldSection fieldSection, QFieldMetaData... fields)	Fluently add a section and fields in that section.
QTableMetaData	withSections(List<QFieldSection> fieldSections)	Fluent setter for sections
QTableMetaData	withShareableTableMetaData(ShareableTableMetaData shareableTableMetaData)	Fluent setter for shareableTableMetaData
QTableMetaData	withSourceQBitName(String sourceQBitName)	Fluent setter for sourceQBitName
QTableMetaData	withSupplementalMetaData(QSupplementalTableMetaData supplementalMetaData)	Fluent setter for supplementalMetaData
QTableMetaData	withSupplementalMetaData(Map<String,QSupplementalTableMetaData> supplementalMetaData)	Fluent setter for supplementalMetaData
QTableMetaData	withUniqueKey(UniqueKey uniqueKey)	Fluent setter for uniqueKeys
QTableMetaData	withUniqueKeys(List<UniqueKey> uniqueKeys)	Fluent setter for uniqueKeys

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.core.model.metadata.qbits.SourceQBitAware

getSourceQBit, getSourceQBitConfig

Field Details

helpContent

protected Map<String,List<QHelpContent>> helpContent

Constructor Details

QTableMetaData

public QTableMetaData()

Default constructor.

Method Details

toString

public String toString()

Overrides:

toString in class Object

getField

public QFieldMetaData getField(String fieldName)

withFieldsFromEntity

public QTableMetaData withFieldsFromEntity(Class<? extends QRecordEntity> entityClass)
                                    throws QException

Throws:

QException

getName

public String getName()

Description copied from interface: MetaDataWithName

Getter for name

Specified by:

getName in interface MetaDataWithName

Specified by:

getName in interface QAppChildMetaData

Specified by:

getName in interface TopLevelMetaDataInterface

setName

public void setName(String name)

Description copied from interface: MetaDataWithName

Setter for name

Specified by:

setName in interface MetaDataWithName

withName

public QTableMetaData withName(String name)

getLabel

public String getLabel()

Description copied from interface: MetaDataWithName

Getter for label

Specified by:

getLabel in interface MetaDataWithName

Specified by:

getLabel in interface QAppChildMetaData

setLabel

public void setLabel(String label)

Description copied from interface: MetaDataWithName

Setter for label

Specified by:

setLabel in interface MetaDataWithName

withLabel

public QTableMetaData withLabel(String label)

getBackendName

public String getBackendName()

Getter for backendName

setBackendName

public void setBackendName(String backendName)

Setter for backendName

withBackendName

public QTableMetaData withBackendName(String backendName)

getPrimaryKeyField

public String getPrimaryKeyField()

setPrimaryKeyField

public void setPrimaryKeyField(String primaryKeyField)

withPrimaryKeyField

public QTableMetaData withPrimaryKeyField(String primaryKeyField)

getIsHidden

public boolean getIsHidden()

Getter for isHidden

setIsHidden

public void setIsHidden(boolean isHidden)

Setter for isHidden

withIsHidden

public QTableMetaData withIsHidden(boolean isHidden)

Fluent Setter for isHidden

getFields

public Map<String,QFieldMetaData> getFields()

setFields

public void setFields(Map<String,QFieldMetaData> fields)

Setter for fields

withFields

public QTableMetaData withFields(Map<String,QFieldMetaData> fields)

withFields

public QTableMetaData withFields(List<QFieldMetaData> fields)

addField

public void addField(QFieldMetaData field)

withField

public QTableMetaData withField(QFieldMetaData field)

getBackendDetails

public QTableBackendDetails getBackendDetails()

Getter for backendDetails

setBackendDetails

public void setBackendDetails(QTableBackendDetails backendDetails)

Setter for backendDetails

withBackendDetails

public QTableMetaData withBackendDetails(QTableBackendDetails backendDetails)

Fluent Setter for backendDetails

getAutomationDetails

public QTableAutomationDetails getAutomationDetails()

Getter for automationDetails

setAutomationDetails

public void setAutomationDetails(QTableAutomationDetails automationDetails)

Setter for automationDetails

withAutomationDetails

public QTableMetaData withAutomationDetails(QTableAutomationDetails automationDetails)

Fluent Setter for automationDetails

getCustomizer

public Optional<QCodeReference> getCustomizer(String customizerName)

getCustomizers

public Map<String,QCodeReference> getCustomizers()

setCustomizers

public void setCustomizers(Map<String,QCodeReference> customizers)

Setter for customizers

withCustomizer

public QTableMetaData withCustomizer(String role,
 QCodeReference customizer)

withCustomizer

public QTableMetaData withCustomizer(TableCustomizers tableCustomizer,
 QCodeReference customizer)

withCustomizers

public QTableMetaData withCustomizers(Map<String,QCodeReference> customizers)

getIcon

public QIcon getIcon()

Getter for icon

Specified by:

getIcon in interface QAppChildMetaData

setIcon

public void setIcon(QIcon icon)

Setter for icon

withIcon

public QTableMetaData withIcon(QIcon icon)

Fluent setter for icon

getRecordLabelFormat

public String getRecordLabelFormat()

Getter for recordLabelFormat

setRecordLabelFormat

public void setRecordLabelFormat(String recordLabelFormat)

Setter for recordLabelFormat

withRecordLabelFormat

public QTableMetaData withRecordLabelFormat(String recordLabelFormat)

Fluent setter for recordLabelFormat

withRecordLabelFormatAndFields

public QTableMetaData withRecordLabelFormatAndFields(String format,
 String... fields)

fluent setter for both recordLabelFormat and recordLabelFields

getRecordLabelFields

public List<String> getRecordLabelFields()

Getter for recordLabelFields

setRecordLabelFields

public void setRecordLabelFields(List<String> recordLabelFields)

Setter for recordLabelFields

withRecordLabelFields

public QTableMetaData withRecordLabelFields(List<String> recordLabelFields)

Fluent setter for recordLabelFields

withRecordLabelFields

public QTableMetaData withRecordLabelFields(String... recordLabelFields)

Fluent setter for recordLabelFields

getSections

public List<QFieldSection> getSections()

Getter for sections

getSection

public QFieldSection getSection(String name)

Getter for sections

setSections

public void setSections(List<QFieldSection> sections)

Setter for sections

withSections

public QTableMetaData withSections(List<QFieldSection> fieldSections)

Fluent setter for sections

addSection

public void addSection(QFieldSection fieldSection)

withSection

public QTableMetaData withSection(QFieldSection fieldSection)

getAssociatedScripts

public List<AssociatedScript> getAssociatedScripts()

Getter for associatedScripts

setAssociatedScripts

public void setAssociatedScripts(List<AssociatedScript> associatedScripts)

Setter for associatedScripts

withAssociatedScripts

public QTableMetaData withAssociatedScripts(List<AssociatedScript> associatedScripts)

Fluent setter for associatedScripts

withAssociatedScript

public QTableMetaData withAssociatedScript(AssociatedScript associatedScript)

Fluent setter for associatedScripts

getUniqueKeys

public List<UniqueKey> getUniqueKeys()

Getter for uniqueKeys

setUniqueKeys

public void setUniqueKeys(List<UniqueKey> uniqueKeys)

Setter for uniqueKeys

withUniqueKeys

public QTableMetaData withUniqueKeys(List<UniqueKey> uniqueKeys)

Fluent setter for uniqueKeys

withUniqueKey

public QTableMetaData withUniqueKey(UniqueKey uniqueKey)

Fluent setter for uniqueKeys

withSectionOfFields

public QTableMetaData withSectionOfFields(QFieldSection fieldSection,
 QFieldMetaData... fields)

Fluently add a section and fields in that section.

getEnabledCapabilities

public Set<Capability> getEnabledCapabilities()

Getter for enabledCapabilities

setEnabledCapabilities

public void setEnabledCapabilities(Set<Capability> enabledCapabilities)

Setter for enabledCapabilities

withEnabledCapabilities

public QTableMetaData withEnabledCapabilities(Set<Capability> enabledCapabilities)

Fluent setter for enabledCapabilities

withCapabilities

public QTableMetaData withCapabilities(Set<Capability> enabledCapabilities)

Alternative fluent setter for enabledCapabilities

withCapability

public QTableMetaData withCapability(Capability capability)

Alternative fluent setter for a single enabledCapabilities

withCapabilities

public QTableMetaData withCapabilities(Capability... enabledCapabilities)

Fluent setter for enabledCapabilities

getDisabledCapabilities

public Set<Capability> getDisabledCapabilities()

Getter for disabledCapabilities

setDisabledCapabilities

public void setDisabledCapabilities(Set<Capability> disabledCapabilities)

Setter for disabledCapabilities

withDisabledCapabilities

public QTableMetaData withDisabledCapabilities(Set<Capability> disabledCapabilities)

Fluent setter for disabledCapabilities

withoutCapabilities

public QTableMetaData withoutCapabilities(Capability... disabledCapabilities)

Fluent setter for disabledCapabilities

withoutCapabilities

public QTableMetaData withoutCapabilities(Set<Capability> disabledCapabilities)

Alternative fluent setter for disabledCapabilities

withoutCapability

public QTableMetaData withoutCapability(Capability capability)

Alternative fluent setter for a single disabledCapabilities

getCacheOf

public CacheOf getCacheOf()

Getter for cacheOf

setCacheOf

public void setCacheOf(CacheOf cacheOf)

Setter for cacheOf

withCacheOf

public QTableMetaData withCacheOf(CacheOf cacheOf)

Fluent setter for cacheOf

isCapabilityEnabled

public boolean isCapabilityEnabled(QBackendMetaData backend,
 Capability capability)

Test if a capability is enabled - checking both at the table level and at the backend level. If backend says disabled, then disable - UNLESS - the table says enable. If backend either doesn't specify, or says enable, return what the table says (if it says). else, return the default (of enabled).

getRecordSecurityLocks

public List<RecordSecurityLock> getRecordSecurityLocks()

Getter for recordSecurityLocks

setRecordSecurityLocks

public void setRecordSecurityLocks(List<RecordSecurityLock> recordSecurityLocks)

Setter for recordSecurityLocks

withRecordSecurityLocks

public QTableMetaData withRecordSecurityLocks(List<RecordSecurityLock> recordSecurityLocks)

Fluent setter for recordSecurityLocks

withRecordSecurityLock

public QTableMetaData withRecordSecurityLock(RecordSecurityLock recordSecurityLock)

Fluent setter for recordSecurityLocks

getPermissionRules

public QPermissionRules getPermissionRules()

Getter for permissionRules

Specified by:

getPermissionRules in interface MetaDataWithPermissionRules

setPermissionRules

public void setPermissionRules(QPermissionRules permissionRules)

Setter for permissionRules

Specified by:

setPermissionRules in interface MetaDataWithPermissionRules

withPermissionRules

public QTableMetaData withPermissionRules(QPermissionRules permissionRules)

Fluent setter for permissionRules

getAuditRules

public QAuditRules getAuditRules()

Getter for auditRules

setAuditRules

public void setAuditRules(QAuditRules auditRules)

Setter for auditRules

withAuditRules

public QTableMetaData withAuditRules(QAuditRules auditRules)

Fluent setter for auditRules

getSupplementalMetaData

public Map<String,QSupplementalTableMetaData> getSupplementalMetaData()

Getter for supplementalMetaData

getSupplementalMetaData

public QSupplementalTableMetaData getSupplementalMetaData(String type)

Getter for supplementalMetaData

setSupplementalMetaData

public void setSupplementalMetaData(Map<String,QSupplementalTableMetaData> supplementalMetaData)

Setter for supplementalMetaData

withSupplementalMetaData

public QTableMetaData withSupplementalMetaData(Map<String,QSupplementalTableMetaData> supplementalMetaData)

Fluent setter for supplementalMetaData

withSupplementalMetaData

public QTableMetaData withSupplementalMetaData(QSupplementalTableMetaData supplementalMetaData)

Fluent setter for supplementalMetaData

getAssociations

public List<Association> getAssociations()

Getter for associations

getAssociationByName

public Optional<Association> getAssociationByName(String name)

Getter for an association by name

setAssociations

public void setAssociations(List<Association> associations)

Setter for associations

withAssociations

public QTableMetaData withAssociations(List<Association> associations)

Fluent setter for associations

withAssociation

public QTableMetaData withAssociation(Association association)

Fluent setter for associations

addSelfToInstance

public void addSelfToInstance(QInstance qInstance)

Description copied from interface: MetaDataProducerOutput

call the appropriate methods on a QInstance to add ourselves to it.

Specified by:

addSelfToInstance in interface MetaDataProducerOutput

Specified by:

addSelfToInstance in interface TopLevelMetaDataInterface

getExposedJoins

public List<ExposedJoin> getExposedJoins()

Getter for exposedJoins

setExposedJoins

public void setExposedJoins(List<ExposedJoin> exposedJoins)

Setter for exposedJoins

withExposedJoins

public QTableMetaData withExposedJoins(List<ExposedJoin> exposedJoins)

Fluent setter for exposedJoins

withExposedJoin

public QTableMetaData withExposedJoin(ExposedJoin exposedJoin)

Fluent setter for exposedJoins

getShareableTableMetaData

public ShareableTableMetaData getShareableTableMetaData()

Getter for shareableTableMetaData

setShareableTableMetaData

public void setShareableTableMetaData(ShareableTableMetaData shareableTableMetaData)

Setter for shareableTableMetaData

withShareableTableMetaData

public QTableMetaData withShareableTableMetaData(ShareableTableMetaData shareableTableMetaData)

Fluent setter for shareableTableMetaData

getHelpContent

public Map<String,List<QHelpContent>> getHelpContent()

Getter for helpContent

setHelpContent

public void setHelpContent(Map<String,List<QHelpContent>> helpContent)

Setter for helpContent

withHelpContent

public QTableMetaData withHelpContent(Map<String,List<QHelpContent>> helpContent)

Fluent setter for helpContent

withHelpContent

public QTableMetaData withHelpContent(String slot,
 QHelpContent helpContent)

Fluent setter for adding 1 helpContent (for a slot)

removeHelpContent

public void removeHelpContent(String slot,
 Set<HelpRole> roles)

remove a helpContent for a slot based on its set of roles

getSourceQBitName

public String getSourceQBitName()

Getter for sourceQBitName

Specified by:

getSourceQBitName in interface SourceQBitAware

setSourceQBitName

public void setSourceQBitName(String sourceQBitName)

Setter for sourceQBitName

Specified by:

setSourceQBitName in interface SourceQBitAware

withSourceQBitName

public QTableMetaData withSourceQBitName(String sourceQBitName)

Fluent setter for sourceQBitName

Specified by:

withSourceQBitName in interface SourceQBitAware