Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
jio
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Yaxel Perez
jio
Commits
d5d14455
Commit
d5d14455
authored
Nov 17, 2013
by
Marco Mariani
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: added complex_queries, developers, gid_storage, naming_conventions
parent
e85c91a2
Changes
5
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
616 additions
and
5 deletions
+616
-5
docs/sphinx/source/complex_queries.rst
docs/sphinx/source/complex_queries.rst
+107
-3
docs/sphinx/source/developers.rst
docs/sphinx/source/developers.rst
+1
-1
docs/sphinx/source/gid_storage.rst
docs/sphinx/source/gid_storage.rst
+1
-1
docs/sphinx/source/index.rst
docs/sphinx/source/index.rst
+1
-0
docs/sphinx/source/naming_conventions.rst
docs/sphinx/source/naming_conventions.rst
+506
-0
No files found.
docs/sphinx/source/complex_queries.rst
View file @
d5d14455
...
...
@@ -222,8 +222,112 @@ JSON Schemas and Grammar
Below you can find schemas for constructing complex queries
* `Complex Queries JSON Schema <http://www.j-io.org/jio-Complex.Queries.JSON.Schema>`_
* `Simple Queries JSON Schema <http://www.j-io.org/jio-Simple.Queries.JSON.Schema>`_
* `Complex Queries Grammar <http://www.j-io.org/jio-Complex.Queries.Grammar>`_
* Complex Queries JSON Schema:
.. code-block:: javascript
{
"id": "ComplexQuery",
"properties": {
"type": {
"type": "string",
"format": "complex",
"default": "complex",
"description": "The type is used to recognize the query type."
},
"operator": {
"type": "string",
"format": "(AND|OR|NOT)",
"required": true,
"description": "Can be 'AND', 'OR' or 'NOT'."
},
"query_list": {
"type": "array",
"items": {
"type": "object"
},
"required": true,
"default": [],
"description": "query_list is a list of queries which can be in serialized format of in object format."
}
}
}
* Simple Queries JSON Schema:
.. code-block:: javascript
{
"id": "SimpleQuery",
"properties": {
"type": {
"type": "string",
"format": "simple",
"default": "simple",
"description": "The type is used to recognize the query type."
},
"operator": {
"type": "string",
"default": "=",
"format": "(>=?|<=?|!?=)",
"description": "The operator used to compare."
},
"id": {
"type": "string",
"default": "",
"description": "The column id."
},
"value": {
"type": "string",
"default": "",
"description": "The value we want to search."
}
}
}
* Complex Queries Grammar::
search_text
: and_expression
| and_expression search_text
| and_expression OR search_text
and_expression
: boolean_expression
| boolean_expression AND and_expression
boolean_expression
: NOT expression
| expression
expression
: ( search_text )
| COLUMN expression
| value
value
: OPERATOR string
| string
string
: WORD
| STRING
terminal:
OR -> /OR[ ]/
AND -> /AND[ ]/
NOT -> /NOT[ ]/
COLUMN -> /[^><= :\(\)"][^ :\(\)"]*:/
STRING -> /"(\\.|[^\\"])*"/
WORD -> /[^><= :\(\)"][^ :\(\)"]*/
OPERATOR -> /(>=?|<=?|!?=)/
LEFT_PARENTHESE -> /\(/
RIGHT_PARENTHESE -> /\)/
ignore: " "
docs/sphinx/source/developers.rst
View file @
d5d14455
...
...
@@ -21,7 +21,7 @@ plus the storages and dependencies you need and you will be good to go.
Naming Conventions
------------------
All the code follows this
`Javascript Naming Conventions <http://www.j-io.org/Javascript-Naming_Conventions>`_
.
All the code follows this
:ref:`Javascript Naming Conventions <naming-conventions>`
.
How to design your own jIO Storage Library
------------------------------------------
...
...
docs/sphinx/source/gid_storage.rst
View file @
d5d14455
...
...
@@ -97,7 +97,7 @@ metadata can contain several values. Example:
// or
"key": ["value1", "value2"],
// or
"key": {"attribute name": "attribute value", "content": "value
'
},
"key": {"attribute name": "attribute value", "content": "value
"
},
// or
"key": [
{"scheme": "DCTERMS.URI", "content": "http://foo.com/bar"},
...
...
docs/sphinx/source/index.rst
View file @
d5d14455
...
...
@@ -19,6 +19,7 @@ Contents:
complex_queries
metadata
developers
naming_conventions
authors
license
...
...
docs/sphinx/source/naming_conventions.rst
0 → 100644
View file @
d5d14455
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment