[Zend_Search_Lucene] element index

Package indexes

All elements
a b c d e f g h i k l m n o p q r s t u v w z _
_
top
Variable $_closeDirOnExit
File system adapter closing option
Variable $_directory
File system adapter.
Variable $_docCount
Number of documents in this index.
Variable $_segmentInfos
Array of Zend_Search_Lucene_Index_SegmentInfo objects for this index.
Variable $_writer
Writer for this index, not instantiated unless required.
Method __construct
Opens the index.
Method __destruct
Object destructor
Variable $_defaultImpl
The Analyzer implementation used by default.
Variable $_endOffset
End in source text
Variable $_filters
The set of Token filters applied to the Token stream.
Variable $_positionIncrement
The position of this token relative to the previous Token.
Variable $_startOffset
Start in source text.
Variable $_termText
The text of the term.
Variable $_type
Lexical type.
Method __construct
Object constructor
Method __construct
Variable $_fields
Associative array Zend_Search_Lucene_Field objects where the keys to the array are the names of the fields.
Method __construct
Method __get
Proxy method for getFieldValue(), provides more convenient access to the string value of a field.
Variable $_currentSegment
Current segment to add documents
Variable $_directory
File system adapter.
Variable $_directory
File system adapter.
Variable $_directory
File system adapter.
Variable $_docCount
Number of docs in a segment
Variable $_docCount
Number of docs in a segment
Variable $_fdtFile
'.fdx' file - Stored Fields, the field data.
Variable $_fdxFile
'.fdx' file - Stored Fields, the field index.
Variable $_fields
Segment fields. Array of Zend_Search_Lucene_Index_FieldInfo objects for this segment
Variable $_fields
Segment fields. Array of Zend_Search_Lucene_Index_FieldInfo objects for this segment
Variable $_fieldsDicPositions
Field positions in a dictionary.
Variable $_files
List of the index files.
Variable $_name
Segment name
Variable $_name
Segment name
Variable $_newSegments
List of the segments, created by index writer Array of Zend_Search_Lucene_Index_SegmentInfo objects
Variable $_norms
Normalization factors.
Variable $_norms
Normalization factors.
Variable $_segFiles
Associative array where the key is the file name and the value is data offset in a compound segment file (.csf).
Variable $_segmentNameCounter
Segment name counter.
Variable $_segments
Number of the segments in the index
Variable $_termDictionary
Term Dictionary Index Array of the Zend_Search_Lucene_Index_Term objects Corresponding Zend_Search_Lucene_Index_TermInfo object stored in the $_termDictionaryInfos
Variable $_termDictionary
Term Dictionary Array of the Zend_Search_Lucene_Index_Term objects Corresponding Zend_Search_Lucene_Index_TermInfo object stored in the $_termDictionaryInfos
Variable $_termDictionaryInfos
Term Dictionary Index TermInfos Array of the Zend_Search_Lucene_Index_TermInfo objects
Variable $_termDocs
Documents, which contain the term
Variable $_version
Index version Counts how often the index has been changed by adding or deleting docs
Method _addFieldInfo
Add field to the segment
Method _dumpDictionary
Dump Term Dictionary (.tis) and Term Dictionary Index (.tii) segment files
Method _dumpFNM
Dump Field Info (.fnm) segment file
Method _dumpTermDictEntry
Dump Term Dictionary segment file entry.
Method _generateCFS
Generate compound index file
Method _loadDictionary
Loads Term dictionary from TermInfoIndex file
Method _newSegmentName
Get name for new segment
Method _updateSegments
Update segments file by adding current segment to a list
Method __construct
Opens the index for writing
Method __construct
Zend_Search_Lucene_Index_SegmentInfo constructor needs Segmentname, Documents count and Directory as a parameter.
Method __construct
Method __construct
Method __construct
Object constructor.
Method __construct
Variable $_boost
query boost factor
Variable $_coord
A score factor based on the fraction of all query terms that a document contains.
Variable $_currToken
tokens pointer.
Variable $_defaultImpl
The Similarity implementation used by default.
Variable $_document
Object handle of the document associated with this hit
Variable $_docVector
Documents vector.
Variable $_idf
Score factor
Variable $_idf
Score factor
Variable $_index
Object handle of the index
Variable $_normTable
Cache of decoded bytes.
Variable $_offsets
Term positions (relative positions of terms within the phrase).
Variable $_query
The query that this concerns.
Variable $_query
The query that this concerns.
Variable $_query
The query that this concerns.
Variable $_queryNorm
Normalization factor
Variable $_queryNorm
Normalization factor
Variable $_queryWeight
Query weight
Variable $_queryWeight
Query weight
Variable $_reader
IndexReader.
Variable $_reader
IndexReader.
Variable $_reader
IndexReader.
Variable $_resVector
Result vector.
Variable $_resVector
Result vector.
Variable $_sign
Term sign.
Variable $_signs
Term signs.
Variable $_slop
Sets the number of other words permitted between words in query phrase.
Variable $_term
Term
Variable $_term
Term to find.
Variable $_termPositions
Term positions vector.
Variable $_terms
Terms to find.
Variable $_terms
Terms to find.
Variable $_termsPositions
Terms positions vectors.
Variable $_termsPositions
Terms positions vectors.
Variable $_tokens
inputString tokens.
Variable $_value
Weight value
Variable $_value
Weight value
Variable $_weight
Query weight
Variable $_weights
Terms weights array of Zend_Search_Lucene_Search_Weight
Variable $_weights
Query terms weights Array of Zend_Search_Lucene_Search_Weight_Term
Method _calculateConjunctionResult
Calculate result vector for Conjunction query (like '+something +another')
Method _calculateNonConjunctionResult
Calculate result vector for non Conjunction query (like '+something -another')
Method _calculateResult
Calculate result vector
Method _conjunctionScore
Score calculator for conjunction queries (all terms are required)
Method _createWeight
Constructs an appropriate Weight implementation for this query.
Method _createWeight
Constructs an appropriate Weight implementation for this query.
Method _createWeight
Constructs an appropriate Weight implementation for this query.
Method _createWeight
Constructs an appropriate Weight implementation for this query.
Method _exactPhraseFreq
Score calculator for exact phrase queries (terms sequence is fixed)
Method _floatToByte
Float to byte conversion
Method _initWeight
Constructs an initializes a Weight for a query.
Method _nonConjunctionScore
Score calculator for non conjunction queries (not all terms are required)
Method _sloppyPhraseFreq
Score calculator for sloppy phrase queries (terms sequence is fixed)
Method __construct
IndexReader constructor needs token type and token text as a parameters.
Method __construct
Class constructor. Create a new prase query.
Method __construct
Constructor - pass object handle of Zend_Search_Lucene index that produced the hit so the document can be retrieved easily from the hit.
Method __construct
Zend_Search_Lucene_Search_Query_Term constructor
Method __construct
Zend_Search_Lucene_Search_Weight_Term constructor reader - index reader
Method __construct
Zend_Search_Lucene_Search_Weight_MultiTerm constructor query - the query that this concerns.
Method __construct
Zend_Search_Lucene_Search_Weight_Phrase constructor
Method __construct
Class constructor. Create a new multi-term query object.
Method __construct
QueryTokenize constructor needs query string as a parameter.
Method __get
Convenience function for getting fields from the document associated with this hit.
Variable $_dirPath
Filesystem path to the directory
Variable $_fileHandle
Resource of the open file
Variable $_fileHandlers
Cache for Zend_Search_Lucene_Storage_File_Filesystem objects Array: filename => Zend_Search_Lucene_Storage_File object
Method _fread
Read a $length bytes from the file and advance the file pointer.
Method _fread
Reads $length number of bytes at the current position in the file and advances the file pointer.
Method _fwrite
Writes $length number of bytes (all, if $length===null) to the end of the file.
Method _fwrite
Writes $length number of bytes (all, if $length===null) to the end of the file.
Method __construct
Class constructor. Open the file.
Method __construct
Class constructor. Open the file.
Method __construct
Object constructor Checks if $path is a directory or tries to create it.
a
top
Method addDocument
Adds a document to this index.
Method addFilter
Add Token filter to the Analyzer
Page Analyzer.php
Analyzer.php in Analyzer.php
Method addField
Add a field object to this document.
Method addDocument
Adds a document to this segment.
Method addDocument
Adds a document to this index.
Method addIndexes
Merges the provided indexes into this index.
Method addTerm
Adds a term to the end of the query phrase.
Method addTerm
Add a $term (Zend_Search_Lucene_Index_Term) to this query.
b
top
Variable $boost
Variable $boost
Method Binary
Constructs a Binary String valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.
c
top
Method commit
Commit changes resulting from delete() or undeleteAll() operations.
Method count
Returns the total number of documents in this index.
Page Common.php
Common.php in Common.php
Page CaseInsensitive.php
CaseInsensitive.php in CaseInsensitive.php
Method close
Flushes all changes to an index and closes all associated files.
Method close
Close segment, write it to disk and return segment info
Method commit
Commit current changes returns array of new segments
Method count
Returns the total number of documents in this segment.
Method coord
Implemented as 'overlap/maxOverlap'.
Method coord
Computes a score factor based on the fraction of all query terms that a document contains. This value is multiplied into scores.
Method count
Returns number of tokens
Method current
Returns the token at the current position or FALSE if the position does not contain a valid token.
Method close
Close File object
Method close
Closes the store.
Method close
Closes the store.
Method createFile
Creates a new, empty file in the directory with the given $filename.
Method createFile
Creates a new, empty file in the directory with the given $filename.
d
top
Method delete
Deletes a document from the index. $doc may contain a Zend_Search_Lucene_Document or the number of the document to delete.
Method docFreq
Returns the number of documents in this index containing the $term.
Page Document.php
Document.php in Document.php
Variable $docFreq
The number of documents which contain the term.
Method docCount
Returns the number of documents currently in this index.
Method decodeNorm
Decodes a normalization factor stored in an index.
Page Default.php
Default.php in Default.php
Method deleteFile
Removes an existing $filename in the directory.
Method deleteFile
Removes an existing $filename in the directory.
Page Directory.php
Directory.php in Directory.php
e
top
Page Exception.php
Exception.php in Exception.php
Page Exception.php
Exception.php in Exception.php
Method encodeNorm
Encodes a normalization factor for storage in an index.
f
top
Method find
Performs a query against the index and returns an array of Zend_Search_Lucene_Search_QueryHit objects.
Page Field.php
Field.php in Field.php
Variable $field
Field name or field number (depending from context)
Variable $freqPointer
Data offset in a Frequencies file.
Page FieldInfo.php
FieldInfo.php in FieldInfo.php
Method fileExists
Returns true if a file with the given $filename exists.
Method fileExists
Returns true if a file with the given $filename exists.
Method fileLength
Returns the length of a $filename in the directory.
Method fileLength
Returns the length of a $filename in the directory.
Method fileList
Returns an array of strings, one for each file in the directory.
Method fileList
Returns an array of strings, one for each file in the directory.
Method fileModified
Returns the UNIX timestamp $filename was last modified.
Method fileModified
Returns the UNIX timestamp $filename was last modified.
Page Filesystem.php
Filesystem.php in Filesystem.php
Page Filesystem.php
Filesystem.php in Filesystem.php
Page File.php
File.php in File.php
g
top
Method getDirectory
Returns the Zend_Search_Lucene_Storage_Directory instance for this index.
Method getDocument
Returns a Zend_Search_Lucene_Document object for the document number $id in this index.
Method getFieldNames
Returns a list of all unique field names that exist in this index.
Method getIndexWriter
Returns an instance of Zend_Search_Lucene_Index_Writer for the index
Method getSimilarity
Retrive similarity used by index reader
Method getDefault
Return the default Analyzer implementation used by indexing code.
Method getEndOffset
Returns this Token's ending offset, one greater than the position of the last character corresponding to this token in the source text.
Method getPositionIncrement
Returns the position increment of this Token.
Method getStartOffset
Returns this Token's starting offset, the position of the first character corresponding to this token in the source text.
Method getTermText
Returns the Token's term text.
Method getType
Returns this Token's lexical type. Defaults to 'word'.
Method getField
Returns Zend_Search_Lucene_Field object for a named field in this document.
Method getFieldNames
Return an array with the names of the fields in this document.
Method getFieldValue
Returns the string value of a named field in this document.
Method getField
Returns field info for specified field
Method getFieldNum
Returns field index or -1 if field is not found
Method getFields
Returns array of fields.
Method getName
Return segment name
Method getTermInfo
Scans terms dictionary and returns term info
Method getBoost
Gets the boost for this clause. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by boost. The boost is 1.0 by default.
Method getDefault
Return the default Similarity implementation used by indexing and search code.
Method getDocument
Return the document object for this hit
Method getIndex
Return the index object for this hit
Method getSigns
Return terms signs
Method getSlop
Get slop
Method getTerms
Returns query term
Method getTerms
Returns query term
Method getValue
The weight for this query.
Method getValue
The weight for this query
Method getValue
The weight for this query
Method getValue
The weight for this query
Method getFileObject
Returns a Zend_Search_Lucene_Storage_File object for a given $filename in the directory.
Method getFileObject
Returns a Zend_Search_Lucene_Storage_File object for a given $filename in the directory.
h
top
Method hasDeletions
Returns true if any documents have been deleted from this index.
i
top
Variable $isBinary
Variable $isIndexed
Variable $isStored
Variable $isTokenized
Variable $indexInterval
Expert: The fraction of terms in the "dictionary" which should be stored
Variable $indexPointer
Term offset of the _next_ term in a TermDictionary file.
Variable $isIndexed
Variable $id
Number of the document in the index
Method idf
Computes a score factor for a simple term or a phrase.
Method idfFreq
Computes a score factor based on a term's document frequency (the number of documents which contain the term). This value is multiplied by the tf(int) factor for each term in the query and these products are then summed to form the initial score for a document.
Method idfFreq
Implemented as 'log(numDocs/(docFreq+1)) + 1'.
k
top
Variable $kind
Method Keyword
Constructs a String-valued Field that is not tokenized, but is indexed and stored. Useful for non-text fields, e.g. date or url.
Method key
Method key
Return the position of the current token.
l
top
Page Lucene.php
Lucene.php in Lucene.php
Page LowerCase.php
LowerCase.php in LowerCase.php
Method lengthNorm
Computes the normalization value for a field given the total number of terms contained in a field. These values, together with field boosts, are stored in an index and multipled into scores for hits on each field by the search code.
Method lengthNorm
Implemented as '1/sqrt(numTerms)'.
m
top
Variable $maxMergeDocs
Determines the largest number of documents ever merged by addDocument().
Variable $mergeFactor
Determines how often segment indices are merged by addDocument().
Variable $minMergeDocs
Determines the minimal number of documents required before the buffered in-memory documents are merging and a new Segment is created.
Page MultiTerm.php
MultiTerm.php in MultiTerm.php
Page MultiTerm.php
MultiTerm.php in MultiTerm.php
Method mkdirs
Utility function to recursive directory creation
n
top
Method norm
Returns a normalization factor for "field, document" pair.
Method normalize
Normalize Token or remove it (if null is returned)
Method normalize
Normalize Token or remove it (if null is returned)
Method normalize
Apply filters to the token.
Variable $name
Variable $name
Variable $number
Method norm
Returns normalization factor for specified documents
Method next
Returns next token
Method normalize
Assigns the query normalization factor to this.
Method normalize
Assigns the query normalization factor to this.
Method normalize
Assigns the query normalization factor to this.
Method normalize
Assigns the query normalization factor to this.
o
top
Method openCompoundFile
Opens index file stoted within compound index file
Method optimize
Merges all segments together into a single segment, optimizing an index for search.
Variable TOKTYPE_BRACKET
Token type Bracket.
Variable TOKTYPE_FIELD
Token type Field.
Variable TOKTYPE_SIGN
Token type Sign.
Variable TOKTYPE_WORD
Token type Word.
p
top
Variable $proxPointer
Data offset in a Positions file.
Method parse
Parses a query string, returning a Zend_Search_Lucene_Search_Query
Page Phrase.php
Phrase.php in Phrase.php
Page Phrase.php
Phrase.php in Phrase.php
q
top
Method queryNorm
Implemented as '1/sqrt(sumOfSquaredWeights)'.
Method queryNorm
Computes the normalization value for a query given the sum of the squared weights of each of the query terms. This value is then multipled into the weight of each query term.
Page QueryHit.php
QueryHit.php in QueryHit.php
Page QueryParser.php
QueryParser.php in QueryParser.php
Page QueryTokenizer.php
QueryTokenizer.php in QueryTokenizer.php
Page QueryToken.php
QueryToken.php in QueryToken.php
Page Query.php
Query.php in Query.php
r
top
Method rewind
Resets token stream.
Method readBinary
Reads binary data from the current position in the file and advances the file pointer.
Method readByte
Reads a byte from the current position in the file and advances the file pointer.
Method readBytes
Read num bytes from the current position in the file and advances the file pointer.
Method readInt
Reads an integer from the current position in the file and advances the file pointer.
Method readLong
Returns a long integer from the current position in the file and advances the file pointer.
Method readString
Reads a string from the current position in the file and advances the file pointer.
Method readVInt
Returns a variable-length integer from the current position in the file and advances the file pointer.
Method renameFile
Renames an existing file in the directory.
Method renameFile
Renames an existing file in the directory.
s
top
Method setDefault
Set the default Analyzer implementation used by indexing code.
Method setPositionIncrement
positionIncrement setter
Variable $storeTermVector
Variable $stringValue
Variable $skipInterval
Expert: The fraction of TermDocs entries stored in skip tables.
Variable $skipOffset
ScipData offset in a Frequencies file.
Variable $storeTermVector
Page SegmentInfo.php
SegmentInfo.php in SegmentInfo.php
Page SegmentWriter.php
SegmentWriter.php in SegmentWriter.php
Variable $score
Score of the hit
Method score
Score specified document
Method score
Score specified document
Method score
Score specified document
Method score
Score specified document
Method setBoost
Sets the boost for this query clause to $boost.
Method setDefault
Set the default Similarity implementation used by indexing and search code.
Method setSlop
Set slop
Method setWeight
Set weight for specified term
Method setWeight
Set weight for specified term
Method sloppyFreq
Computes the amount of a sloppy phrase match, based on an edit distance.
Method sloppyFreq
Implemented as '1/(distance + 1)'.
Method sumOfSquaredWeights
The sum of squared weights of contained query clauses.
Method sumOfSquaredWeights
The sum of squared weights of contained query clauses.
Method sumOfSquaredWeights
The sum of squared weights of contained query clauses.
Method sumOfSquaredWeights
The sum of squared weights of contained query clauses.
Page Similarity.php
Similarity.php in Similarity.php
Method seek
Sets the file position indicator and advances the file pointer.
Method seek
Sets the file position indicator and advances the file pointer.
Method size
Get the size of the already opened file
t
top
Method termDocs
Returns an array of all the documents which contain term.
Method termPositions
Returns an array of all term positions in the documents.
Method terms
Returns an array of all terms in this index.
Method tokenize
Tokenize text to a terms Returns array of Zend_Search_Lucene_Analysis_Token objects
Method tokenize
Tokenize text to a terms Returns array of Zend_Search_Lucene_Analysis_Token objects
Page Text.php
Text.php in Text.php
Page TokenFilter.php
TokenFilter.php in TokenFilter.php
Method Text
Constructs a String-valued Field that is tokenized and indexed, and is stored in the index, for return with hits. Useful for short text fields, like "title" or "subject". Term vector will not be stored for this field.
Page Token.php
Token.php in Token.php
Variable $text
Term value
Page TermInfo.php
TermInfo.php in TermInfo.php
Page Term.php
Term.php in Term.php
Variable $text
Token text.
Variable $type
Token type.
Method tf
Implemented as 'sqrt(freq)'.
Method tf
Computes a score factor based on a term or phrase's frequency in a document. This value is multiplied by the idf(Term, Searcher) factor for each term in the query and these products are then summed to form the initial score for a document.
Page Term.php
Term.php in Term.php
Page Term.php
Term.php in Term.php
Method tell
Get file position.
Method tell
Get file position.
Method touchFile
Sets the modified time of $filename to now.
Method touchFile
Sets the modified time of $filename to now.
u
top
Method undeleteAll
Undeletes all documents currently marked as deleted in this index.
Method UnIndexed
Constructs a String-valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.
Method UnStored
Constructs a String-valued Field that is tokenized and indexed, but that is not stored in the index.
v
top
Method valid
Returns TRUE if a token exists at the current position.
w
top
Page Writer.php
Writer.php in Writer.php
Page Weight.php
Weight.php in Weight.php
Method writeByte
Writes a byte to the end of the file.
Method writeBytes
Writes num bytes of data (all, if $num===null) to the end of the file.
Method writeInt
Writes an integer to the end of file.
Method writeLong
Writes long integer to the end of file
Method writeString
Writes a string to the end of file.
Method writeVInt
Writes a variable-length integer to the end of file.
z
top
Class Zend_Search_Exception
Zend_Search_Exception in Exception.php
Class Zend_Search_Lucene
Zend_Search_Lucene in Lucene.php
Class Zend_Search_Lucene_Exception
Class Zend_Search_Lucene_Analysis_Analyzer
An Analyzer is used to analyze text.
Class Zend_Search_Lucene_Analysis_Analyzer_Common
Common implementation of the Zend_Search_Lucene_Analysis_Analyzer interface.
Class Zend_Search_Lucene_Analysis_Analyzer_Common_Text
Class Zend_Search_Lucene_Analysis_Analyzer_Common_Text_CaseInsensitive
Class Zend_Search_Lucene_Analysis_Token
Class Zend_Search_Lucene_Analysis_TokenFilter
Token filter converts (normalizes) Token ore removes it from a token stream.
Class Zend_Search_Lucene_Analysis_TokenFilter_LowerCase
Lower case Token filter.
Class Zend_Search_Lucene_Document
A Document is a set of fields. Each field has a name and a textual value.
Class Zend_Search_Lucene_Field
A field is a section of a Document. Each field has two parts,
Class Zend_Search_Lucene_Index_FieldInfo
Class Zend_Search_Lucene_Index_SegmentInfo
Class Zend_Search_Lucene_Index_SegmentWriter
Class Zend_Search_Lucene_Index_Term
A Term represents a word from text. This is the unit of search. It is composed of two elements, the text of the word, as a string, and the name of the field that the text occured in, an interned string.
Class Zend_Search_Lucene_Index_TermInfo
A Zend_Search_Lucene_Index_TermInfo represents a record of information stored for a term.
Class Zend_Search_Lucene_Index_Writer
Class Zend_Search_Lucene_Search_Query
Class Zend_Search_Lucene_Search_QueryHit
Class Zend_Search_Lucene_Search_QueryParser
Class Zend_Search_Lucene_Search_QueryToken
Class Zend_Search_Lucene_Search_QueryTokenizer
Class Zend_Search_Lucene_Search_Query_MultiTerm
Class Zend_Search_Lucene_Search_Query_Phrase
A Query that matches documents containing a particular sequence of terms.
Class Zend_Search_Lucene_Search_Query_Term
Class Zend_Search_Lucene_Search_Similarity
Class Zend_Search_Lucene_Search_Similarity_Default
Class Zend_Search_Lucene_Search_Weight
Calculate query weights and build query scorers.
Class Zend_Search_Lucene_Search_Weight_MultiTerm
Class Zend_Search_Lucene_Search_Weight_Phrase
Class Zend_Search_Lucene_Search_Weight_Term
Class Zend_Search_Lucene_Storage_Directory
Class Zend_Search_Lucene_Storage_Directory_Filesystem
FileSystem implementation of Directory abstraction.
Class Zend_Search_Lucene_Storage_File
Class Zend_Search_Lucene_Storage_File_Filesystem
a b c d e f g h i k l m n o p q r s t u v w z _