parser

Documentation

Overview

package parser allows extract elements from a query string and create Input object required for GNames faceted search.

Index

• func Pretty(pretty bool) func(*engine) error
• func Size(size int) func(*engine) error
• type Parser
  • func New() Parser

Functions

func Pretty

func Pretty(pretty bool) func(*engine) error

func Size

func Size(size int) func(*engine) error

Types

type Parser

type Parser interface {
	// ParseQuery takes a query string, parses it, registers warnings if
	// query is not well-formed, and packs received data into a search.Input
	// object.
	ParseQuery(q string) search.Input

	// Debug takes a query string, parses it, and prints aot an abstract
	// syntax tree of the parsed result. This method is used for developing
	// and debuging the parser behavior.
	Debug(string)
}

Parser contains methods for parsing a faceted search query for GNames.

func New

func New() Parser

New creates a new Parser object for converting a query string into search.Input object.