NetKernel Documentation - textIndexBatch

Endpoint

Name:	TextIndexBatch
Description:	adds multiple search results into a lucene index
Id:	TextIndexBatch
Category:	accessor

Identifier Syntax

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

Base
active:textIndexBatch

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

Argument	Rules	Typing	Description
operand	Mandatory	Representation (java.lang.Object)	specification of items to index
config	Optional	Identifier	optional configuration
directory	Optional	Identifier	filesystem location of index

Request Verbs

The following verb is supported:

Verb
SOURCE

Response

The response representation of this accessor for SOURCE requests is unknown.

This accessor throws no documented exceptions.

Import Requirements

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

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

View in Space Explorer

View Text Search Core Book

Adds a batch of items in one efficient operation.

The endpoint returns back an XML document summarizing time taken in seconds and number of items added:

<indexResult>
  <time>0.002</time>
  <count>10</count>
</indexResult>

operand argument

The operand contains a batch of items to be indexed and has the following form...

<batch>
  <item>...</item>
  <item>...</item>
</batch>

Where each item has the same form as for the regular active:textIndex.

directory argument

An optional URI to the directory containing the Lucene index. If not specified the index directory will be taken from the configuration

config argument

An optional reference to the configuration to use. If not specified then the tools look for a local configuration resource located at res:/etc/SearchConfig.xml. If this is not found a default configuration is used.