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

Type IXMLSearchQuery

Interface --+
            |
           IXMLSearchQuery


XML Search Query

XML Custom query supported by NXLucene
Class Variable Summary
str getAnalyzerType = 'Get the analyzer to use for this quer...
str getReturnFields = 'Get field names that should come with...
str getSearchFields = 'Search fields configuration.\n\n     ...
str getSearchOptions = 'Search options.\n\n        XXX expli...

Class Variable Details

getAnalyzerType

Type:
str
Value:
'''Get the analyzer to use for this query.
        '''                                                            

getReturnFields

Type:
str
Value:
'''Get field names that should come with the results.

        Filter out stored values from Lucene record.

        Returns a tuple of strings representing the field names that
        are supposed to be returned.
        '''                                                            

getSearchFields

Type:
str
Value:
'''Search fields configuration.

        Returns a tuple of dictionnaries.

        XXX explicit about tne dict format.
        '''                                                            

getSearchOptions

Type:
str
Value:
'''Search options.

        XXX explicit
        '''                                                            

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