Class QInstance

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.QInstance

public class QInstance
extends Object

Container for all meta-data in a running instance of a QQQ application.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
QInstance()

Method Summary

Modifier and Type	Method	Description
void	add(TopLevelMetaDataInterface metaData)
void	addApp(QAppMetaData app)
void	addAutomationProvider(QAutomationProviderMetaData automationProvider)
void	addBackend(QBackendMetaData backend)
void	addJoin(QJoinMetaData join)
void	addMessagingProvider(QMessagingProviderMetaData messagingProvider)
void	addPossibleValueSource(QPossibleValueSource possibleValueSource)
void	addProcess(QProcessMetaData process)
void	addQBit(QBitMetaData qBitMetaData)
void	addQueue(QQueueMetaData queue)
void	addQueueProvider(QQueueProviderMetaData queueProvider)
void	addReport(QReportMetaData report)
void	addSchedulableType(SchedulableType schedulableType)
void	addScheduler(QSchedulerMetaData scheduler)
void	addSecurityKeyType(QSecurityKeyType securityKeyType)
void	addTable(QTableMetaData table)
void	addWidget(QWidgetMetaDataInterface widget)
Set<String>	getAllowedSecurityKeyNames()
QAppMetaData	getApp(String name)
Map<String,QAppMetaData>	getApps()	Getter for apps
QAuthenticationMetaData	getAuthentication()	Getter for authentication
QAutomationProviderMetaData	getAutomationProvider(String name)
Map<String,QAutomationProviderMetaData>	getAutomationProviders()	Getter for automationProviders
QBackendMetaData	getBackend(String name)
QBackendMetaData	getBackendForTable(String tableName)	Get the backend for a given table name
Map<String,QBackendMetaData>	getBackends()	Getter for backends
QBrandingMetaData	getBranding()	Getter for branding
QAuditRules	getDefaultAuditRules()	Getter for defaultAuditRules
QPermissionRules	getDefaultPermissionRules()	Getter for defaultPermissionRules
String	getDefaultTimeZoneId()	Getter for defaultTimeZoneId
String	getDeploymentMode()	Getter for deploymentMode
Map<String,String>	getEnvironmentValues()	Getter for environmentValues
boolean	getHasBeenValidated()	Getter for hasBeenValidated
Map<String,List<QHelpContent>>	getHelpContent()	Getter for helpContent
QJoinMetaData	getJoin(String name)
JoinGraph	getJoinGraph()
Map<String,QJoinMetaData>	getJoins()	Getter for joins
QMessagingProviderMetaData	getMessagingProvider(String name)
Map<String,QMessagingProviderMetaData>	getMessagingProviders()	Getter for messagingProviders
QCodeReference	getMetaDataActionCustomizer()	Getter for metaDataActionCustomizer
QCodeReference	getMetaDataFilter()	Deprecated.
QPossibleValueSource	getPossibleValueSource(String name)
Map<String,QPossibleValueSource>	getPossibleValueSources()	Getter for possibleValueSources
QProcessMetaData	getProcess(String name)
Map<String,QProcessMetaData>	getProcesses()	Getter for processes
List<QProcessMetaData>	getProcessesForTable(String tableName)	Get the list of processes associated with a given table name
String	getProcessPath(AbstractActionInput actionInput, String processName)	Get the full path to a process
QStepMetaData	getProcessStep(String processName, String functionName)
Map<String,QBitMetaData>	getQBits()	Getter for qBits
QQueueMetaData	getQueue(String name)
QQueueProviderMetaData	getQueueProvider(String name)
Map<String,QQueueProviderMetaData>	getQueueProviders()	Getter for queueProviders
Map<String,QQueueMetaData>	getQueues()	Getter for queues
QReportMetaData	getReport(String name)
Map<String,QReportMetaData>	getReports()	Getter for reports
SchedulableType	getSchedulableType(String name)
Map<String,SchedulableType>	getSchedulableTypes()	Getter for schedulableTypes
QSchedulerMetaData	getScheduler(String name)
Map<String,QSchedulerMetaData>	getSchedulers()	Getter for schedulers
QSecurityKeyType	getSecurityKeyType(String name)
Map<String,QSecurityKeyType>	getSecurityKeyTypes()	Getter for securityKeyTypes
Map<String,QSupplementalInstanceMetaData>	getSupplementalMetaData()	Getter for supplementalMetaData
QSupplementalInstanceMetaData	getSupplementalMetaData(String type)	Getter for supplementalMetaData
QTableMetaData	getTable(String name)
String	getTablePath(String tableName)	Get the full path to a table
Map<String,QTableMetaData>	getTables()	Getter for tables
boolean	getValidationIsRunning()	check if the instance is currently running validation.
QWidgetMetaDataInterface	getWidget(String name)
Map<String,QWidgetMetaDataInterface>	getWidgets()	Getter for widgets
void	removeHelpContent(String slot, Set<HelpRole> roles)	remove a helpContent for a slot based on its set of roles
void	setApps(Map<String,QAppMetaData> apps)	Setter for apps
void	setAuthentication(QAuthenticationMetaData authentication)	Setter for authentication
void	setAutomationProviders(Map<String,QAutomationProviderMetaData> automationProviders)	Setter for automationProviders
void	setBackends(Map<String,QBackendMetaData> backends)	Setter for backends
void	setBranding(QBrandingMetaData branding)	Setter for branding
void	setDefaultAuditRules(QAuditRules defaultAuditRules)	Setter for defaultAuditRules
void	setDefaultPermissionRules(QPermissionRules defaultPermissionRules)	Setter for defaultPermissionRules
void	setDefaultTimeZoneId(String defaultTimeZoneId)	Setter for defaultTimeZoneId
void	setDeploymentMode(String deploymentMode)	Setter for deploymentMode
void	setEnvironmentValues(Map<String,String> environmentValues)	Setter for environmentValues
void	setHasBeenValidated(QInstanceValidationKey key)	If pass a QInstanceValidationKey (which can only be instantiated by the validator), then the validationState will be set to COMPLETE.
void	setHelpContent(Map<String,List<QHelpContent>> helpContent)	Setter for helpContent
void	setJoinGraph(QInstanceValidationKey key, JoinGraph joinGraph)	Only the validation (and enrichment) code should set the instance's joinGraph so, we take a package-only-constructable validation key as a param along with the joinGraph - and we throw IllegalArgumentException if a non-null key is given.
void	setJoins(Map<String,QJoinMetaData> joins)	Setter for joins
void	setMessagingProviders(Map<String,QMessagingProviderMetaData> messagingProviders)	Setter for messagingProviders
void	setMetaDataActionCustomizer(QCodeReference metaDataActionCustomizer)	Setter for metaDataActionCustomizer
void	setMetaDataFilter(QCodeReference metaDataFilter)	Deprecated.
void	setPossibleValueSources(Map<String,QPossibleValueSource> possibleValueSources)	Setter for possibleValueSources
void	setProcesses(Map<String,QProcessMetaData> processes)	Setter for processes
void	setQBits(Map<String,QBitMetaData> qBits)	Setter for qBits
void	setQueueProviders(Map<String,QQueueProviderMetaData> queueProviders)	Setter for queueProviders
void	setQueues(Map<String,QQueueMetaData> queues)	Setter for queues
void	setReports(Map<String,QReportMetaData> reports)	Setter for reports
void	setSchedulableTypes(Map<String,SchedulableType> schedulableTypes)	Setter for schedulableTypes
void	setSchedulers(Map<String,QSchedulerMetaData> schedulers)	Setter for schedulers
void	setSecurityKeyTypes(Map<String,QSecurityKeyType> securityKeyTypes)	Setter for securityKeyTypes
void	setSupplementalMetaData(Map<String,QSupplementalInstanceMetaData> supplementalMetaData)	Setter for supplementalMetaData
void	setTables(Map<String,QTableMetaData> tables)	Setter for tables
void	setValidationIsRunning(QInstanceValidationKey key)	If pass a QInstanceValidationKey (which can only be instantiated by the validator), then the validationState set to RUNNING.
void	setWidgets(Map<String,QWidgetMetaDataInterface> widgets)	Setter for widgets
QInstance	withDefaultAuditRules(QAuditRules defaultAuditRules)	Fluent setter for defaultAuditRules
QInstance	withDefaultPermissionRules(QPermissionRules defaultPermissionRules)	Fluent setter for defaultPermissionRules
QInstance	withDefaultTimeZoneId(String defaultTimeZoneId)	Fluent setter for defaultTimeZoneId
QInstance	withDeploymentMode(String deploymentMode)	Fluent setter for deploymentMode
QInstance	withHelpContent(String slot, QHelpContent helpContent)	Fluent setter for adding 1 helpContent (for a slot)
QInstance	withHelpContent(Map<String,List<QHelpContent>> helpContent)	Fluent setter for helpContent
QInstance	withMetaDataActionCustomizer(QCodeReference metaDataActionCustomizer)	Fluent setter for metaDataActionCustomizer
QInstance	withMetaDataFilter(QCodeReference metaDataFilter)	Deprecated.
QInstance	withQBits(Map<String,QBitMetaData> qBits)	Fluent setter for qBits
QInstance	withSupplementalMetaData(QSupplementalInstanceMetaData supplementalMetaData)	Fluent setter for supplementalMetaData
QInstance	withSupplementalMetaData(Map<String,QSupplementalInstanceMetaData> supplementalMetaData)	Fluent setter for supplementalMetaData

Methods inherited from class java.lang.Object

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

Field Details

helpContent

protected Map<String,List<QHelpContent>> helpContent

Constructor Details

QInstance

public QInstance()

Method Details

getBackendForTable

public QBackendMetaData getBackendForTable(String tableName)

Get the backend for a given table name

getProcessesForTable

public List<QProcessMetaData> getProcessesForTable(String tableName)

Get the list of processes associated with a given table name

getTablePath

public String getTablePath(String tableName)
                    throws QException

Get the full path to a table

Throws:

QException

getProcessPath

public String getProcessPath(AbstractActionInput actionInput,
 String processName)
                      throws QException

Get the full path to a process

Throws:

QException

addBackend

public void addBackend(QBackendMetaData backend)

getBackend

public QBackendMetaData getBackend(String name)

getBackends

public Map<String,QBackendMetaData> getBackends()

Getter for backends

setBackends

public void setBackends(Map<String,QBackendMetaData> backends)

Setter for backends

addTable

public void addTable(QTableMetaData table)

getTable

public QTableMetaData getTable(String name)

getTables

public Map<String,QTableMetaData> getTables()

Getter for tables

setTables

public void setTables(Map<String,QTableMetaData> tables)

Setter for tables

addJoin

public void addJoin(QJoinMetaData join)

getJoin

public QJoinMetaData getJoin(String name)

getJoins

public Map<String,QJoinMetaData> getJoins()

Getter for joins

setJoins

public void setJoins(Map<String,QJoinMetaData> joins)

Setter for joins

addPossibleValueSource

public void addPossibleValueSource(QPossibleValueSource possibleValueSource)

getPossibleValueSource

public QPossibleValueSource getPossibleValueSource(String name)

getPossibleValueSources

public Map<String,QPossibleValueSource> getPossibleValueSources()

Getter for possibleValueSources

setPossibleValueSources

public void setPossibleValueSources(Map<String,QPossibleValueSource> possibleValueSources)

Setter for possibleValueSources

getProcessStep

public QStepMetaData getProcessStep(String processName,
 String functionName)

addProcess

public void addProcess(QProcessMetaData process)

getProcess

public QProcessMetaData getProcess(String name)

getProcesses

public Map<String,QProcessMetaData> getProcesses()

Getter for processes

setProcesses

public void setProcesses(Map<String,QProcessMetaData> processes)

Setter for processes

addApp

public void addApp(QAppMetaData app)

getApp

public QAppMetaData getApp(String name)

getApps

public Map<String,QAppMetaData> getApps()

Getter for apps

setApps

public void setApps(Map<String,QAppMetaData> apps)

Setter for apps

addReport

public void addReport(QReportMetaData report)

getReport

public QReportMetaData getReport(String name)

getReports

public Map<String,QReportMetaData> getReports()

Getter for reports

setReports

public void setReports(Map<String,QReportMetaData> reports)

Setter for reports

addSecurityKeyType

public void addSecurityKeyType(QSecurityKeyType securityKeyType)

getSecurityKeyType

public QSecurityKeyType getSecurityKeyType(String name)

getSecurityKeyTypes

public Map<String,QSecurityKeyType> getSecurityKeyTypes()

Getter for securityKeyTypes

setSecurityKeyTypes

public void setSecurityKeyTypes(Map<String,QSecurityKeyType> securityKeyTypes)

Setter for securityKeyTypes

addAutomationProvider

public void addAutomationProvider(QAutomationProviderMetaData automationProvider)

getAutomationProvider

public QAutomationProviderMetaData getAutomationProvider(String name)

getAutomationProviders

public Map<String,QAutomationProviderMetaData> getAutomationProviders()

Getter for automationProviders

setAutomationProviders

public void setAutomationProviders(Map<String,QAutomationProviderMetaData> automationProviders)

Setter for automationProviders

addMessagingProvider

public void addMessagingProvider(QMessagingProviderMetaData messagingProvider)

getMessagingProvider

public QMessagingProviderMetaData getMessagingProvider(String name)

getMessagingProviders

public Map<String,QMessagingProviderMetaData> getMessagingProviders()

Getter for messagingProviders

setMessagingProviders

public void setMessagingProviders(Map<String,QMessagingProviderMetaData> messagingProviders)

Setter for messagingProviders

getHasBeenValidated

public boolean getHasBeenValidated()

Getter for hasBeenValidated

setHasBeenValidated

public void setHasBeenValidated(QInstanceValidationKey key)

If pass a QInstanceValidationKey (which can only be instantiated by the validator), then the validationState will be set to COMPLETE. Else, if passed a null, the validationState will be reset to PENDING. e.g., to re-trigger validation (can be useful in tests).

setValidationIsRunning

public void setValidationIsRunning(QInstanceValidationKey key)

If pass a QInstanceValidationKey (which can only be instantiated by the validator), then the validationState set to RUNNING.

getValidationIsRunning

public boolean getValidationIsRunning()

check if the instance is currently running validation.

getBranding

public QBrandingMetaData getBranding()

Getter for branding

setBranding

public void setBranding(QBrandingMetaData branding)

Setter for branding

getAuthentication

public QAuthenticationMetaData getAuthentication()

Getter for authentication

setAuthentication

public void setAuthentication(QAuthenticationMetaData authentication)

Setter for authentication

getWidgets

public Map<String,QWidgetMetaDataInterface> getWidgets()

Getter for widgets

setWidgets

public void setWidgets(Map<String,QWidgetMetaDataInterface> widgets)

Setter for widgets

addWidget

public void addWidget(QWidgetMetaDataInterface widget)

getWidget

public QWidgetMetaDataInterface getWidget(String name)

addQueueProvider

public void addQueueProvider(QQueueProviderMetaData queueProvider)

getQueueProvider

public QQueueProviderMetaData getQueueProvider(String name)

getQueueProviders

public Map<String,QQueueProviderMetaData> getQueueProviders()

Getter for queueProviders

setQueueProviders

public void setQueueProviders(Map<String,QQueueProviderMetaData> queueProviders)

Setter for queueProviders

addQueue

public void addQueue(QQueueMetaData queue)

getQueue

public QQueueMetaData getQueue(String name)

getQueues

public Map<String,QQueueMetaData> getQueues()

Getter for queues

setQueues

public void setQueues(Map<String,QQueueMetaData> queues)

Setter for queues

getEnvironmentValues

public Map<String,String> getEnvironmentValues()

Getter for environmentValues

setEnvironmentValues

public void setEnvironmentValues(Map<String,String> environmentValues)

Setter for environmentValues

getDefaultPermissionRules

public QPermissionRules getDefaultPermissionRules()

Getter for defaultPermissionRules

setDefaultPermissionRules

public void setDefaultPermissionRules(QPermissionRules defaultPermissionRules)

Setter for defaultPermissionRules

withDefaultPermissionRules

public QInstance withDefaultPermissionRules(QPermissionRules defaultPermissionRules)

Fluent setter for defaultPermissionRules

setDefaultTimeZoneId

public void setDefaultTimeZoneId(String defaultTimeZoneId)

Setter for defaultTimeZoneId

withDefaultTimeZoneId

public QInstance withDefaultTimeZoneId(String defaultTimeZoneId)

Fluent setter for defaultTimeZoneId

getDefaultTimeZoneId

public String getDefaultTimeZoneId()

Getter for defaultTimeZoneId

getAllowedSecurityKeyNames

public Set<String> getAllowedSecurityKeyNames()

getDefaultAuditRules

public QAuditRules getDefaultAuditRules()

Getter for defaultAuditRules

setDefaultAuditRules

public void setDefaultAuditRules(QAuditRules defaultAuditRules)

Setter for defaultAuditRules

withDefaultAuditRules

public QInstance withDefaultAuditRules(QAuditRules defaultAuditRules)

Fluent setter for defaultAuditRules

getSupplementalMetaData

public Map<String,QSupplementalInstanceMetaData> getSupplementalMetaData()

Getter for supplementalMetaData

getSupplementalMetaData

public QSupplementalInstanceMetaData getSupplementalMetaData(String type)

Getter for supplementalMetaData

setSupplementalMetaData

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

Setter for supplementalMetaData

withSupplementalMetaData

public QInstance withSupplementalMetaData(Map<String,QSupplementalInstanceMetaData> supplementalMetaData)

Fluent setter for supplementalMetaData

withSupplementalMetaData

public QInstance withSupplementalMetaData(QSupplementalInstanceMetaData supplementalMetaData)

Fluent setter for supplementalMetaData

getJoinGraph

public JoinGraph getJoinGraph()

setJoinGraph

public void setJoinGraph(QInstanceValidationKey key,
 JoinGraph joinGraph)
                  throws IllegalArgumentException

Only the validation (and enrichment) code should set the instance's joinGraph so, we take a package-only-constructable validation key as a param along with the joinGraph - and we throw IllegalArgumentException if a non-null key is given.

Throws:

IllegalArgumentException

getDeploymentMode

public String getDeploymentMode()

Getter for deploymentMode

setDeploymentMode

public void setDeploymentMode(String deploymentMode)

Setter for deploymentMode

withDeploymentMode

public QInstance withDeploymentMode(String deploymentMode)

Fluent setter for deploymentMode

add

public void add(TopLevelMetaDataInterface metaData)

addScheduler

public void addScheduler(QSchedulerMetaData scheduler)

getScheduler

public QSchedulerMetaData getScheduler(String name)

getSchedulers

public Map<String,QSchedulerMetaData> getSchedulers()

Getter for schedulers

setSchedulers

public void setSchedulers(Map<String,QSchedulerMetaData> schedulers)

Setter for schedulers

addSchedulableType

public void addSchedulableType(SchedulableType schedulableType)

getSchedulableType

public SchedulableType getSchedulableType(String name)

getSchedulableTypes

public Map<String,SchedulableType> getSchedulableTypes()

Getter for schedulableTypes

setSchedulableTypes

public void setSchedulableTypes(Map<String,SchedulableType> schedulableTypes)

Setter for schedulableTypes

getHelpContent

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

Getter for helpContent

setHelpContent

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

Setter for helpContent

withHelpContent

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

Fluent setter for helpContent

withHelpContent

public QInstance 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

getMetaDataFilter

@Deprecated(since="migrated to metaDataCustomizer")
public QCodeReference getMetaDataFilter()

Deprecated.

Getter for metaDataFilter

setMetaDataFilter

@Deprecated(since="migrated to metaDataCustomizer")
public void setMetaDataFilter(QCodeReference metaDataFilter)

Deprecated.

Setter for metaDataFilter

withMetaDataFilter

@Deprecated(since="migrated to metaDataCustomizer")
public QInstance withMetaDataFilter(QCodeReference metaDataFilter)

Deprecated.

Fluent setter for metaDataFilter

addQBit

public void addQBit(QBitMetaData qBitMetaData)

getQBits

public Map<String,QBitMetaData> getQBits()

Getter for qBits

setQBits

public void setQBits(Map<String,QBitMetaData> qBits)

Setter for qBits

withQBits

public QInstance withQBits(Map<String,QBitMetaData> qBits)

Fluent setter for qBits

getMetaDataActionCustomizer

public QCodeReference getMetaDataActionCustomizer()

Getter for metaDataActionCustomizer

setMetaDataActionCustomizer

public void setMetaDataActionCustomizer(QCodeReference metaDataActionCustomizer)

Setter for metaDataActionCustomizer

withMetaDataActionCustomizer

public QInstance withMetaDataActionCustomizer(QCodeReference metaDataActionCustomizer)

Fluent setter for metaDataActionCustomizer