Uses of Class
com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData

Packages that use QBackendMetaData

Package	Description
com.kingsrook.qqq.backend.core.actions.tables.helpers
com.kingsrook.qqq.backend.core.model.actions
com.kingsrook.qqq.backend.core.model.metadata
com.kingsrook.qqq.backend.core.model.metadata.frontend
com.kingsrook.qqq.backend.core.model.metadata.serialization
com.kingsrook.qqq.backend.core.model.metadata.tables
com.kingsrook.qqq.backend.core.model.metadata.variants
com.kingsrook.qqq.backend.core.modules.backend
com.kingsrook.qqq.backend.core.modules.backend.implementations.mock
com.kingsrook.qqq.backend.module.api
com.kingsrook.qqq.backend.module.api.model.metadata
com.kingsrook.qqq.backend.module.filesystem.base.actions
com.kingsrook.qqq.backend.module.filesystem.base.model.metadata
com.kingsrook.qqq.backend.module.filesystem.local
com.kingsrook.qqq.backend.module.filesystem.local.actions
com.kingsrook.qqq.backend.module.filesystem.local.model.metadata
com.kingsrook.qqq.backend.module.filesystem.processes.implementations.filesystem.importer
com.kingsrook.qqq.backend.module.filesystem.s3
com.kingsrook.qqq.backend.module.filesystem.s3.actions
com.kingsrook.qqq.backend.module.filesystem.s3.model.metadata
com.kingsrook.qqq.backend.module.filesystem.sftp
com.kingsrook.qqq.backend.module.filesystem.sftp.actions
com.kingsrook.qqq.backend.module.filesystem.sftp.model.metadata
com.kingsrook.qqq.backend.module.mongodb
com.kingsrook.qqq.backend.module.mongodb.model.metadata
com.kingsrook.qqq.backend.module.postgres	QQQ Backend Module for PostgreSQL database support.
com.kingsrook.qqq.backend.module.postgres.model.metadata	Metadata classes for PostgreSQL backend and table configuration.
com.kingsrook.qqq.backend.module.rdbms
com.kingsrook.qqq.backend.module.rdbms.actions
com.kingsrook.qqq.backend.module.rdbms.model.metadata
com.kingsrook.qqq.backend.module.sqlite
com.kingsrook.qqq.backend.module.sqlite.model.metadata

Uses of QBackendMetaData in com.kingsrook.qqq.backend.core.actions.tables.helpers

Methods in com.kingsrook.qqq.backend.core.actions.tables.helpers with parameters of type QBackendMetaData

Modifier and Type	Method	Description
static QueryStat	QueryStatManager.newQueryStat(QBackendMetaData backend, QTableMetaData table, QQueryFilter filter)

Uses of QBackendMetaData in com.kingsrook.qqq.backend.core.model.actions

Methods in com.kingsrook.qqq.backend.core.model.actions that return QBackendMetaData

Modifier and Type	Method	Description
QBackendMetaData	AbstractTableActionInput.getBackend()

Uses of QBackendMetaData in com.kingsrook.qqq.backend.core.model.metadata

Methods in com.kingsrook.qqq.backend.core.model.metadata that return QBackendMetaData

Modifier and Type	Method	Description
QBackendMetaData	QInstance.getBackend(String name)
QBackendMetaData	QInstance.getBackendForTable(String tableName)	Get the backend for a given table name
QBackendMetaData	QBackendMetaData.withBackendType(Class<? extends QBackendModuleInterface> backendModuleClass)
QBackendMetaData	QBackendMetaData.withBackendVariantsConfig(BackendVariantsConfig backendVariantsConfig)	Fluent setter for backendVariantsConfig
QBackendMetaData	QBackendMetaData.withCapabilities(Capability... enabledCapabilities)	Fluent setter for enabledCapabilities
QBackendMetaData	QBackendMetaData.withCapabilities(Set<Capability> enabledCapabilities)	Alternative fluent setter for enabledCapabilities
QBackendMetaData	QBackendMetaData.withCapability(Capability capability)	Alternative fluent setter for a single enabledCapabilities
QBackendMetaData	QBackendMetaData.withDisabledCapabilities(Set<Capability> disabledCapabilities)	Fluent setter for disabledCapabilities
QBackendMetaData	QBackendMetaData.withEnabledCapabilities(Set<Capability> enabledCapabilities)	Fluent setter for enabledCapabilities
QBackendMetaData	QBackendMetaData.withName(String name)	Fluent setter, returning generically, to help sub-class fluent flows
QBackendMetaData	QBackendMetaData.withoutCapabilities(Capability... disabledCapabilities)	Fluent setter for disabledCapabilities
QBackendMetaData	QBackendMetaData.withoutCapabilities(Set<Capability> disabledCapabilities)	Alternative fluent setter for disabledCapabilities
QBackendMetaData	QBackendMetaData.withoutCapability(Capability capability)	Alternative fluent setter for a single disabledCapabilities
QBackendMetaData	QBackendMetaData.withUsesVariants(Boolean usesVariants)	Fluent setter for usesVariants
QBackendMetaData	QBackendMetaData.withVariantOptionsTableApiKeyField(String variantOptionsTableApiKeyField)	Deprecated.
QBackendMetaData	QBackendMetaData.withVariantOptionsTableClientIdField(String variantOptionsTableClientIdField)	Deprecated.
QBackendMetaData	QBackendMetaData.withVariantOptionsTableClientSecretField(String variantOptionsTableClientSecretField)	Deprecated.
QBackendMetaData	QBackendMetaData.withVariantOptionsTableIdField(String variantOptionsTableIdField)	Deprecated.
QBackendMetaData	QBackendMetaData.withVariantOptionsTableName(String variantOptionsTableName)	Deprecated.
QBackendMetaData	QBackendMetaData.withVariantOptionsTableNameField(String variantOptionsTableNameField)	Deprecated.
QBackendMetaData	QBackendMetaData.withVariantOptionsTablePasswordField(String variantOptionsTablePasswordField)	Deprecated.
QBackendMetaData	QBackendMetaData.withVariantOptionsTableTypeField(String variantOptionsTableTypeField)	Deprecated.
QBackendMetaData	QBackendMetaData.withVariantOptionsTableTypeValue(String variantOptionsTableTypeValue)	Deprecated.
QBackendMetaData	QBackendMetaData.withVariantOptionsTableUsernameField(String variantOptionsTableUsernameField)	Deprecated.

Methods in com.kingsrook.qqq.backend.core.model.metadata that return types with arguments of type QBackendMetaData

Modifier and Type	Method	Description
Map<String,QBackendMetaData>	QInstance.getBackends()	Getter for backends

Methods in com.kingsrook.qqq.backend.core.model.metadata with parameters of type QBackendMetaData

Modifier and Type	Method	Description
void	QInstance.addBackend(QBackendMetaData backend)

Method parameters in com.kingsrook.qqq.backend.core.model.metadata with type arguments of type QBackendMetaData

Modifier and Type	Method	Description
void	QInstance.setBackends(Map<String,QBackendMetaData> backends)	Setter for backends

Uses of QBackendMetaData in com.kingsrook.qqq.backend.core.model.metadata.frontend

Constructors in com.kingsrook.qqq.backend.core.model.metadata.frontend with parameters of type QBackendMetaData

Modifier	Constructor	Description
	QFrontendTableMetaData(AbstractActionInput actionInput, QBackendMetaData backendForTable, QTableMetaData tableMetaData, boolean includeFullMetaData, boolean includeJoins)	standard constructor - uses all fields on the table.
	QFrontendTableMetaData(AbstractActionInput actionInput, QBackendMetaData backendForTable, QTableMetaData tableMetaData, boolean includeFullMetaData, boolean includeJoins, Map<String,QFieldMetaData> overrideFields)	alternative constructor - takes a map of fields to use (e.g., for an old api version of the table w/ different fields!)

Uses of QBackendMetaData in com.kingsrook.qqq.backend.core.model.metadata.serialization

Subclasses with type arguments of type QBackendMetaData in com.kingsrook.qqq.backend.core.model.metadata.serialization

Modifier and Type	Class	Description
class	QBackendMetaDataDeserializer	Jackson custom deserialization class, to return an appropriate sub-type of A QBackendMetaData, based on the backendType specified within.

Methods in com.kingsrook.qqq.backend.core.model.metadata.serialization that return QBackendMetaData

Modifier and Type	Method	Description
QBackendMetaData	QBackendMetaDataDeserializer.deserialize(com.fasterxml.jackson.core.JsonParser jsonParser, com.fasterxml.jackson.databind.DeserializationContext deserializationContext)

Uses of QBackendMetaData in com.kingsrook.qqq.backend.core.model.metadata.tables

Methods in com.kingsrook.qqq.backend.core.model.metadata.tables with parameters of type QBackendMetaData

Modifier and Type	Method	Description
boolean	QTableMetaData.isCapabilityEnabled(QBackendMetaData backend, Capability capability)	Test if a capability is enabled - checking both at the table level and at the backend level.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.core.model.metadata.variants

Methods in com.kingsrook.qqq.backend.core.model.metadata.variants with parameters of type QBackendMetaData

Modifier and Type	Method	Description
static Serializable	BackendVariantsUtil.getVariantId(QBackendMetaData backendMetaData)	Get the variant id from the session for the backend.
static QRecord	BackendVariantsUtil.getVariantRecord(QBackendMetaData backendMetaData)	For backends that use variants, look up the variant record (in theory, based on an id in the session's backend variants map, then fetched from the backend's variant options table.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.core.modules.backend

Methods in com.kingsrook.qqq.backend.core.modules.backend that return types with arguments of type QBackendMetaData

Modifier and Type	Method	Description
default Class<? extends QBackendMetaData>	QBackendModuleInterface.getBackendMetaDataClass()	Method to identify the class used for backend meta data for this module.

Methods in com.kingsrook.qqq.backend.core.modules.backend with parameters of type QBackendMetaData

Modifier and Type	Method	Description
QBackendModuleInterface	QBackendModuleDispatcher.getQBackendModule(QBackendMetaData backend)

Uses of QBackendMetaData in com.kingsrook.qqq.backend.core.modules.backend.implementations.mock

Methods in com.kingsrook.qqq.backend.core.modules.backend.implementations.mock that return types with arguments of type QBackendMetaData

Modifier and Type	Method	Description
Class<? extends QBackendMetaData>	MockBackendModule.getBackendMetaDataClass()	Method to identify the class used for backend meta data for this module.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.api

Methods in com.kingsrook.qqq.backend.module.api that return types with arguments of type QBackendMetaData

Modifier and Type	Method	Description
Class<? extends QBackendMetaData>	APIBackendModule.getBackendMetaDataClass()	Method to identify the class used for backend meta data for this module.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.api.model.metadata

Subclasses of QBackendMetaData in com.kingsrook.qqq.backend.module.api.model.metadata

Modifier and Type	Class	Description
class	APIBackendMetaData	Meta-data to provide details of an API backend (e.g., connection params)

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.base.actions

Methods in com.kingsrook.qqq.backend.module.filesystem.base.actions with parameters of type QBackendMetaData

Modifier and Type	Method	Description
protected <T extends AbstractFilesystemBackendMetaData> T	AbstractBaseFilesystemAction.getBackendMetaData(Class<T> outputClass, QBackendMetaData metaData)	Get the backend metaData, type-checked as the requested type.
String	AbstractBaseFilesystemAction.getFullBasePath(QTableMetaData table, QBackendMetaData backendBase)	Append together the backend's base path (if present), with a table's base path (again, if present).
List<FILE>	AbstractBaseFilesystemAction.listFiles(QTableMetaData table, QBackendMetaData backendBase)	List the files for a table - to be implemented in module-specific subclasses.
abstract List<FILE>	AbstractBaseFilesystemAction.listFiles(QTableMetaData table, QBackendMetaData backendBase, String requestedSingleFileName)	List the files for a table - or optionally, just a single file name - to be implemented in module-specific subclasses.
void	AbstractBaseFilesystemAction.preAction(QBackendMetaData backendMetaData)	Method that subclasses can override to add pre-action things (e.g., setting up s3 client).
String	AbstractBaseFilesystemAction.stripBackendAndTableBasePathsFromFileName(String filePath, QBackendMetaData backend, QTableMetaData table)	e.g., with a base path of /foo/ and a table path of /bar/ and a file at /foo/bar/baz.txt give us just the baz.txt part.
abstract void	AbstractBaseFilesystemAction.writeFile(QBackendMetaData backend, QTableMetaData table, QRecord record, String path, byte[] contents)	Write a file - to be implemented in module-specific subclasses.
void	AbstractBaseFilesystemAction.writeFile(QBackendMetaData backend, String path, byte[] contents)	Deprecated.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.base.model.metadata

Subclasses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.base.model.metadata

Modifier and Type	Class	Description
class	AbstractFilesystemBackendMetaData	Base class for all BackendMetaData for all filesystem-style backend modules.

Methods in com.kingsrook.qqq.backend.module.filesystem.base.model.metadata that return QBackendMetaData

Modifier and Type	Method	Description
QBackendMetaData	FilesystemTableMetaDataBuilder.getBackend()	Getter for backend

Methods in com.kingsrook.qqq.backend.module.filesystem.base.model.metadata with parameters of type QBackendMetaData

Modifier and Type	Method	Description
void	FilesystemTableMetaDataBuilder.setBackend(QBackendMetaData backend)	Setter for backend
FilesystemTableMetaDataBuilder	FilesystemTableMetaDataBuilder.withBackend(QBackendMetaData backend)	Fluent setter for backend

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.local

Methods in com.kingsrook.qqq.backend.module.filesystem.local that return types with arguments of type QBackendMetaData

Modifier and Type	Method	Description
Class<? extends QBackendMetaData>	FilesystemBackendModule.getBackendMetaDataClass()	Method to identify the class used for backend meta data for this module.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.local.actions

Methods in com.kingsrook.qqq.backend.module.filesystem.local.actions with parameters of type QBackendMetaData

Modifier and Type	Method	Description
List<File>	AbstractFilesystemAction.listFiles(QTableMetaData table, QBackendMetaData backendBase, String requestedPath)	List the files for this table.
String	AbstractFilesystemAction.stripBackendAndTableBasePathsFromFileName(String filePath, QBackendMetaData backend, QTableMetaData table)	e.g., with a base path of /foo/ and a table path of /bar/ and a file at /foo/bar/baz.txt give us just the baz.txt part.
void	AbstractFilesystemAction.writeFile(QBackendMetaData backend, QTableMetaData table, QRecord record, String path, byte[] contents)	Write a file - to be implemented in module-specific subclasses.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.local.model.metadata

Subclasses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.local.model.metadata

Modifier and Type	Class	Description
class	FilesystemBackendMetaData	(local) Filesystem backend meta data.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.processes.implementations.filesystem.importer

Methods in com.kingsrook.qqq.backend.module.filesystem.processes.implementations.filesystem.importer with parameters of type QBackendMetaData

Modifier and Type	Method	Description
QTableMetaData	FilesystemImporterMetaDataTemplate.defineTableImportFile(QBackendMetaData backend, String importBaseName)
QTableMetaData	FilesystemImporterMetaDataTemplate.defineTableImportRecord(QBackendMetaData backend, String importBaseName)
String	FilesystemImporterMetaDataTemplate.getIdFieldBackendName(QBackendMetaData backend)
QFieldType	FilesystemImporterMetaDataTemplate.getIdFieldType(QBackendMetaData backend)

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.s3

Methods in com.kingsrook.qqq.backend.module.filesystem.s3 that return types with arguments of type QBackendMetaData

Modifier and Type	Method	Description
Class<? extends QBackendMetaData>	S3BackendModule.getBackendMetaDataClass()	Method to identify the class used for backend meta data for this module.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.s3.actions

Methods in com.kingsrook.qqq.backend.module.filesystem.s3.actions with parameters of type QBackendMetaData

Modifier and Type	Method	Description
protected com.amazonaws.services.s3.AmazonS3	AbstractS3Action.buildAmazonS3ClientFromBackendMetaData(QBackendMetaData backendMetaData)
List<com.amazonaws.services.s3.model.S3ObjectSummary>	AbstractS3Action.listFiles(QTableMetaData table, QBackendMetaData backendBase, String requestedPath)	List the files for a table.
void	AbstractS3Action.preAction(QBackendMetaData backendMetaData)	Setup the s3 utils object to be used for this action.
String	AbstractS3Action.stripBackendAndTableBasePathsFromFileName(String filePath, QBackendMetaData backend, QTableMetaData table)	e.g., with a base path of /foo/ and a table path of /bar/ and a file at /foo/bar/baz.txt give us just the baz.txt part.
void	AbstractS3Action.writeFile(QBackendMetaData backendMetaData, QTableMetaData table, QRecord record, String path, byte[] contents)	Write a file - to be implemented in module-specific subclasses.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.s3.model.metadata

Subclasses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.s3.model.metadata

Modifier and Type	Class	Description
class	S3BackendMetaData	S3 backend meta data.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.sftp

Methods in com.kingsrook.qqq.backend.module.filesystem.sftp that return types with arguments of type QBackendMetaData

Modifier and Type	Method	Description
Class<? extends QBackendMetaData>	SFTPBackendModule.getBackendMetaDataClass()	Method to identify the class used for backend meta data for this module.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.sftp.actions

Methods in com.kingsrook.qqq.backend.module.filesystem.sftp.actions with parameters of type QBackendMetaData

Modifier and Type	Method	Description
protected org.apache.sshd.sftp.client.SftpClient	AbstractSFTPAction.getSftpClient(QBackendMetaData backend)
List<SFTPDirEntryWithPath>	AbstractSFTPAction.listFiles(QTableMetaData table, QBackendMetaData backendBase, String requestedPath)
void	AbstractSFTPAction.preAction(QBackendMetaData backendMetaData)	Set up the sftp utils object to be used for this action.
void	AbstractSFTPAction.writeFile(QBackendMetaData backend, QTableMetaData table, QRecord record, String path, byte[] contents)

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.sftp.model.metadata

Subclasses of QBackendMetaData in com.kingsrook.qqq.backend.module.filesystem.sftp.model.metadata

Modifier and Type	Class	Description
class	SFTPBackendMetaData	SFTP backend meta data.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.mongodb

Methods in com.kingsrook.qqq.backend.module.mongodb that return types with arguments of type QBackendMetaData

Modifier and Type	Method	Description
Class<? extends QBackendMetaData>	MongoDBBackendModule.getBackendMetaDataClass()	Method to identify the class used for backend meta data for this module.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.mongodb.model.metadata

Subclasses of QBackendMetaData in com.kingsrook.qqq.backend.module.mongodb.model.metadata

Modifier and Type	Class	Description
class	MongoDBBackendMetaData	Meta-data to provide details of a MongoDB backend (e.g., connection params)

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.postgres

Methods in com.kingsrook.qqq.backend.module.postgres that return types with arguments of type QBackendMetaData

Modifier and Type	Method	Description
Class<? extends QBackendMetaData>	PostgreSQLBackendModule.getBackendMetaDataClass()	Method to identify the class used for backend meta data for this module.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.postgres.model.metadata

Subclasses of QBackendMetaData in com.kingsrook.qqq.backend.module.postgres.model.metadata

Modifier and Type	Class	Description
class	PostgreSQLBackendMetaData	Meta-data to provide details of a PostgreSQL backend (e.g., connection params).

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.rdbms

Methods in com.kingsrook.qqq.backend.module.rdbms that return types with arguments of type QBackendMetaData

Modifier and Type	Method	Description
Class<? extends QBackendMetaData>	RDBMSBackendModule.getBackendMetaDataClass()	Method to identify the class used for backend meta data for this module.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.rdbms.actions

Methods in com.kingsrook.qqq.backend.module.rdbms.actions with parameters of type QBackendMetaData

Modifier and Type	Method	Description
protected void	AbstractRDBMSAction.setBackendMetaData(QBackendMetaData backendMetaData)	Setter for backendMetaData

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.rdbms.model.metadata

Subclasses of QBackendMetaData in com.kingsrook.qqq.backend.module.rdbms.model.metadata

Modifier and Type	Class	Description
class	RDBMSBackendMetaData	Meta-data to provide details of an RDBMS backend (e.g., connection params)

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.sqlite

Methods in com.kingsrook.qqq.backend.module.sqlite that return types with arguments of type QBackendMetaData

Modifier and Type	Method	Description
Class<? extends QBackendMetaData>	SQLiteBackendModule.getBackendMetaDataClass()	Method to identify the class used for backend meta data for this module.

Uses of QBackendMetaData in com.kingsrook.qqq.backend.module.sqlite.model.metadata

Subclasses of QBackendMetaData in com.kingsrook.qqq.backend.module.sqlite.model.metadata

Modifier and Type	Class	Description
class	SQLiteBackendMetaData	Meta-data to provide details of an SQLite backend (e.g., path to the database file)