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:TextIndexDelete
Description:deletes a lucene index or item from index
Id:TextIndexDelete
Category:accessor
Identifier Syntax

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

Base
active:textIndexDelete

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

ArgumentRulesTypingDescription
operand
Optional
Representation (java.lang.Object)specification of items to delete
config
Optional
Identifieroptional configuration
directory
Optional
Identifierfilesystem 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 TextIndexDelete accessor you must import the module urn:org:netkernel:text:search:core:

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

The TextIndexDelete accessor will either delete specified items from a text index or delete the complete index. This depends upon the if an operand argument is supplied to qualify the delete.

Delete Index

If no operand argument is supplied to the accessor then the complete index specified either by the directory argument or the argument tag in the supplied config argument is permanently deleted.

Delete Items

If an operand argument is supplied it is sourced as an XML document which serves as definition of what is to be deleted. All tags within the document are located and specify a search term which will locate items to delete. One or multiple field tags may be specified. Each field tag must contain a nested name and value tag containing text. The name tag specifies the name of a field to search for, the value tag specifies the value that that field must have in order to be deleted. In order that items may be located for deleting it is useful that a "primary key" field is stored for each item. This field should be stored and indexed but not analysed.

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

<indexResult>
  <time>0.002</time>
  <count>-2</count>
</indexResult>

For example

<field>
  <name>documentId</name>
  <value>mydoc1</value>
</field>
or
<fields>
  <field>
    <name>documentId</name>
    <value>mydoc1</value>
  </field>
  <field>
    <name>documentId</name>
    <value>mydoc2</value>
  </field>
</fields>

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.