Docs For Class IFile_Indexing

Interface IFile_Indexing_Interface

Description

Interfaccia pubblica per la gestione dell'indicizzazione dei file

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

Located in /IFile_Indexing_Interface.php (line 22)

Class Constant Summary

FIELD_TYPE_BINARY = 'Binary'

FIELD_TYPE_KEYWORD = 'Keyword'

FIELD_TYPE_TEXT = 'Text'

FIELD_TYPE_UNINDEXED = 'UnIndexed'

FIELD_TYPE_UNSTORED = 'UnStored'

Method Summary

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

void addDocument ([ $doc = null])

void autoCommit (boolean $autocommit)

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_Search_Lucene_Document getDocument (integer $id)

array getFieldNames ([boolean $indexed = false])

IFileInfoFile getIndexFile ()

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 (string $query)

mixed queryPhrase (IFileQueryRegistry $query)

mixed queryRange (IFileQueryRegistry $query)

mixed queryWildcard (IFileQueryRegistry $query)

void setDefaultSearchField (string $field)

void setIndexFile (stringa $indexFile)

void setResultLimit (integer $limit)

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

void undeletedAll ()

Methods

addCustomField (line 73)

Aggiunge un campo personalizzato al documento da indicizzare

access: public

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

string $field
string $term
string $type

addDocument (line 51)

Aggiunge un documento ad un indice

access: public

void addDocument ([ $doc = null])

Zend_Search_Lucene_Document $doc: [optional]

autoCommit (line 243)

Setta la gestire manualmente o in modo automatico del commit

access: public

void autoCommit (boolean $autocommit)

boolean $autocommit

commit (line 249)

Committa l'indice

access: public

void commit ()

count (line 198)

Ritorna il numero di documenti inseriti compresi quelli marcati come cancellati

access: public

integer count ()

delete (line 153)

Marca un documento come cancellato

Marca un documento 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

void delete (integer $id)

integer $id

deleteAll (line 290)

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]

getAllDocument (line 236)

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]

getCustomField (line 80)

Ritorna un array dei campi personalizzati settati

access: public

array getCustomField ()

getDefaultSearchField (line 192)

Ritorna il field di default su cui ricercare i termini

access: public

string getDefaultSearchField ()

getDocument (line 221)

Ritorna l'oggetto documento

Ritorna l'oggetto documento 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

Zend_Search_Lucene_Document getDocument (integer $id)

integer $id

getFieldNames (line 211)

Ritorna un array dei campi presenti nell'indice

access: public

array getFieldNames ([boolean $indexed = false])

boolean $indexed: se true torna solo quelli indicizzati

getIndexFile (line 166)

Ritorna un oggetto IFileInfoFile

access: public

IFileInfoFile getIndexFile ()

getResultLimit (line 179)

Ritorna il limite dei risultati da estrarre

access: public

integer getResultLimit ()

hasDeletions (line 255)

Verifica se ci sono documenti calcellati

access: public

boolean hasDeletions ()

hasTerm (line 263)

Verifica se esiste il termine

access: public

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

string $term
string $field: [0prional]

isDeleted (line 272)

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)

numDocs (line 204)

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

access: public

integer numDocs ()

optimize (line 143)

Ottimizza l'indice

access: public

void optimize ()

query (line 88)

Esegue la query di ricerca per i termini

access: public

mixed query (IFileQueryRegistry $query)

IFileQueryRegistry $query

queryBoolean (line 112)

Esegue una boolean query

access: public

mixed queryBoolean (IFileQueryRegistry $query)

IFileQueryRegistry $query

queryFuzzy (line 104)

Esegue la fuzzy query

access: public

mixed queryFuzzy (IFileQueryRegistry $query)

IFileQueryRegistry $query

queryParser (line 136)

Esegue una query parserizzando la stringa di ricerca

access: public

mixed queryParser (string $query)

string $query

queryPhrase (line 96)

Esegue la query di ricerca per frasi

access: public

mixed queryPhrase (IFileQueryRegistry $query)

IFileQueryRegistry $query

queryRange (line 128)

Esegue la query su un range di dati

access: public

mixed queryRange (IFileQueryRegistry $query)

IFileQueryRegistry $query

queryWildcard (line 120)

Esegue la query con caratteri Wildcard

access: public

mixed queryWildcard (IFileQueryRegistry $query)

IFileQueryRegistry $query

setDefaultSearchField (line 186)

Setta il field di default su cui ricercare i termini

access: public

void setDefaultSearchField (string $field)

string $field

setIndexFile (line 160)

Setta il path del file da indicizzare

access: public

void setIndexFile (stringa $indexFile)

stringa $indexFile

setResultLimit (line 173)

Setta il limite dei risultati da estrarre

access: public

void setResultLimit (integer $limit)

integer $limit

setSort (line 62)

Aggiunge un ordinamento alla query

access: public

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

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

undeletedAll (line 279)

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 ()

Class Constants

FIELD_TYPE_BINARY = 'Binary' (line 35)

Tipo di field: Binario

FIELD_TYPE_KEYWORD = 'Keyword' (line 27)

Tipo di field: Parola chiave

FIELD_TYPE_TEXT = 'Text' (line 39)

Tipo di field: Testo

FIELD_TYPE_UNINDEXED = 'UnIndexed' (line 31)

Tipo di field: Non indicizzato

FIELD_TYPE_UNSTORED = 'UnStored' (line 43)

Tipo di field: TesNon storicizzato

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