Search Processor

Identifier:
org.eclipse.help.searchProcessor

Since:
3.7

Description:
This extension point allows for processing steps to be performed when a user submits a help search.

Configuration Markup:

<!ELEMENT extension (processor)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED

>


<!ELEMENT processor EMPTY>

<!ATTLIST processor

class CDATA #REQUIRED

>


Examples:
Here is a sample directing processing to the class 'com.test.processor.SearchProcessor'


<extension
      point="org.eclipse.help.searchProcessor">
   <processor
         class="com.ibm.test.processor.SearchProcessor">
   </processor>
</extension>

API Information:
The supplied search processor class must extend the abstract class org.eclipse.help.AbstractSearchProcessor. The processor has the opportunity to modify a search string, provide alternate search expressions, or modify the search result set.

Supplied Implementation:
None.


Copyright (c) 2011 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html