#include <DbXml.hpp>

bool XmlIndexSpecification::find(
    const std::string &uri, const std::string &name, std::string &index)

Description: XmlIndexSpecification::find

Returns the indexing strategies for a named document or metadata node. This method returns true if an index for the node is found; otherwise, it returns false.

See XmlIndexSpecification::addIndex for more information on index strategies.

Parameters

uri

The namespace of the node to be indexed. The default namespace is selected by passing an empty string for the namespace.

name

The name of the element or attribute node to be indexed.

index

A comma-separated list of strings that represent the indexing strategy. The strings must contain the following information in the following order:

unique-{path type}-{node type}-{key type}-{syntax}

where:

unique indicates that the indexed value is unique in the container. If this keyword does not appear on the index string, then the indexed value is not required to be unique in the container.

{path type} is either node or edge.

{node type} is one of element, attribute, or metadata. If metadata is specified, then {path type} must be node.

{key type} is one of presence, equality, or substring.

{syntax} identifies the type of information being indexed. It must be one of the following values:

• none
• base64Binary
• boolean
• date
• dateTime
• dayTimeDuration
• decimal
• double
• duration
• float
• gDay
• gMonth
• gMonthDay
• gYear
• gYearMonth
• hexBinary
• string
• time
• yearMonthDuration
• untypedAtomic

Note that if {key type} is presence, then {syntax} must be none or simply not specified.

For example, examples index strings are:

unique-node-element-presence

node-element-equality-string

edge-element-presence-none

node-element-equality-float