json

package
v1.0.0-beta7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 3, 2021 License: Apache-2.0 Imports: 10 Imported by: 1

Documentation

Index

Constants

View Source
const JSON = "https://json.org#"

Variables

View Source
var ArrayTypeTerm = ls.NewTerm(JSON+"array", false, false, ls.OverrideComposition, nil)
View Source
var BooleanTypeTerm = ls.NewTerm(JSON+"boolean", false, false, ls.OverrideComposition, nil)
View Source
var IntegerTypeTerm = ls.NewTerm(JSON+"integer", false, false, ls.OverrideComposition, nil)
View Source
var NumberTypeTerm = ls.NewTerm(JSON+"number", false, false, ls.OverrideComposition, nil)
View Source
var ObjectTypeTerm = ls.NewTerm(JSON+"object", false, false, ls.OverrideComposition, nil)
View Source
var StringTypeTerm = ls.NewTerm(JSON+"string", false, false, ls.OverrideComposition, nil)

Functions

func DefaultBuildNodeKeyFunc

func DefaultBuildNodeKeyFunc(node ls.Node) (string, bool, error)

DefaultBuildNodeKeyFunc returns the attribute name term property from the node if it exists. If not, it looks at the attributeName of the node reached by instanceOf edge. If none found it return false

func Export

func Export(node ls.Node, options ExportOptions) (jsonom.Node, error)

Export the document subtree to the target. The returned result is OM, which respects element ordering

func GetBuildNodeKeyBySchemaNodeFunc

func GetBuildNodeKeyBySchemaNodeFunc(f func(schemaNode, docNode ls.Node) (string, bool, error)) func(ls.Node) (string, bool, error)

GetBuildNodeKeyBySchemaNodeFunc returns a function that gets the schema node and the doc node. If the doc node does not have a schema node, it is not exported. The function `f` should decide what key to use

func GetBuildNodeKeyExprFunc

func GetBuildNodeKeyExprFunc(closure gl.Closure) func(ls.Node) (string, bool, error)

GetBuildNodeKeyExprFunc returns a function that builds node keys using an expression. The expression should be a closure getting a node argument

func IngestBytes

func IngestBytes(ingester *Ingester, baseID string, input []byte) (ls.Node, error)

IngestBytes ingests JSON bytes

func IngestStream

func IngestStream(ingester *Ingester, baseID string, input io.Reader) (ls.Node, error)

IngestStream ingests JSON stream

Types

type CompiledEntity

type CompiledEntity struct {
	Entity
	Schema *jsonschema.Schema
}

CompiledEntity contains the JSON schema for the entity

func Compile

func Compile(entities []Entity) ([]CompiledEntity, error)

Compile all entities as a single unit.

func CompileWith

func CompileWith(compiler *jsonschema.Compiler, entities []Entity) ([]CompiledEntity, error)

CompileWith compiles all entities as a single unit using the given compiler

type Entity

type Entity struct {
	Name       string `json:"name"`
	Ref        string `json:"ref"`
	ID         string `json:"id"`
	SchemaName string `json:"schema"`
}

Entity gives an entity name to a location in a schema

func (Entity) GetEntityName

func (e Entity) GetEntityName() string

GetEntityName returns the ID if name is empty

type ErrCyclicSchema

type ErrCyclicSchema struct {
	Loop []*jsonschema.Schema
}

func (ErrCyclicSchema) Error

func (e ErrCyclicSchema) Error() string

type ErrInvalidBooleanValue

type ErrInvalidBooleanValue struct {
	NodeID string
	Value  string
}

func (ErrInvalidBooleanValue) Error

func (e ErrInvalidBooleanValue) Error() string

type ErrValueExpected

type ErrValueExpected struct {
	NodeID string
}

func (ErrValueExpected) Error

func (e ErrValueExpected) Error() string

type ExportOptions

type ExportOptions struct {
	// BuildNodeKeyFunc builds a node key from the node
	BuildNodeKeyFunc func(ls.Node) (string, bool, error)

	// If ExportTypeProperty is set, exports "@type" properties that
	// have non-LS related types
	ExportTypeProperty bool
}

ExportOptions are used to produce the output from the document

func (ExportOptions) BuildNodeKey

func (options ExportOptions) BuildNodeKey(node ls.Node) (string, bool, error)

type ImportedEntity

type ImportedEntity struct {
	Entity CompiledEntity

	Layer *ls.Layer `json:"-"`
}

func CompileAndImport

func CompileAndImport(entities []Entity) ([]ImportedEntity, error)

CompileAndImport compiles the given entities and imports them as layers

func Import

func Import(entities []CompiledEntity) ([]ImportedEntity, error)

Import a JSON schema

A JSON schema may include many object definitions. This import algorithm creates a schema for each entity.

type Ingester

type Ingester struct {
	ls.Ingester

	Interner ls.Interner
}

Ingester converts a JSON object model into a graph using a schema

func (*Ingester) Ingest

func (ingester *Ingester) Ingest(baseID string, input jsonom.Node) (ls.Node, error)

Ingest a json document using the schema. The output will have all input nodes associated with schema nodes.

BaseID is the ID of the root object. All other attribute names are generated by appending the attribute path to baseID

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL