overflowdb-codegen
API
Generated with
overflowdb-codegen/overflowdb.schema

overflowdb.schema

package overflowdb.schema

Members list

Concise view

Type members

Classlikes

abstract class AbstractNodeType(val name: String, val comment: Option[String], val schemaInfo: SchemaInfo) extends HasClassName with HasProperties with HasSchemaInfo

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class NodeType
case class AdjacentNode(viaEdge: EdgeType, neighbor: AbstractNodeType, cardinality: Cardinality, customStepName: Option[String], customStepDoc: Option[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
class AnyNodeType extends NodeBaseType

root node trait for all nodes - use if you want to be explicitly unspecific

root node trait for all nodes - use if you want to be explicitly unspecific

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
class Constant[A](val name: String, val value: String, val valueType: ValueType[A], val comment: Option[String], val schemaInfo: SchemaInfo) extends HasOptionalProtoId with HasSchemaInfo

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
object Constant

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class ContainedNode(nodeType: AbstractNodeType, localName: String, cardinality: Cardinality, comment: Option[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
class EdgeType(val name: String, val comment: Option[String], val schemaInfo: SchemaInfo) extends HasClassName with HasProperties with HasOptionalProtoId with HasSchemaInfo

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
object EdgeType

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
trait HasClassName

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class NodeType
class EdgeType
class Property[A]
trait HasOptionalProtoId

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Constant[A]
class EdgeType
class NodeType
class Property[A]
trait HasProperties

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class NodeType
class EdgeType
trait HasSchemaInfo

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class NodeType
class Constant[A]
class EdgeType
class Property[A]
case class MarkerTrait(name: String)

An empty trait without any implementation, e.g. to mark a semantic relationship between certain types

An empty trait without any implementation, e.g. to mark a semantic relationship between certain types

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class NeighborInfoForEdge(edge: EdgeType, nodeInfos: Seq[NeighborInfoForNode], offsetPosition: Int)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class NeighborInfoForNode(neighborNode: AbstractNodeType, edge: EdgeType, direction: Value, cardinality: Cardinality, isInherited: Boolean, customStepName: Option[String], customStepDoc: Option[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
class NodeBaseType(name: String, comment: Option[String], schemaInfo: SchemaInfo) extends AbstractNodeType

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class NodeType(name: String, comment: Option[String], schemaInfo: SchemaInfo) extends AbstractNodeType with HasOptionalProtoId

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
case class ProductElement(name: String, accessorSrc: String, index: Int)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
class Property[A](val name: String, val valueType: ValueType[A], val comment: Option[String], val schemaInfo: SchemaInfo) extends HasClassName with HasOptionalProtoId with HasSchemaInfo

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
object Property

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class ProtoOptions(pkg: String, javaOuterClassname: String, javaPackage: String, goPackage: String, csharpNamespace: String, uncommonProtoEnumNameMappings: Map[String, String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
class Schema(val domainShortName: String, val basePackage: String, val additionalTraversalsPackages: Seq[String], val properties: Seq[Property[_]], val anyNode: AnyNodeType, val nodeBaseTypes: Seq[NodeBaseType], val nodeTypes: Seq[NodeType], val edgeTypes: Seq[EdgeType], val constantsByCategory: Map[String, Seq[Constant[_]]], val protoOptions: Option[ProtoOptions], val noWarnList: Set[(AbstractNodeType, Property[_])])

Attributes

additionalTraversalsPackages:

additional packages that contain your traversals - used for .help to find @Doc annotations via reflection

basePackage:

specific for your domain, e.g. com.example.mydomain

Graph
Supertypes
class Object
trait Matchable
class Any
class SchemaBuilder(domainShortName: String, basePackage: String, additionalTraversalsPackages: Seq[String])

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
case class SchemaInfo(definedIn: Option[Class[_]])

carry extra information on where a schema element is being defined, e.g. when we want to be able to refer back that node XYZ was defined in BaseSchema, e.g. for documentation

carry extra information on where a schema element is being defined, e.g. when we want to be able to refer back that node XYZ was defined in BaseSchema, e.g. for documentation

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object SchemaInfo

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Generated with