flockILucene Interface Reference

import "flockILucene.idl";

Inheritance diagram for flockILucene:


Public Member Functions
void	init (in nsIFile aIndexDir)
void	addDocument (in string aURI, in string aType, in AString aURL, in AString aTitle, in AString aTags, in AString aDescription, in AString aText, in flockILuceneIndexListener aLuceneIndexListener)
void	addDocumentSync (in string aURI, in string aType, in AString aURL, in AString aTitle, in AString aTags, in AString aDescription, in AString aText)
void	deleteDocument (in string aURI, in flockILuceneIndexListener aLuceneIndexListener)
void	deleteDocumentSync (in string aURI)
void	search (in AString aQuery, in string aType, in long aMaxResults, in flockILuceneSearchCallback aLuceneSearchCallback)

Detailed Description

This interface maintains and provides access to a Lucene indexer thread.

void flockILucene::addDocument	(	in string	aURI,
		in string	aType,
		in AString	aURL,
		in AString	aTitle,
		in AString	aTags,
		in AString	aDescription,
		in AString	aText,
		in flockILuceneIndexListener	aLuceneIndexListener
	)

Adds a document to the Lucene index. The request to do this will be dispatched to the worker thread for the actual indexing.

Parameters:

	aURI	the URI of the document to be indexed
	aType	the Flock Type of the document
	aURL	the URL of the document, if one exists
	aTitle	the title of the document
	aTags	comma delimited string of tags for the document, if any exist
	aDescription	notes or other out-of-band text attached to the document
	aText	the text of the document
	aLuceneListener	a listener to be called when the document has been added

void flockILucene::addDocumentSync	(	in string	aURI,
		in string	aType,
		in AString	aURL,
		in AString	aTitle,
		in AString	aTags,
		in AString	aDescription,
		in AString	aText
	)

Adds a document to the Lucene index synchronously. The request to do this will be dispatched to the worker thread for the actual indexing.

Parameters:

	aURI	the URI of the document to be indexed
	aType	the Flock Type of the document
	aURL	the URL of the document, if one exists
	aTitle	the title of the document
	aTags	comma delimited string of tags for the document, if any exist
	aDescription	notes or other out-of-band text attached to the document
	aText	the text of the document

void flockILucene::deleteDocument	(	in string	aURI,
		in flockILuceneIndexListener	aLuceneIndexListener
	)

Removes a document from the Lucene index.

Parameters:

	aURI	the URI of the document to be removed
	aLuceneListener	a listener to be called when the document has been deleted

void flockILucene::deleteDocumentSync ( in string aURI )

Removes a document from the Lucene index synchronously.

Parameters:

aURI

the URI of the document to be removed

void flockILucene::init ( in nsIFile aIndexDir )

Initialize the Lucene thread using the directory aIndexDir

Parameters:

aIndexDir

a Lucene index directory containing Lucene index files

void flockILucene::search	(	in AString	aQuery,
		in string	aType,
		in long	aMaxResults,
		in flockILuceneSearchCallback	aLuceneSearchCallback
	)

Searches the Lucene index.

Parameters:

	aQuery	a Lucene query string
	aType	a Flock Type to restrict the search to. NULL searches all types.
	aMaxResults	the maximum number of results to return
	aLuceneSearchCallback	flockILuceneSearchCallback interface to be called when the search is complete

The documentation for this interface was generated from the following file:

Generated on Thu Mar 18 15:53:04 2010 for Flock by

1.4.7