cpg-neo4j/de.fraunhofer.aisec.cpg_vis_neo4j/Schema

Schema

class Schema

Constructors

Schema

constructor()

Types

Format

enum Format : Enum<Schema.Format>

Output format of the CPG Schema description.

SchemaNode

data class SchemaNode(val name: String, val isAbstract: Boolean, val labels: Set<String>, val childLabels: Set<String>, val relationships: Set<Schema.SchemaRelationship>, val properties: Set<Schema.SchemaProperty>)

Schema definition for node entities that is persisted to the neo4j database

SchemaProperty

data class SchemaProperty(val name: String, val valueType: String, val inherited: Boolean)

Key-value pair defining a node property and if the property was inherited from a parent node entity type or newly introduced in this node entity.

SchemaRelationship

data class SchemaRelationship(val label: String, val targetNode: String, val multiplicity: Char, val inherited: Boolean)

Definition of a CPG relationship with relationship label, the targeted node and whether the node has multiple or a single relationship edge of the declared type.

Functions

extractSchema

fun extractSchema()

Extracts information on the nodes and edges that can be persisted to the neo4 database over the OGM.

printToFile

fun printToFile(fileName: String, format: Schema.Format)

Depending on the specified output format the Neo4j Schema for the CPG is printed to the specified file.