WARNING: This server provides a static reference view of the NetKernel documentation. Links to dynamic content do not work. For the best experience we recommend you install NetKernel and view the documentation in the live system .

Endpoint
Name:TextSearchEscape
Description:escapes a lucene search term
Id:TextSearchEscape
Category:accessor
Identifier Syntax

TextSearchEscape is an accessor using Active URI syntax with the following base identifiers:

Base
active:textSearchEscape

and the following arguments: (for more details on argument passing details see here)

ArgumentRulesTypingDescription
operand
Mandatory
Representation (java.lang.Object)search term to be escaped
Request Verbs

The following verb is supported:

Verb
SOURCE
Response

The following response representations can be returned for SOURCE requests:

SOURCE Representations
java.lang.String

This accessor throws no documented exceptions.

Import Requirements

To use TextSearchEscape accessor you must import the module urn:org:netkernel:text:search:core:

<import>
  <uri>urn:org:netkernel:text:search:core</uri>
</import>

Escapes a search string so that it does not clash with lucene specific query syntax.

operand argument

The operand should be transreptable to an IDeterminateStringRepresentation and is the query to be escaped.

Result

The response returns a String representation of the escaped query.

Example

A query such as "file:xxx" will be escaped to "file\:xxx"