Eclipse Plug-in Developer Guide (Galileo) - XMLSearchParticipant.IParsedXMLContent (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.help.search
Interface XMLSearchParticipant.IParsedXMLContent

Enclosing class:: 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


String getLocale()

Returns the locale of the index.

Returns:: the locale string

setTitle

void setTitle(
String title)

Sets the title of the parsed document for indexing.

Parameters:: title - the document title

addToSummary

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

void addText(
String text)

Adds the text to the content buffer for indexing.

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