graph

type Backend interface {
	Type() string
	Connect(options map[string]string) error
	Ready(options map[string]string) (bool, error)
	Schema(options map[string]string) (Schema, error)
	OperationDefinitions(options map[string]string) ([]operations.OperationDefinition, error)
	FilterFunctions(options map[string]string) ([]FilterFunctionDefinition, error)
	Validate(chain OperationChain, options map[string]string) error
	Execute(chain OperationChain, options map[string]string) (QueryResponse, error)
	NewEntity(group string, vertex string, properties map[string]interface{}) *elements.Entity
	NewEdge(group string, source string, destination string, directed bool, properties map[string]interface{}) *elements.Edge
}

type Feature struct {
	Id           interface{}            `json:"id" bson:"id" yaml:"id" hcl:"id"`
	Type         string                 `json:"type" bson:"type" yaml:"type" hcl:"type"`
	Properties   map[string]interface{} `json:"properties" bson:"properties" yaml:"properties" hcl:"properties"`
	GeometryName string                 `json:"geometry_name" bson:"geometry_name" yaml:"geometry_name" hcl:"geometry_name"`
	Geometry     Geometry               `json:"geometry" bson:"geometry" yaml:"geometry" hcl:"geometry"`
}

type FeatureCollection struct {
	Type          string    `json:"type" bson:"type" yaml:"type" hcl:"type"`
	TotalFeatures int       `json:"totalFeatures" bson:"totalFeatures" yaml:"totalFeatures" hcl:"totalFeatures"`
	Features      []Feature `json:"features" bson:"features" yaml:"features" hcl:"features"`
}

type FilterFunctionDefinition struct {
	Class string `json:"class" bson:"class" yaml:"class" hcl:"class"`
}

type Geometry struct {
	Type        string      `json:"type" bson:"type" yaml:"type" hcl:"type"`
	Coordinates interface{} `json:"coordinates" bson:"coordinates" yaml:"coordinates" hcl:"coordinates"`
}

type Operation interface {
	GetTypeName() string
	Validate(schema Schema) error
	Sgol() (string, error)
}

type OperationChain interface {
	GetName() string
	Validate(schema Schema) error
	GetOperations() []Operation
	GetFirstOperation() (Operation, error)
	GetLastOperation() (Operation, error)
	GetLimit() int
	GetOutputType() string
	Hash() (string, error)
	Sgol() (string, error)
}

type Parser interface {
	ParseQuery(q string) (OperationChain, error)
}

type QueryResponse struct {
	Success bool         `json:"success" bson:"success" yaml:"success" hcl:"success"`
	Message string       `json:"message" bson:"message" yaml:"message" hcl:"message"`
	Query   string       `json:"query" bson:"query" yaml:"query" hcl:"query"`
	Results QueryResults `json:"results" bson:"results" yaml:"results" hcl:"results"`
}

type QueryResults struct {
	Entities []elements.Entity `json:"entities,omitempty" bson:"entities" yaml:"entities,omitempty" hcl:"entities"`
	Edges    []elements.Edge   `json:"edges,omitempty" bson:"edges" yaml:"edges,omitempty" hcl:"edges"`
}

type Schema interface {
	GetEntityGroupNames() []string
	GetEdgeGroupNames() []string
	GetTypeNames() []string
	ContainsGroups(groups []string) bool
	ContainsEntities(entities []string) bool
	ContainsEdges(edges []string) bool
	GetEntityPropertyNames(entity string) []string
	//GetEntityPropertyType(entity string, propertyName string) string
	GetEntityPropertyTypes(group string) map[string]string
	GetEdgePropertyNames(edge string) []string
	GetEdgePropertyTypes(group string) map[string]string
	//GetEdgePropertyType(edge string, propertyName string) string
	Json() (string, error)
	Yaml() (string, error)
}