ilLuceneSearcher Class Reference

Reads and parses lucene search results. More...

Collaboration diagram for ilLuceneSearcher:

Public Member Functions
	setType ($a_type)
	Set search type. More...
	getType ()
	Get type. More...
	search ()
	Search. More...
	highlight ($a_obj_ids)
	Highlight/Detail query. More...
	nextResultPage ()
	get next result page More...
	getHighlighter ()
	get highlighter More...
	getResult ()
	Get result. More...
	getPageNumber ()
	get current page number More...

Static Public Member Functions
static	getInstance (ilLuceneQueryParser $qp)
	Get singleton instance. More...

Data Fields
const	TYPE_STANDARD = 1
const	TYPE_USER = 2

Protected Member Functions
	performSearch ()
	search lucene More...

Private Member Functions
	__construct ($qp)
	Constructor. More...

Private Attributes
	$query_parser = null
	$result = null
	$highlighter = null
	$page_number = 1
	$type = self::TYPE_STANDARD

Static Private Attributes
static	$instance = null

Detailed Description

Reads and parses lucene search results.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 35 of file class.ilLuceneSearcher.php.

Constructor & Destructor Documentation

__construct()

ilLuceneSearcher::__construct (   $qp )

private

Constructor.

Parameters

object

ilLuceneQueryParser

Returns

ilLuceneSearcher

Definition at line 53 of file class.ilLuceneSearcher.php.

    {
        $this->result = new ilLuceneSearchResult();
        $this->result->setCallback(array($this,'nextResultPage'));
        $this->query_parser = $qp;
    }

Member Function Documentation

getHighlighter()

ilLuceneSearcher::getHighlighter

(

)

get highlighter

Returns

ilLuceneHighlightResultParser

Definition at line 159 of file class.ilLuceneSearcher.php.

References $highlighter.

    {
        return $this->highlighter;
    }

getInstance()

static ilLuceneSearcher::getInstance ( ilLuceneQueryParser  $qp )

static

Get singleton instance.

Parameters

object

ilLuceneQueryParser

Returns

ilLuceneSearcher

Definition at line 67 of file class.ilLuceneSearcher.php.

Referenced by ilSearchAutoComplete\getLuceneList(), ilRepositoryObjectDetailSearch\performLuceneSearch(), ilLuceneUserSearchGUI\performSearch(), ilLuceneAdvancedSearchGUI\performSearch(), ilLuceneSearchGUI\performSearch(), ilSoapObjectAdministration\searchObjects(), ilLuceneAdvancedSearchGUI\showSavedResults(), and ilLuceneSearchGUI\showSavedResults().

    {
        if (self::$instance) {
            return self::$instance;
        }
        return self::$instance = new ilLuceneSearcher($qp);
    }

Here is the caller graph for this function:

getPageNumber()

ilLuceneSearcher::getPageNumber

(

)

get current page number

Parameters

Definition at line 182 of file class.ilLuceneSearcher.php.

References $page_number.

Referenced by performSearch().

    {
        return $this->page_number;
    }

Here is the caller graph for this function:

getResult()

ilLuceneSearcher::getResult

(

)

Get result.

Parameters

Definition at line 169 of file class.ilLuceneSearcher.php.

References $result.

    {
        if ($this->result instanceof ilLuceneSearchResult) {
            return $this->result;
        }
        // TODO Error handling
    }

getType()

ilLuceneSearcher::getType

(

)

Get type.

Returns

int

Definition at line 88 of file class.ilLuceneSearcher.php.

References $type.

Referenced by performSearch().

    {
        return $this->type;
    }

Here is the caller graph for this function:

highlight()

ilLuceneSearcher::highlight

(

$a_obj_ids

)

Highlight/Detail query.

Parameters

array

$a_obj_ids

Arry of obj_ids

Returns

object ilLuceneHighlightResultParser

Definition at line 108 of file class.ilLuceneSearcher.php.

References $DIC, $highlighter, $ilBench, $ilSetting, $res, ilRpcClientFactory\factory(), and ilLoggerFactory\getLogger().

    {
        global $DIC;

        $ilBench = $DIC['ilBench'];
        $ilSetting = $DIC['ilSetting'];

        include_once './Services/Search/classes/Lucene/class.ilLuceneHighlighterResultParser.php';
        
        // TODO error handling
        if (!$this->query_parser->getQuery()) {
            return;
        }
        
        // Search in combined index
        $ilBench->start('Lucene', 'SearchHighlight');
        try {
            include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
            $res = ilRpcClientFactory::factory('RPCSearchHandler')->highlight(
                CLIENT_ID . '_' . $ilSetting->get('inst_id', 0),
                $a_obj_ids,
                $this->query_parser->getQuery()
            );
        } catch (Exception $e) {
            ilLoggerFactory::getLogger('src')->error('Highlighting failed with message: ' . $e->getMessage());
            return new ilLuceneHighlighterResultParser();
        }

        include_once './Services/Search/classes/Lucene/class.ilLuceneHighlighterResultParser.php';
        $this->highlighter = new ilLuceneHighlighterResultParser();
        $this->highlighter->setResultString($res);
        $this->highlighter->parse();

        return $this->highlighter;
    }

Here is the call graph for this function:

nextResultPage()

ilLuceneSearcher::nextResultPage

(

)

get next result page

Parameters

Definition at line 149 of file class.ilLuceneSearcher.php.

References performSearch().

    {
        $this->page_number++;
        $this->performSearch();
    }

Here is the call graph for this function:

performSearch()

ilLuceneSearcher::performSearch ( )

protected

search lucene

Returns

Definition at line 191 of file class.ilLuceneSearcher.php.

References $DIC, $ilBench, $ilSetting, $parser, $res, ilRpcClientFactory\factory(), ilLoggerFactory\getLogger(), getPageNumber(), and getType().

Referenced by nextResultPage(), and search().

    {
        global $DIC;

        $ilBench = $DIC['ilBench'];
        $ilSetting = $DIC['ilSetting'];

        // TODO error handling
        if (!$this->query_parser->getQuery()) {
            return;
        }
        $ilBench->start('Lucene', 'SearchCombinedIndex');
        try {
            switch ($this->getType()) {
                
                case self::TYPE_USER:
                    include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
                    $res = ilRpcClientFactory::factory('RPCSearchHandler')->searchUsers(
                        CLIENT_ID . '_' . $ilSetting->get('inst_id', 0),
                        (string) $this->query_parser->getQuery()
                    );
                    break;
                
                case self::TYPE_STANDARD:
                default:
                    include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
                    $res = ilRpcClientFactory::factory('RPCSearchHandler')->search(
                        CLIENT_ID . '_' . $ilSetting->get('inst_id', 0),
                        (string) $this->query_parser->getQuery(),
                        $this->getPageNumber()
                    );
                    break;
                
            }
            ilLoggerFactory::getLogger('src')->debug('Searching for: ' . $this->query_parser->getQuery());
        } catch (Exception $e) {
            ilLoggerFactory::getLogger('src')->error('Searching failed with message: ' . $e->getMessage());
            return;
        }
        
        // Parse results
        include_once './Services/Search/classes/Lucene/class.ilLuceneSearchResultParser.php';
        $parser = new ilLuceneSearchResultParser($res);
        $parser->parse($this->result);
        return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

search()

ilLuceneSearcher::search

(

)

Search.

Returns

Definition at line 98 of file class.ilLuceneSearcher.php.

References performSearch().

    {
        $this->performSearch();
    }

Here is the call graph for this function:

setType()

ilLuceneSearcher::setType

(

$a_type

)

Set search type.

Parameters

type

$a_type

Definition at line 79 of file class.ilLuceneSearcher.php.

References $a_type.

    {
        $this->type = $a_type;
    }

Field Documentation

$highlighter

ilLuceneSearcher::$highlighter = null

private

Definition at line 44 of file class.ilLuceneSearcher.php.

Referenced by getHighlighter(), and highlight().

$instance

ilLuceneSearcher::$instance = null

staticprivate

Definition at line 40 of file class.ilLuceneSearcher.php.

$page_number

ilLuceneSearcher::$page_number = 1

private

Definition at line 45 of file class.ilLuceneSearcher.php.

Referenced by getPageNumber().

$query_parser

ilLuceneSearcher::$query_parser = null

private

Definition at line 42 of file class.ilLuceneSearcher.php.

$result

ilLuceneSearcher::$result = null

private

Definition at line 43 of file class.ilLuceneSearcher.php.

Referenced by getResult().

$type

ilLuceneSearcher::$type = self::TYPE_STANDARD

private

Definition at line 46 of file class.ilLuceneSearcher.php.

Referenced by getType().

TYPE_STANDARD

const ilLuceneSearcher::TYPE_STANDARD = 1

Definition at line 37 of file class.ilLuceneSearcher.php.

Referenced by ilSearchAutoComplete\getLuceneList().

TYPE_USER

const ilLuceneSearcher::TYPE_USER = 2

Definition at line 38 of file class.ilLuceneSearcher.php.

Referenced by ilLuceneUserSearchGUI\performSearch().

---

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

• Services/Search/classes/Lucene/class.ilLuceneSearcher.php