...
- https://onap.readthedocs.io/en/latest/submodules/aai/aai-common.git/docs/platform/Getting%20Started/Edge_Rules.html
- https://tinkerpop.apache.org/javadocs/3.3.2/core/org/apache/tinkerpop/gremlin/structure/Direction.html
- https://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html#valueOf(java.lang.String)
- Source code: aai/aai-common/aai-schema-ingest/src/main/java/org/onap/aai/edges/enums
- Source code: aai/aai-common/aai-core/src/main/java/org/onap/aai/serialization/db
- https://lists.onap.org/g/onap-discuss/message/11643
...
Example from documentation
Example | Equivalent Example | Explanation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| :the
|
| :
|
| :
|
|
| :traversal of
|
| traversal of
| :delete of
|
|
| How to read
| :delete of
| is prevented
|
| is prevented
|
General Applicability
- EdgeRules only apply to "relationship-list" relations in the schema, since the referenced object could be anything
- EdgeRules do no not apply to sub-component relations in the schema, since this is implicit and hard-coded behaviour
...
Field | Values | Notes |
---|---|---|
from | (literal string as entered in EdgeRule file) | Expected to match the "name" value of "xml-root-element" in OXM file. Note that the "from|to" pair is normalised in the code according to alphabetical order, so that "cousin pairs" with the "to|from" ordering in the EdgeRule are also grouped together, e.g.
Also note that the hyphens "-" are removed from the names before comparison, so the following would be equivalent:
|
to | (literal string as entered in EdgeRule file) | Expected to match the "name" value of "xml-root-element" in OXM file. Note that the "from|to" pair is normalised in the code according to alphabetical order, so that "cousin pairs" with the "to|from" ordering in the EdgeRule are also grouped together, e.g.
Also note that the hyphens "-" are removed from the names before comparison, so the following would be equivalent:
|
label | (literal string as entered in EdgeRule file) | By convention, appears to be one of:
|
direction |
| Based on and extended from https://tinkerpop.apache.org/javadocs/3.3.2/core/org/apache/tinkerpop/gremlin/structure/Direction.html Comparison is case-sensitive |
multiplicity |
| Comparison ignores case |
contains-other-v |
| This is an "edge property" that applies for specific traversal directionsto the other vertex. Comparison is case-sensitive Note that "opposite" means:
|
delete-other-v |
| This is an "edge property" that applies for specific traversal directionsto the other vertex. Comparison is case-sensitive Note that "opposite" means:
|
SVC-INFRA |
| This is an "edge property" that applies for specific traversal directionsto the other vertex. Comparison is case-sensitive Note that "opposite" means:
|
prevent-delete |
| This is an "edge property" that applies for specific traversal directionsto the other vertex. Comparison is case-sensitive Note that "opposite" means:
|
default |
| Default EdgeRule will apply when no other more specific rule applies ? Based on https://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html#valueOf(java.lang.String) Comparison ignores case |
description | (literal string as entered in EdgeRule file) | Optional for backwards compatibility with v12 and earlier (default value is empty string) The EdgeRule JSON format does not permit comments (presence of comments appears to make the parser skip entries in the file). |
Questions
- Is there a way to find/remove the unused/redundant EdgeRules from the json file?
- Is there any plan to simplify EdgeRules into an unambiguous canonical form (might be easier to read and write correctly)?
- How does the "default" property actually work? In v13, there are 226 EdgeRules with 224 having default "true" and 2 having default "false".