xmlquery

func Find ¶

func Find(top *Node, expr string) []*Node

Find is like QueryAll but panics if `expr` is not a valid XPath expression. See `QueryAll()` function.

func FindOne ¶

func FindOne(top *Node, expr string) *Node

FindOne is like Query but panics if `expr` is not a valid XPath expression. See `Query()` function.

func LoadURL ¶

func LoadURL(url string) (*Node, error)

LoadURL loads the XML document from the specified URL.

func Parse ¶

func Parse(r io.Reader) (*Node, error)

Parse returns the parse tree for the XML from the given Reader.

func ParseWithOptions ¶

func ParseWithOptions(r io.Reader, options ParserOptions) (*Node, error)

ParseWithOptions is like parse, but with custom options

func Query ¶

func Query(top *Node, expr string) (*Node, error)

Query searches the XML Node that matches by the specified XPath expr, and returns first matched element.

func QueryAll ¶

func QueryAll(top *Node, expr string) ([]*Node, error)

QueryAll searches the XML Node that matches by the specified XPath expr. Returns an error if the expression `expr` cannot be parsed.

func QuerySelector ¶

func QuerySelector(top *Node, selector *xpath.Expr) *Node

QuerySelector returns the first matched XML Node by the specified XPath selector.

func QuerySelectorAll ¶

func QuerySelectorAll(top *Node, selector *xpath.Expr) []*Node

QuerySelectorAll searches all of the XML Node that matches the specified XPath selectors.

func CreateXPathNavigator ¶

func CreateXPathNavigator(top *Node) *NodeNavigator

CreateXPathNavigator creates a new xpath.NodeNavigator for the specified XML Node.

func CreateStreamParser ¶

func CreateStreamParser(r io.Reader, streamElementXPath string, streamElementFilter ...string) (*StreamParser, error)

CreateStreamParser creates a StreamParser. Argument streamElementXPath is required. Argument streamElementFilter is optional and should only be used in advanced scenarios.

Scenario 1: simple case:

xml := `<AAA><BBB>b1</BBB><BBB>b2</BBB></AAA>`
sp, err := CreateStreamParser(strings.NewReader(xml), "/AAA/BBB")
if err != nil {
    panic(err)
}
for {
    n, err := sp.Read()
    if err != nil {
        break
    }
    fmt.Println(n.OutputXML(true))
}

Output will be:

<BBB>b1</BBB>
<BBB>b2</BBB>

Scenario 2: advanced case:

xml := `<AAA><BBB>b1</BBB><BBB>b2</BBB></AAA>`
sp, err := CreateStreamParser(strings.NewReader(xml), "/AAA/BBB", "/AAA/BBB[. != 'b1']")
if err != nil {
    panic(err)
}
for {
    n, err := sp.Read()
    if err != nil {
        break
    }
    fmt.Println(n.OutputXML(true))
}

Output will be:

<BBB>b2</BBB>

As the argument names indicate, streamElementXPath should be used for providing xpath query pointing to the target element node only, no extra filtering on the element itself or its children; while streamElementFilter, if needed, can provide additional filtering on the target element and its children.

CreateStreamParser returns an error if either streamElementXPath or streamElementFilter, if provided, cannot be successfully parsed and compiled into a valid xpath query.

func CreateStreamParserWithOptions ¶

func CreateStreamParserWithOptions(
	r io.Reader,
	options ParserOptions,
	streamElementXPath string,
	streamElementFilter ...string,
) (*StreamParser, error)

CreateStreamParserWithOptions is like CreateStreamParser, but with custom options