mirror of
https://github.com/Kingsrook/qqq.git
synced 2025-07-18 05:01:07 +00:00
Add some asciidocs that haven't been previously committed
This commit is contained in:
20
docs/metaData/Icons.adoc
Normal file
20
docs/metaData/Icons.adoc
Normal file
@ -0,0 +1,20 @@
|
||||
[#Icons]
|
||||
== Icons
|
||||
include::../variables.adoc[]
|
||||
|
||||
#TODO#
|
||||
|
||||
=== QIcon
|
||||
Icons are defined in a QQQ Instance in a `*QIcon*` object.
|
||||
|
||||
#TODO#
|
||||
|
||||
*QIcon Properties:*
|
||||
|
||||
* `name` - *String* - Name of an icon from the https://mui.com/material-ui/material-icons/[Material UI Icon set]
|
||||
** Note that icon names from the link above need to be converted from _CamelCase_ to _underscore_case_...
|
||||
* `path` - *String* - Path to a file served under the application's web root, to be used as the icon.
|
||||
|
||||
_Either `name` or `path` must be specified. If both are given, then name is used._
|
||||
|
||||
|
13
docs/metaData/PermissionRules.adoc
Normal file
13
docs/metaData/PermissionRules.adoc
Normal file
@ -0,0 +1,13 @@
|
||||
[#PermissionRules]
|
||||
== Permission Rules
|
||||
include::../variables.adoc[]
|
||||
|
||||
#TODO#
|
||||
|
||||
=== PermissionRule
|
||||
#TODO#
|
||||
|
||||
*PermissionRule Properties:*
|
||||
|
||||
#TODO#
|
||||
|
39
docs/metaData/QInstance.adoc
Normal file
39
docs/metaData/QInstance.adoc
Normal file
@ -0,0 +1,39 @@
|
||||
[#QInstance]
|
||||
== QInstance
|
||||
include::../variables.adoc[]
|
||||
|
||||
An application in QQQ is defined as a set of Meta Data objects. These objects are all stored together in an object called a `*QInstance*`.
|
||||
|
||||
Currently, a `QInstance` must be programmatically constructed in java code - e.g., by constructing objects which get added to the QInstance, for example:
|
||||
|
||||
[source,java]
|
||||
.Adding meta-data for two tables and one process to a QInstance
|
||||
----
|
||||
QInstance qInstance = new QInstance();
|
||||
qInstance.addTable(definePersonTable());
|
||||
qInstance.addTable(defineHomeTable());
|
||||
qInstance.addProcess(defineSendPersonHomeProcess());
|
||||
----
|
||||
|
||||
It is on the QQQ roadmap to allow meta-data to be defined in a non-programmatic way, for example, in YAML or JSON files, or even from a dynamic data source (e.g. a document or relational database).
|
||||
|
||||
The middleware and/or frontends being used in an application will drive how the `QInstance` is connected to the running server/process.
|
||||
For example, using the `qqq-middleware-javalin` module, a the `QJavalinImplementation` class () has a constructor which takes a `QInstance` as an argument:
|
||||
|
||||
[source,java]
|
||||
.Starting a QQQ Javalin middleware server - passing a QInstance as a parameter to the new QJavalinImplementation
|
||||
----
|
||||
QJavalinImplementation qJavalinImplementation = new QJavalinImplementation(qInstance);
|
||||
Javalin service = Javalin.create();
|
||||
service.routes(qJavalinImplementation.getRoutes());
|
||||
service.start();
|
||||
----
|
||||
|
||||
*QBackendMetaData Setup Methods:*
|
||||
|
||||
These are the methods that one is most likely to use when setting up (defining) a `QInstance` object:
|
||||
|
||||
* asdf
|
||||
|
||||
*QBackendMetaData Usage Methods:*
|
||||
|
Reference in New Issue
Block a user