Liking cljdoc? Tell your friends :D

zuko.entity.reader

Reads structured data from a graph.

Reads structured data from a graph.
raw docstring

*nested-structs*clj/s

source

build-listclj/s

(build-list graph seen pairs)

Inputs: [graph :- GraphType seen :- #{NodeType} pairs :- [KeyValue]] Returns: [s/Any]

Takes property/value pairs and if they represent a list node, returns the list. else, nil.

Inputs: [graph :- GraphType seen :- #{NodeType} pairs :- [KeyValue]]
Returns: [s/Any]

Takes property/value pairs and if they represent a list node, returns the list.
 else, nil.
sourceraw docstring

check-structureclj/s

(check-structure graph prop v)

Inputs: [graph :- GraphType prop :- s/Any v :- s/Any] Returns: (s/maybe [KeyValue])

Determines if a value represents a structure. If so, return the property/values for it. Otherwise, return nil.

Inputs: [graph :- GraphType prop :- s/Any v :- s/Any]
Returns: (s/maybe [KeyValue])

Determines if a value represents a structure. If so, return the property/values for it.
 Otherwise, return nil.
sourceraw docstring

get-tg-firstclj/s

(get-tg-first struct)

Finds the tg/first property in a map, and gets the value.

Finds the tg/first property in a map, and gets the value.
sourceraw docstring

graph->entitiesclj/s≠

clj
(graph->entities graph)
(graph->entities graph nested?)
(graph->entities graph nested? exclusions)
cljs
(graph->entities G__6440)
(graph->entities G__6444 G__6445)
(graph->entities G__6449 G__6450 G__6451)

Inputs: ([graph :- GraphType] [graph :- GraphType nested? :- s/Bool] [graph :- GraphType nested? :- s/Bool exclusions :- (s/maybe #{s/Keyword})]) Returns: [EntityMap]

Pulls all top level entities out of a store

Inputs: ([graph :- GraphType] [graph :- GraphType nested? :- s/Bool] [graph :- GraphType nested? :- s/Bool exclusions :- (s/maybe #{s/Keyword})])
Returns: [EntityMap]

Pulls all top level entities out of a store
sourceraw docstring

ident->entityclj/s≠

clj
(ident->entity graph ident)
(ident->entity graph ident nested?)
cljs
(ident->entity G__6425 G__6426)
(ident->entity G__6430 G__6431 G__6432)

Inputs: ([graph :- GraphType ident :- s/Any] [graph :- GraphType ident :- s/Any nested? :- s/Bool]) Returns: EntityMap

Converts data in a database to a data structure suitable for JSON encoding Accepts an internal node identifier to identify the entity object

Inputs: ([graph :- GraphType ident :- s/Any] [graph :- GraphType ident :- s/Any nested? :- s/Bool])
Returns: EntityMap

Converts data in a database to a data structure suitable for JSON encoding
 Accepts an internal node identifier to identify the entity object
sourceraw docstring

into-multimapclj/s

(into-multimap kvs)

Inputs: [kvs :- [[(s/one s/Any "Key") (s/one s/Any "Value")]]]

Takes key/value tuples and inserts them into a map. If there are duplicate keys then create a set for the values.

Inputs: [kvs :- [[(s/one s/Any "Key") (s/one s/Any "Value")]]]

Takes key/value tuples and inserts them into a map. If there are duplicate keys then create a set for the values.
sourceraw docstring

MapOrListclj/s

source

NodeTypeclj/s

source

pairs->structclj/s≠

clj
(pairs->struct graph prop-vals)
(pairs->struct graph prop-vals seen)
cljs
(pairs->struct G__6376 G__6377)
(pairs->struct G__6381 G__6382 G__6383)

Inputs: ([graph :- GraphType prop-vals :- [KeyValue]] [graph :- GraphType prop-vals :- [KeyValue] seen :- #{NodeType}]) Returns: EntityMap

Uses a set of property-value pairs to load up a nested data structure from the graph

Inputs: ([graph :- GraphType prop-vals :- [KeyValue]] [graph :- GraphType prop-vals :- [KeyValue] seen :- #{NodeType}])
Returns: EntityMap

Uses a set of property-value pairs to load up a nested data structure from the graph
sourceraw docstring

property-valuesclj/s

(property-values graph entity)

Inputs: [graph :- GraphType entity :- s/Any] Returns: [KeyValue]

Return all the property/value pairs for a given entity in the store.

Inputs: [graph :- GraphType entity :- s/Any]
Returns: [KeyValue]

Return all the property/value pairs for a given entity in the store. 
sourceraw docstring

recurse-nodeclj/s

(recurse-node graph seen [prop v :as prop-val])

Inputs: [graph :- GraphType seen :- #{NodeType} [prop v :as prop-val] :- KeyValue] Returns: s/Any

Determines if the val of a map entry is a node to be recursed on, and loads if necessary. If referring directly to a top level node, then short circuit and return the ID

Inputs: [graph :- GraphType seen :- #{NodeType} [prop v :as prop-val] :- KeyValue]
Returns: s/Any

Determines if the val of a map entry is a node to be recursed on, and loads if necessary.
If referring directly to a top level node, then short circuit and return the ID
sourceraw docstring

ref->entityclj/s≠

clj
(ref->entity graph entity-id)
(ref->entity graph entity-id nested?)
(ref->entity graph entity-id nested? exclusions)
cljs
(ref->entity G__6402 G__6403)
(ref->entity G__6407 G__6408 G__6409)
(ref->entity G__6413 G__6414 G__6415 G__6416)

Inputs: ([graph :- GraphType entity-id :- s/Any] [graph :- GraphType entity-id :- s/Any nested? :- s/Bool] [graph :- GraphType entity-id :- s/Any nested? :- s/Bool exclusions :- (s/maybe #{(s/cond-pre s/Keyword s/Str)})]) Returns: EntityMap

Uses an id node to load up a nested data structure from the graph. Accepts a value that identifies the internal node.

Inputs: ([graph :- GraphType entity-id :- s/Any] [graph :- GraphType entity-id :- s/Any nested? :- s/Bool] [graph :- GraphType entity-id :- s/Any nested? :- s/Bool exclusions :- (s/maybe #{(s/cond-pre s/Keyword s/Str)})])
Returns: EntityMap

Uses an id node to load up a nested data structure from the graph.
 Accepts a value that identifies the internal node.
sourceraw docstring

vbuild-listclj/s

(vbuild-list graph seen pairs)

Inputs: [graph :- GraphType seen :- #{NodeType} pairs :- [KeyValue]] Returns: [s/Any]

Calls build-list, converting to a vector as the final step

Inputs: [graph :- GraphType seen :- #{NodeType} pairs :- [KeyValue]]
Returns: [s/Any]

Calls build-list, converting to a vector as the final step
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close