Docs For Class IFile_Indexing

Class IFile_Indexing_Abstract

Description

Implements interfaces:

IFile_Indexing_Interface

Contiene tutti i medodi necessari all'indicizzazione di un file Implementa l'interfaccia IFile_Indexing_Interface.

author: Giampaolo Losito, Antonio Di Girolomo
copyright:
abstract:
license: GNU

Located in /IFile_Indexing_Abstract.php (line 39)

Direct descendents

Class	Description
IFile_Indexing_Lucene	Wrapper delle librerie Zend_Search__Lucene
IFile_Indexing_Mysqli	Utilizza MySql come motore di indicizzazione e ricerca

Variable Summary

boolean $autoCommit

string $defaultField

IFileInfoFile $file

object $handler

array $registryFields

array $registrySort

integer $resultlimit

Method Summary

IFile_Indexing_Abstract __construct ()

void addCustomField (string $field, string $term, string $type)

Zend_Search_Lucene_Document addDocument ([ $doc = null])

void autoCommit ( $autocommit, boolean $commit)

void commit ()

integer count ()

void delete (integer $id)

integer deleteAll ([bool $doc = false])

mixed getAllDocument ([boolean $deleted = false], [integer $offset = null], [integer $maxrow = null])

array getCustomField ()

string getDefaultSearchField ()

Zend_Searc_Lucene_Document getDocument ( $id)

array getFieldNames ([boolean $indexed = false])

IFileInfoFile getIndexFile ()

void getIndexResource (string $connect)

integer getResultLimit ()

boolean hasDeletions ()

boolean hasTerm (string $term, [string $field = null])

boolean isDeleted ( $id)

integer numDocs ()

void optimize ()

mixed query (IFileQueryRegistry $query)

mixed queryBoolean (IFileQueryRegistry $query)

mixed queryFuzzy (IFileQueryRegistry $query)

mixed queryParser (IFileQueryRegistry $query)

mixed queryPhrase (IFileQueryRegistry $query)

mixed queryRange (IFileQueryRegistry $query)

mixed queryWildcard (IFileQueryRegistry $query)

void setDefaultSearchField (string $field)

void setIndexFile (stringa $indexFile)

void setIndexResource ( $resource, string $connect)

void setResultLimit (integer $limit)

void setSort (string $field, [string $type = SORT_REGULAR], [string $order = SORT_ASC])

void undeletedAll ()

void __addDocument ( $doc)

void __checkIndexingFileFromKey (string $key)

Zend_Search_Lucene_Document __createDocumentFromFile ()

array __query (IFileQueryRegistry $query)

array __queryBoolean (IFileQueryRegistry $query)

array __queryFuzzy (IFileQueryRegistry $query)

array __queryParser (string $query)

array __queryPhrase (IFileQueryRegistry $query)

array __queryWildcard (IFileQueryRegistry $query)

Variables

boolean $autoCommit = false (line 70)

Auto commit (default disattivato)

access: protected

string $defaultField = null (line 64)

Campo di ricerca di default

access: protected

IFileInfoFile $file = null (line 46)

IFileInfoFile

access: private

object $handler = null (line 52)

Handler della risorsa di indicizzazione

access: private

array $registryFields = array() (line 76)

Registro dei campi personalizzati da aggiungere al documento

access: protected

array $registrySort = array() (line 82)

Registro dei campi di ordinamento

access: protected

integer $resultlimit = null (line 58)

Limite di risultati

access: protected

Methods

Constructor __construct (line 85)

access: protected

IFile_Indexing_Abstract __construct ()

Redefined in descendants as:

IFile_Indexing_Lucene::__construct() : Costruttore
IFile_Indexing_Mysqli::__construct() : Invoca un eccezione in caso non riesca ad aprire o creare l'indice.

addCustomField (line 237)

Aggiunge un campo personalizzato al documento da indicizzare

throws: IFile_Exception
access: public

void addCustomField (string $field, string $term, string $type)

string $field
string $term
string $type

Implementation of:

IFile_Indexing_Interface::addCustomField(): Aggiunge un campo personalizzato al documento da indicizzare

addDocument (line 102)

Aggiunge un documento ad un indice Il metodo oltre ai fleld recuperati dalla parserizzazione del file (o del Zend_Search_Lucene_Document passato) aggiunge i seguenti filed

name: nome del file
path: il path relativo del file.

Aggiunge un documento ad un indice Il metodo oltre ai fleld recuperati dalla parserizzazione del file (o del Zend_Search_Lucene_Document passato) aggiunge i seguenti filed

name: nome del file
path: il path relativo del file. Assoulto in caso non venga mecciato con la root-application configurata
root: la root-application presente al momento dell'indicizzazione del file
key: chiave univoca del file recuperata come MD5 del contenuto del file

throws: IFile_Exception
access: public

Zend_Search_Lucene_Document addDocument ([ $doc = null])

Zend_Search_Lucene_Document $doc: [optional]

Implementation of:

IFile_Indexing_Interface::addDocument(): Aggiunge un documento ad un indice

autoCommit (line 668)

Setta la gestire manualmente o in modo automatico del commit

access: public

void autoCommit ( $autocommit, boolean $commit)

boolean $commit
$autocommit

Implementation of:

IFile_Indexing_Interface::autoCommit(): Setta la gestire manualmente o in modo automatico del commit

commit (line 676)

Committa l'indice

access: public

void commit ()

Implementation of:

IFile_Indexing_Interface::commit(): Committa l'indice

Redefined in descendants as:

IFile_Indexing_Lucene::commit() : Committa l'indice
IFile_Indexing_Mysqli::commit() : Committa l'indice

count (line 627)

Ritorna il numero di documenti inseriti compresi quelli marcati come cancellati

access: public

integer count ()

Implementation of:

IFile_Indexing_Interface::count(): Ritorna il numero di documenti inseriti compresi quelli marcati come cancellati

Redefined in descendants as:

IFile_Indexing_Lucene::count() : Ritorna il numero di documenti inseriti compresi quelli marcati come cancellati
IFile_Indexing_Mysqli::count() : Ritorna il numero di documenti inseriti compresi quelli marcati come cancellati

delete (line 524)

Marca un documento come cancellato

access: public

void delete (integer $id)

integer $id

Implementation of:

IFile_Indexing_Interface::delete(): Marca un documento come cancellato

Redefined in descendants as:

IFile_Indexing_Lucene::delete() : Marca un documento come cancellato
IFile_Indexing_Mysqli::delete() : Marca un documento come cancellato

deleteAll (line 717)

Cancella l'indice e ritorna il numero di documenti cancellati

Cancella l'indice e ritorna il numero di documenti cancellati Se viene passato TRUE cancella solo tutti i documenti dall'indice e ritorna il numero di documenti cancellati altrimenti elimina completamente l'indice

access: public

integer deleteAll ([bool $doc = false])

bool $doc: [optional]

Implementation of:

IFile_Indexing_Interface::deleteAll(): Cancella l'indice e ritorna il numero di documenti cancellati

Redefined in descendants as:

IFile_Indexing_Lucene::deleteAll() : Cancella l'indice e ritorna il numero di documenti cancellati
IFile_Indexing_Mysqli::deleteAll() : Cancella l'indice e ritorna il numero di documenti cancellati

getAllDocument (line 661)

Ritorna un array contenente tutti gli oggetti documento presenti nell'indice, senza i documenti marcati come cancellati.

Ritorna un array contenente tutti gli oggetti documento presenti nell'indice, senza i documenti marcati come cancellati. Se settato il parametro $deleted = true allora ritorna anche i documenti cancellati. Ritorna NULL se non sono presenti documenti

access: public

mixed getAllDocument ([boolean $deleted = false], [integer $offset = null], [integer $maxrow = null])

boolean $deleted
integer $offset: [optional]
integer $maxrow: [optional]

Implementation of:

IFile_Indexing_Interface::getAllDocument(): Ritorna un array contenente tutti gli oggetti documento presenti nell'indice, senza i documenti marcati come cancellati.

Redefined in descendants as:

IFile_Indexing_Lucene::getAllDocument() : Ritorna un array contenente tutti gli oggetti Zend_Search_Lucene_Document presenti nell'indice, senza i documenti marcati come cancellati.
IFile_Indexing_Mysqli::getAllDocument() : Ritorna un array contenente tutti gli oggetti Zend_Search_Lucene_Document presenti nell'indice, senza i documenti marcati come cancellati.

getCustomField (line 266)

Ritorna un array dei campi personalizzati settati

access: public

array getCustomField ()

Implementation of:

IFile_Indexing_Interface::getCustomField(): Ritorna un array dei campi personalizzati settati

getDefaultSearchField (line 619)

Ritorna il field di default su cui ricercare i termini

access: public

string getDefaultSearchField ()

Implementation of:

IFile_Indexing_Interface::getDefaultSearchField(): Ritorna il field di default su cui ricercare i termini

Redefined in descendants as:

IFile_Indexing_Lucene::getDefaultSearchField() : Ritorna il field di default su cui ricercare i termini

getDocument (line 646)

Ritorna l'oggetto documento

access: public

Zend_Searc_Lucene_Document getDocument ( $id)

Implementation of:

IFile_Indexing_Interface::getDocument(): Ritorna l'oggetto documento

Redefined in descendants as:

IFile_Indexing_Lucene::getDocument() : Ritorna l'oggetto documento
IFile_Indexing_Mysqli::getDocument() : Ritorna l'oggetto documento

getFieldNames (line 640)

Ritorna un array dei campi presenti nell'indice

access: public

array getFieldNames ([boolean $indexed = false])

boolean $indexed: se true torna solo quelli indicizzati

Implementation of:

IFile_Indexing_Interface::getFieldNames(): Ritorna un array dei campi presenti nell'indice

Redefined in descendants as:

IFile_Indexing_Lucene::getFieldNames() : Ritorna un array dei campi presenti nell'indice
IFile_Indexing_Mysqli::getFieldNames() : Ritorna un array dei campi presenti nell'indice

getIndexFile (line 585)

Ritorna un oggetto IFileInfoFile

access: public

IFileInfoFile getIndexFile ()

Implementation of:

IFile_Indexing_Interface::getIndexFile(): Ritorna un oggetto IFileInfoFile

getIndexResource (line 328)

Setta l'handler alla risorsa di indicizzazione

access: protected

void getIndexResource (string $connect)

string $connect

getResultLimit (line 602)

Ritorna il limite dei risultati da estrarre

access: public

integer getResultLimit ()

Implementation of:

IFile_Indexing_Interface::getResultLimit(): Ritorna il limite dei risultati da estrarre

Redefined in descendants as:

IFile_Indexing_Lucene::getResultLimit() : Ritorna il limite dei risultati da estrarre

hasDeletions (line 682)

Verifica se ci sono documenti calcellati

access: public

boolean hasDeletions ()

Implementation of:

IFile_Indexing_Interface::hasDeletions(): Verifica se ci sono documenti calcellati

Redefined in descendants as:

IFile_Indexing_Lucene::hasDeletions() : Verifica se ci sono documenti calcellati
IFile_Indexing_Mysqli::hasDeletions() : Verifica se ci sono documenti calcellati

hasTerm (line 690)

Verifica se esiste il termine

access: public

boolean hasTerm (string $term, [string $field = null])

string $term
string $field: [0prional]

Implementation of:

IFile_Indexing_Interface::hasTerm(): Verifica se esiste il termine

Redefined in descendants as:

IFile_Indexing_Lucene::hasTerm() : Verifica se esiste il termine
IFile_Indexing_Mysqli::hasTerm() : Verifica se esiste il termine all'interno dell'indice

isDeleted (line 699)

Verifica se un documento e' stato marcato come cancellato

Verifica se un documento e' stato marcato come cancellato Ritorna un eccezione Zend_Search_Lucene_Exception se $id non e' presente nel range degli id dell'indice

throws: Zend_Search_Lucene_Exception
access: public

boolean isDeleted ( $id)

Implementation of:

IFile_Indexing_Interface::isDeleted(): Verifica se un documento e' stato marcato come cancellato

Redefined in descendants as:

IFile_Indexing_Lucene::isDeleted() : Verifica se un documento e' stato marcato come cancellato
IFile_Indexing_Mysqli::isDeleted() : Verifica se un documento e' stato marcato come cancellato

numDocs (line 633)

Ritorna il numero di documenti realmente presenti senza quelli marcati come cancellati

access: public

integer numDocs ()

Implementation of:

IFile_Indexing_Interface::numDocs(): Ritorna il numero di documenti realmente presenti senza quelli marcati come cancellati

Redefined in descendants as:

IFile_Indexing_Lucene::numDocs() : Ritorna il numero di documenti realmente presenti senza quelli marcati come cancellati
IFile_Indexing_Mysqli::numDocs() : Ritorna il numero di documenti realmente presenti senza quelli marcati come cancellati

optimize (line 517)

Ottimizza l'indice

access: public

void optimize ()

Implementation of:

IFile_Indexing_Interface::optimize(): Ottimizza l'indice

Redefined in descendants as:

IFile_Indexing_Lucene::optimize() : Ottimizza l'indice
IFile_Indexing_Mysqli::optimize() : Ottimizza l'indice

query (line 338)

Esegue la query di ricerca per i termini

access: public

mixed query (IFileQueryRegistry $query)

IFileQueryRegistry $query

Implementation of:

IFile_Indexing_Interface::query(): Esegue la query di ricerca per i termini

queryBoolean (line 398)

Esegue una boolean query

access: public

mixed queryBoolean (IFileQueryRegistry $query)

IFileQueryRegistry $query

Implementation of:

IFile_Indexing_Interface::queryBoolean(): Esegue una boolean query

queryFuzzy (line 378)

Esegue la fuzzy query

access: public

mixed queryFuzzy (IFileQueryRegistry $query)

IFileQueryRegistry $query

Implementation of:

IFile_Indexing_Interface::queryFuzzy(): Esegue la fuzzy query

queryParser (line 458)

Esegue una query parserizzando la stringa di ricerca

access: public

mixed queryParser (IFileQueryRegistry $query)

IFileQueryRegistry $query

Implementation of:

IFile_Indexing_Interface::queryParser(): Esegue una query parserizzando la stringa di ricerca

queryPhrase (line 358)

Esegue la query di ricerca per frasi

access: public

mixed queryPhrase (IFileQueryRegistry $query)

IFileQueryRegistry $query

Implementation of:

IFile_Indexing_Interface::queryPhrase(): Esegue la query di ricerca per frasi

queryRange (line 438)

Esegue la query su un range di dati

access: public

mixed queryRange (IFileQueryRegistry $query)

IFileQueryRegistry $query

Implementation of:

IFile_Indexing_Interface::queryRange(): Esegue la query su un range di dati

queryWildcard (line 418)

Esegue la query con caratteri Wildcard

access: public

mixed queryWildcard (IFileQueryRegistry $query)

IFileQueryRegistry $query

Implementation of:

IFile_Indexing_Interface::queryWildcard(): Esegue la query con caratteri Wildcard

setDefaultSearchField (line 611)

Setta il field di default su cui ricercare i termini

access: public

void setDefaultSearchField (string $field)

string $field

Implementation of:

IFile_Indexing_Interface::setDefaultSearchField(): Setta il field di default su cui ricercare i termini

Redefined in descendants as:

IFile_Indexing_Lucene::setDefaultSearchField() : Setta il field di default su cui ricercare i termini

setIndexFile (line 538)

Setta il file da indicizzare

Setta il file da indicizzare Il metodo recupera dal file altre informazioni quali:

Checksum del contenuto del file
Nome del file
Estensione
Path relativo del file a partire dalla root-application configurata nel file XML

access: public

void setIndexFile (stringa $indexFile)

stringa $indexFile

Implementation of:

IFile_Indexing_Interface::setIndexFile(): Setta il path del file da indicizzare

setIndexResource (line 319)

Setta l'handler alla risorsa di indicizzazione

access: protected

void setIndexResource ( $resource, string $connect)

string $connect
$resource

setResultLimit (line 594)

Setta il limite dei risultati da estrarre

access: public

void setResultLimit (integer $limit)

integer $limit

Implementation of:

IFile_Indexing_Interface::setResultLimit(): Setta il limite dei risultati da estrarre

Redefined in descendants as:

IFile_Indexing_Lucene::setResultLimit() : Setta il limite dei risultati da estrarre

setSort (line 196)

Aggiunge un ordinamento alla query

throws: IFile_Exception
access: public

void setSort (string $field, [string $type = SORT_REGULAR], [string $order = SORT_ASC])

string $field
string $type: [optional]
string $order: [optional]

Implementation of:

IFile_Indexing_Interface::setSort(): Aggiunge un ordinamento alla query

undeletedAll (line 706)

Ripristina tutti i documenti marcati come cancellati

Ripristina tutti i documenti marcati come cancellati Implementato in Zend_Search_Lucene dalla versione (x.x.x)

access: public

void undeletedAll ()

Implementation of:

IFile_Indexing_Interface::undeletedAll(): Ripristina tutti i documenti marcati come cancellati

Redefined in descendants as:

IFile_Indexing_Lucene::undeletedAll() : Ripristina tutti i documenti marcati come cancellati
IFile_Indexing_Mysqli::undeletedAll() : Ripristina tutti i documenti marcati come cancellati

__addDocument (line 305)

Indicizza il documento

abstract:
access: protected

void __addDocument ( $doc)

Zend_Search_Lucene_Document $doc

Redefined in descendants as:

IFile_Indexing_Lucene::__addDocument() : Indicizza il documento
IFile_Indexing_Mysqli::__addDocument() : Indicizza il documento

__checkIndexingFileFromKey (line 312)

Verifica se il file e' stato gia' indicizzato

abstract:
access: protected

void __checkIndexingFileFromKey (string $key)

string $key: MD5

Redefined in descendants as:

IFile_Indexing_Lucene::__checkIndexingFileFromKey() : Verifica se il file e' gia' stato indicizzato
IFile_Indexing_Mysqli::__checkIndexingFileFromKey() : Verifica se il file e' stato gia' indicizzato

__createDocumentFromFile (line 279)

Crea un oggetto Zend_Search_Lucene_Document da un file

Crea un oggetto Zend_Search_Lucene_Document da un file Oltre ai metadati recuperati dal processo di parserizzazione del file (vedi LuceneDataIndexBean) vengono aggiunti all'indice altri campi importanti, ovvero:

throws: IFile_Exception, Adapter_Search_Lucene_Exception
access: private

Zend_Search_Lucene_Document __createDocumentFromFile ()

__query (line 471)

Esegue la query di ricerca per i termini

abstract:
access: protected

array __query (IFileQueryRegistry $query)

IFileQueryRegistry $query

Redefined in descendants as:

IFile_Indexing_Lucene::__query() : Esegue la query di ricerca per i termini Ritorna un array di oggetti Zend_Search_Lucene_Search_QueryHit
- un array vuoto in caso la query non presenta match.
IFile_Indexing_Mysqli::__query() : Esegue la query di ricerca per i termini Ritorna un array di oggetti Zend_Search_Lucene_Search_QueryHit
- un array vuoto in caso la query non presenta match.

__queryBoolean (line 495)

Esegue una boolean query

abstract:
access: protected

array __queryBoolean (IFileQueryRegistry $query)

IFileQueryRegistry $query

Redefined in descendants as:

IFile_Indexing_Lucene::__queryBoolean() : Esegue una boolean query Ritorna un array di oggetti Zend_Search_Lucene_Search_QueryHit
1. un array vuoto in caso la query non presenta match.
IFile_Indexing_Mysqli::__queryBoolean() : Esegue una boolean query Ritorna un array di oggetti Zend_Search_Lucene_Search_QueryHit
1. un array vuoto in caso la query non presenta match.

__queryFuzzy (line 487)

Esegue fuzzy query

abstract:
access: protected

array __queryFuzzy (IFileQueryRegistry $query)

IFileQueryRegistry $query

Redefined in descendants as:

IFile_Indexing_Lucene::__queryFuzzy() : Esegue la fuzzy query Ritorna un array di oggetti Zend_Search_Lucene_Search_QueryHit
- un array vuoto in caso la query non presenta match.
IFile_Indexing_Mysqli::__queryFuzzy() : Esegue la fuzzy query.

__queryParser (line 511)

Esegue la query Parserizzaando la stringa

abstract:
access: protected

array __queryParser (string $query)

string $query

Redefined in descendants as:

IFile_Indexing_Lucene::__queryParser() : Esegue una query parserizzando la stringa di ricerca Ritorna un array di oggetti Zend_Search_Lucene_Search_QueryHit
1. un array vuoto in caso la query non presenta match.
IFile_Indexing_Mysqli::__queryParser() : Esegue una query parserizzando la stringa di ricerca Ritorna un array di oggetti Zend_Search_Lucene_Search_QueryHit
- un array vuoto in caso la query non presenta match.

__queryPhrase (line 479)

Esegue la query di ricerca per frasi

abstract:
access: protected

array __queryPhrase (IFileQueryRegistry $query)

IFileQueryRegistry $query

Redefined in descendants as:

IFile_Indexing_Lucene::__queryPhrase() : Esegue la query di ricerca per frasi Ritorna un array di oggetti Zend_Search_Lucene_Search_QueryHit
- un array vuoto in caso la query non presenta match.
IFile_Indexing_Mysqli::__queryPhrase() : Esegue la query di ricerca per frasi.

__queryWildcard (line 503)

Esegue la query con caratteri Wildcard

abstract:
access: protected

array __queryWildcard (IFileQueryRegistry $query)

IFileQueryRegistry $query

Redefined in descendants as:

IFile_Indexing_Lucene::__queryWildcard() : Esegue la query con caratteri Wildcard Ritorna un array di oggetti Zend_Search_Lucene_Search_QueryHit
- un array vuoto in caso la query non presenta match.
IFile_Indexing_Mysqli::__queryWildcard() : Esegue la query con caratteri Wildcard Ritorna un array di oggetti Zend_Search_Lucene_Search_QueryHit
- un array vuoto in caso la query non presenta match.

Documentation generated on Fri, 16 Aug 2013 11:37:32 +0200 by phpDocumentor 1.4.0