Home       Trees       Index       Help   

NXLucene

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

Type IXMLRPCLuceneServer

Interface --+
            |
           IXMLRPCLuceneServer

XML-RPC Lucene Server interface

This is used as an adapter to ILuceneServer instance.
Class Variable Summary
str xmlrpc_clean = 'Clear the whole indexes.\n\n        This...
str xmlrpc_getNumberOfDocuments = 'Return the amount of docu...
str xmlrpc_getStoreDir = 'Return the store dir location\n   ...
str xmlrpc_hasUID = 'Has the store a document having this UI...
str xmlrpc_indexDocument = 'Index a document\n\n        `uid...
str xmlrpc_optimize = 'Optmize the index store.\n        '
str xmlrpc_reindexDocument = 'Reindex a document\n\n        ...
str xmlrpc_search = 'Searching using Lucene native query.\n\...
str xmlrpc_searchQuery = 'Searching.\n\n        `xml_query` ...
str xmlrpc_unindexDocument = 'Unindex a document given its u...

Class Variable Details

xmlrpc_clean

Type:
str
Value:
'''Clear the whole indexes.

        This method removve *all* the indexes and documents from the s\
tore.
        '''

xmlrpc_getNumberOfDocuments

Type:
str
Value:
'''Return the amount of document within the indexes store.
        '''

xmlrpc_getStoreDir

Type:
str
Value:
'''Return the store dir location
        '''

xmlrpc_hasUID

Type:
str
Value:
'''Has the store a document having this UID ?
        '''

xmlrpc_indexDocument

Type:
str
Value:
'''Index a document

        `uid` is the key for this document.

        `xml_query` is an xml query containing the list of fields,
                    to index the document with and their properties.

        `b64` : xml_query compressed using base64 ?
...

xmlrpc_optimize

Type:
str
Value:
'''Optmize the index store.
        '''

xmlrpc_reindexDocument

Type:
str
Value:
'''Reindex a document

        `uid` is the key for this document.

        `xml_query` is an xml query containing the list of fields to
        reindex and their properties.

        `b64` : xml_query compressed using base64 ?
...

xmlrpc_search

Type:
str
Value:
'''Searching using Lucene native query.

        `query_str` : Lucene query string.

        For the Lucene query syntax see :
        http://lucene.apache.org/java/docs/queryparsersyntax.html
        '''

xmlrpc_searchQuery

Type:
str
Value:
'''Searching.

        `xml_query` should look like this :

        <search>
          <analyzer>standard</analyzer>
          <return_fields>
            <field>name</field>
...

xmlrpc_unindexDocument

Type:
str
Value:
'''Unindex a document given its uid.
        '''

   Home       Trees       Index       Help   

NXLucene

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