Home       Trees       Index       Help   

NXLucene

Package nxlucene :: Module interfaces :: Class ILuceneServer
[show private | hide private]
[frames | no frames]

Type ILuceneServer

Interface --+
            |
           ILuceneServer

Lucene server interface

This is the core lucene server definition.

See IXMLRPCLuceneServer for an example of ILuceneServer adaptation.
Class Variable Summary
str __len__ = 'Return the total amount of documents within t...
str clean = 'Clean the whole indexes store.\n\n        This ...
str getDocumentByUID = 'Return a PyLucene.document instance ...
str getIndexer = 'Return a nxlucene.LuceneIndexer instance. ...
str getReader = 'Return a nxlucene.LuceneReader instance. Se...
str getSearcher = 'Return a nxlucene.LuceneSearcher instance...
str getStore = 'Returns a store instance.\n\n        For the...
str indexDocument = 'Index a document.\n\n        `uid` : ui...
str optimize = 'Optimze the lucene indexes store\n\n        ...
unicode port = u'Port on which the server is listening'
str reindexDocument = 'Reindex a document.\n\n        `uid` ...
str searchQuery = 'Search results.\n        '
unicode store_dir = u'Directory where the lucene indexes are sto...
str unindexDocument = 'Unindex a document.\n\n        `uid` ...

Class Variable Details

__len__

Type:
str
Value:
'''Return the total amount of documents within the store.
        '''

clean

Type:
str
Value:
'''Clean the whole indexes store.

        This method will remove *all* the documents stored within the
        store.
        '''

getDocumentByUID

Type:
str
Value:
'''Return a PyLucene.document instance from the lucene store
        given its UID.

        It will return None of not found.
        '''

getIndexer

Type:
str
Value:
'''Return a nxlucene.LuceneIndexer instance. See ILuceneIndexer.
        '''

getReader

Type:
str
Value:
'''Return a nxlucene.LuceneReader instance. See ILuceneReader.
        '''

getSearcher

Type:
str
Value:
'''Return a nxlucene.LuceneSearcher instance. See ILuceneSearcher.
        '''

getStore

Type:
str
Value:
'''Returns a store instance.

        For the moment, it uses a FSDirectory instance only.
        '''

indexDocument

Type:
str
Value:
'''Index a document.

        `uid` : uid to use for this document. Note, here uid has
        nothing to do with the internal Lucene docid. It uses a Lucene
        Keyword field.

        `query_instance` : XML Query Instance
        '''

optimize

Type:
str
Value:
'''Optimze the lucene indexes store

        `indexer` : PyLucene.IndexWriter instance

        If `indexer` is not given as a parameter the internals of this
        function will create and close one to realize the
        optimization.
        '''

port

Type:
unicode
Value:
u'Port on which the server is listening'

reindexDocument

Type:
str
Value:
'''Reindex a document.

        `uid` : uid to use for this document. Note, here uid has
        nothing to do with the internal Lucene docid. It uses a Lucene
        Keyword field.

        `query_instance` : XML Query Instance
        '''

searchQuery

Type:
str
Value:
'''Search results.
        '''

store_dir

Type:
unicode
Value:
u'Directory where the lucene indexes are stored'

unindexDocument

Type:
str
Value:
'''Unindex a document.

        `uid` : uid of the target document.

        `lock` : boolean specifying if the store should be locked or
        not. May be useful if the method from which this is called
        already locked the store.
        '''

   Home       Trees       Index       Help   

NXLucene

Generated by Epydoc 2.1 on Fri Jun 30 16:38:47 2006 http://epydoc.sf.net