Eclipse Platform
Release 3.3

org.eclipse.help.search
Interface XMLSearchParticipant.IParsedXMLContent

Enclosing interface:
XMLSearchParticipant

protected static interface XMLSearchParticipant.IParsedXMLContent

Class that implements this interface is used to store data obtained during the parsing phase.


Method Summary
 void addText(String text)
          Adds the text to the content buffer for indexing.
 void addToSummary(String summary)
          Sets the optional summary of the parsed document that can be later rendered for the search hits.
 String getLocale()
          Returns the locale of the index.
 void setTitle(String title)
          Sets the title of the parsed document for indexing.
 

Method Detail

getLocale

public String getLocale()
Returns the locale of the index.

Returns:
the locale string

setTitle

public void setTitle(String title)
Sets the title of the parsed document for indexing.

Parameters:
title - the document title

addToSummary

public void addToSummary(String summary)
Sets the optional summary of the parsed document that can be later rendered for the search hits.

Parameters:
summary - the short document summary

addText

public void addText(String text)
Adds the text to the content buffer for indexing.

Parameters:
text - the text to add to the document content buffer

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.