RunQuery

Version 0.0.1 Id: d7ed7d up 142.5 days Healthz 33.0 MB I Index N Node browser U DocTest editor T Run all DocTests

Quick search:

Click 'Run DocTest' below in order to run this DocTest

# Documentation for SharpOntologyGraph's DocTest mechanism and SOGT syntax (Sharp Ontology Graph Test).

# The basics
# ==========

# Create something:
/createInstance/sog_test:TestItem/My_TestItem1

# Query the result:
/node/{My_TestItem1}

# Assert the result:
ASSERT "label": "sog_test:TestItem", "id": "{My_TestItem1}", "name": "My_TestItem1", "description": null, "properties": {}, "relations": [] }

# Shorter version (to be explained below):
/ci/TestItem
/node
ASSERT "name": "My_sog_test:TestItem"

# Create instance with description
/ci/sog_test:TestItem/My_TestItem3/Some description
/node
ASSERT "description": "Some description"

# Create instance, then set properties
/ci/TestItemSimple/TestItem4
/setProperty//Integer1/1
# Or shorted like /sp
/sp//Integer2/2
/sp//Integer3/3
/node
ASSERT "Integer1": "1"
ASSERT "Integer2": "2"
ASSERT "Integer3": "3"

# Create instance with properties in one go
# Note: Space in field for description is treated as null value.
# Note: The space is optional for DocTests (since they are parsed through RESTAPIOperation) 
# Note: but obligatory for direct API HTTP calls.
/ci/TestItemSimple/Test5/ /{ "Integer1": "1", "Integer2": "2", "Integer3": "3" }
/node
ASSERT "Integer1": "1"
ASSERT "Integer2": "2"
ASSERT "Integer3": "3"

# Null values are only allowed if "allowNull" is specified in the schema. This applies to Integer3.
/ci/TestItemSimple/Test6/ /{ "Integer1": "1", "Integer2": "2", "Integer3": null }
/node
ASSERT "Integer1": "1"
ASSERT "Integer2": "2"
ASSERT "Integer3": null

# Create instance, then set relations.
/ci/TestCollectionSimple/Collection7
/ci/TestItemSimple/Test7
# This can be shorted as "cr" instead of "createRelation"
/createRelation/{Test7}/composes/{Collection7}
/node
ASSERT "relations": [{ "fromId": "{Test7}", "relationType": "sog:composes", "toId": "{Collection7}"

# Create instance with relations in one go.
# Note empty field for both description and properties (treated as null value as explained above).
/ci/TestCollectionSimple/Collection8
/ci/TestItemSimple/Test8///composes/{Collection8}
/node
ASSERT "relations": [{ "fromId": "{Test8}", "relationType": "sog:composes", "toId": "{Collection8}"

# Shorter version (deducing what relation to use and to which entity (the {last} one)
/ci/TestCollectionSimple/Collection9
/ci/TestItemSimple/Test9////
/node
ASSERT "relations": [{ "fromId": "{Test9}", "relationType": "sog:composes", "toId": "{Collection9}"

# Primary key placeholders 
# ========================

# When nodes are created their name is used as a primary key placeholder, 
# meaning you can use {name} instead of the real InstanceId for later querying.
# So the name "My_TestItem9" becomes the primary key placeholder "{My_TestItem9}" 
# which you can later use in queries.

/ci/sog_test:TestItem/My_TestItem10
/node/{My_TestItem10}
ASSERT "id": "{My_TestItem10}"

# Primary key placeholder {last} refers to last instance created:
/ci/sog_test:TestItem/My_TestItem11
/node/{last}
ASSERT "id": "{My_TestItem11}"

# Or you can leave it out altogether (as already shown):
/ci/sog_test:TestItem/My_TestItem12
/node
ASSERT "id": "{My_TestItem12}"

# Note that the DocTest mechanism "automagically" translates back and forth 
# between the primary key placeholder and its value.
# This also includes error messages.

# Operations have short names
# ===========================
# Using /ci instead of /createInstance
/ci/sog_test:TestItem/My_TestItem13
# The same applies to /cr for /createRelation, /sp for /setProperty and /rp for /removeProperty

# Classes can be specified without "domain"
# =========================================
/ci/TestItem/My_TestItem14
# This is equivalent of
/ci/sog_test:TestItem/My_TestItem14

# Names can be created automatically
# ==================================
# You can leave out the {name} parameter. "My_" + class name will be used automatically.

/ci/TestItem
/node/{My_sog_test:TestItem}
ASSERT "label": "sog_test:TestItem", "id": "{My_sog_test:TestItem}", "name": "My_sog_test:TestItem", "description": null, "properties": {}, "relations": [] }

# Owl class names are often not case sensitive
# ============================================
/ci/testitem

# Primary key placeholders overwrite each other
# =============================================
# In the examples above names like My_TestItem1 / My_TestItem2 and so on were used.
# If duplicate names had been used there would be corresponding duplicates 
# of the corresponding Primary key placeholders.
# In such cases the final result will only refer to the last one created (old ones are overwritten).

# JSON instead of URL format
# ==========================
# Instead of doing
RAW /ci/TestItem/My_TestItem15/URL:%0D%0Ahttps:%2F%2Fsomewhere.com
# one can use a JSON format like
["ci", "TestItem", "My_TestItem16", "URL:\r\nhttps://somewhere.com"]
# (that is, the encoding becomes is little bit simpler)

# Multiline is also allowed, with comments and trailing commas
[
"ci", 
"TestItem", 
"My_TestItem17",
// JSON comment
"URL:\r\nhttps://somewhere.com",
]