contactql

package

v0.23.0 Latest Latest Go to latest Published: Oct 25, 2018 License: AGPL-3.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/dsmagicug/goflow

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func EvaluateQuery(env utils.Environment, query *ContactQuery, queryable Queryable) (bool, error)
func NewErrorListener() *errorListener
type BoolCombination
- func NewBoolCombination(op boolOp, children ...QueryNode) *BoolCombination
- func (b *BoolCombination) Evaluate(env utils.Environment, queryable Queryable) (bool, error)
- func (b *BoolCombination) String() string
type Condition
- func (c *Condition) Evaluate(env utils.Environment, queryable Queryable) (bool, error)
- func (c *Condition) String() string
type ContactQuery
- func ParseQuery(text string) (*ContactQuery, error)
- func (q *ContactQuery) Evaluate(env utils.Environment, queryable Queryable) (bool, error)
- func (q *ContactQuery) String() string
type QueryNode
type Queryable
type Visitor
- func NewVisitor() *Visitor

Constants ¶

View Source

const (
	ImplicitKey string = "*"
)

Variables ¶

This section is empty.

Functions ¶

func EvaluateQuery ¶

func EvaluateQuery(env utils.Environment, query *ContactQuery, queryable Queryable) (bool, error)

func NewErrorListener ¶ added in v0.6.2

func NewErrorListener() *errorListener

Types ¶

type BoolCombination ¶

type BoolCombination struct {
	// contains filtered or unexported fields
}

BoolCombination is a AND or OR combination of multiple conditions

func NewBoolCombination ¶

func NewBoolCombination(op boolOp, children ...QueryNode) *BoolCombination

NewBoolCombination creates a new boolean combination

func (*BoolCombination) Evaluate ¶

func (b *BoolCombination) Evaluate(env utils.Environment, queryable Queryable) (bool, error)

Evaluate returns whether this combination evaluates to true or false

func (*BoolCombination) String ¶

func (b *BoolCombination) String() string

type Condition ¶

type Condition struct {
	// contains filtered or unexported fields
}

Condition represents a comparison between a keywed value on the contact and a provided value

func (*Condition) Evaluate ¶

func (c *Condition) Evaluate(env utils.Environment, queryable Queryable) (bool, error)

Evaluate evaluates this condition against the queryable contact

func (*Condition) String ¶

func (c *Condition) String() string

type ContactQuery ¶

type ContactQuery struct {
	// contains filtered or unexported fields
}

func ParseQuery ¶

func ParseQuery(text string) (*ContactQuery, error)

ParseQuery parses a ContactQL query from the given input

func (*ContactQuery) Evaluate ¶

func (q *ContactQuery) Evaluate(env utils.Environment, queryable Queryable) (bool, error)

func (*ContactQuery) String ¶

func (q *ContactQuery) String() string

type QueryNode ¶

type QueryNode interface {
	fmt.Stringer

	Evaluate(utils.Environment, Queryable) (bool, error)
}

QueryNode is the base for nodes in our query parse tree

type Queryable ¶

type Queryable interface {
	ResolveQueryKey(utils.Environment, string) []interface{}
}

type Visitor ¶

type Visitor struct {
	gen.BaseContactQLVisitor
}

func NewVisitor ¶

func NewVisitor() *Visitor

NewVisitor creates a new ContactQL visitor

func (*Visitor) Visit ¶

func (v *Visitor) Visit(tree antlr.ParseTree) interface{}

Visit the top level parse tree

func (*Visitor) VisitCombinationAnd ¶

func (v *Visitor) VisitCombinationAnd(ctx *gen.CombinationAndContext) interface{}

expression : expression AND expression

func (*Visitor) VisitCombinationImpicitAnd ¶

func (v *Visitor) VisitCombinationImpicitAnd(ctx *gen.CombinationImpicitAndContext) interface{}

expression : expression expression

func (*Visitor) VisitCombinationOr ¶

func (v *Visitor) VisitCombinationOr(ctx *gen.CombinationOrContext) interface{}

expression : expression OR expression

func (*Visitor) VisitCondition ¶

func (v *Visitor) VisitCondition(ctx *gen.ConditionContext) interface{}

expression : TEXT COMPARATOR literal

func (*Visitor) VisitExpressionGrouping ¶

func (v *Visitor) VisitExpressionGrouping(ctx *gen.ExpressionGroupingContext) interface{}

expression : LPAREN expression RPAREN

func (*Visitor) VisitImplicitCondition ¶

func (v *Visitor) VisitImplicitCondition(ctx *gen.ImplicitConditionContext) interface{}

expression : TEXT

func (*Visitor) VisitParse ¶

func (v *Visitor) VisitParse(ctx *gen.ParseContext) interface{}

parse: expression

func (*Visitor) VisitStringLiteral ¶

func (v *Visitor) VisitStringLiteral(ctx *gen.StringLiteralContext) interface{}

literal : STRING

func (*Visitor) VisitTextLiteral ¶

func (v *Visitor) VisitTextLiteral(ctx *gen.TextLiteralContext) interface{}

literal : TEXT

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
gen

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