Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.help.search
Interface ISearchIndex


public interface ISearchIndex

Represents a Lucene index for one locale. The interface is used to allow participants to delegate indexing of documents outside of the TOC using the same algorithms as those in TOC.


Method Summary
  IStatus addDocument ( String pluginId, String name, URL url, String id, org.apache.lucene.document.Document doc)
          Adds a document to the search index by parsing it using one of the file-based search participants, or the default HTML search participant.
  String getLocale ()
          A search index is created for each locale.
 

Method Detail

addDocument

IStatus addDocument(
String pluginId,
                    
String name,
                    
URL url,
                    
String id,
                    org.apache.lucene.document.Document doc)
Adds a document to the search index by parsing it using one of the file-based search participants, or the default HTML search participant. Use this method when encountering documents outside of TOC that are nevertheless of the known format and help system knows how to handle.

Parameters:
pluginId - the id of the contributing plug-in
name - the name of the document
url - the URL of the document using format '/pluginId/href'
id - the unique id of this document as defined in the participant
doc - the Lucene document
Returns:
the status of the operation

getLocale

String getLocale()
A search index is created for each locale.

Returns:
the locale associated with this index.

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire