ClassInterface Zend_Search_Lucene_Index_TermsStream_Interface

Description
Description | Descendents | Methods (details)
  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Search/Lucene/Index/TermsStream/Interface.php (line 30) 


	
			




	
	

		
Direct descendents

		

			Description |
			Descendents
			|															Methods (details)
							
								

		

			

				

					Class
					Description
				

								

					
						 class
						Zend_Search_Lucene_Interface
					
					
											
										
				

							

		

	




	
	

		
Method Summary

		

			Description |
							Descendants |
												Methods (details)
		

		
			
			

																																																							
				

					 
											void
										closeTermsStream
										()
									

															
				

					 
											Zend_Search_Lucene_Index_Term|null
										currentTerm
										()
									

															
				

					 
											Zend_Search_Lucene_Index_Term|null
										nextTerm
										()
									

															
				

					 
											void
										resetTermsStream
										()
									

															
				

					 
											void
										skipTo
											(Zend_Search_Lucene_Index_Term $prefix)
									

											

		

	
		

	
	
	

		
Methods

		

			Description |
							Descendents |
																Methods (details)
						
		

		

			



	
	

		
		closeTermsStream (line 65)
	
 
	
	

Close terms stream


Should be used for resources clean up if stream is not read up to the end

	
    
				
  • access: public
    • 
			

	
	

		void
		
			closeTermsStream
		
				()
			

	
		
			
	




	
	

		
		currentTerm (line 58)
	
 
	
	

Returns term in current position

	
    
				
  • access: public
    • 
			

	
	

		Zend_Search_Lucene_Index_Term|null
		
			currentTerm
		
				()
			

	
		
			
	




	
	

		
		nextTerm (line 51)
	
 
	
	

Scans terms dictionary and returns next term

	
    
				
  • access: public
    • 
			

	
	

		Zend_Search_Lucene_Index_Term|null
		
			nextTerm
		
				()
			

	
		
			
	




	
	

		
		resetTermsStream (line 35)
	
 
	
	

Reset terms stream.

	
    
				
  • access: public
    • 
			

	
	

		void
		
			resetTermsStream
		
				()
			

	
		
			
	




	
	

		
		skipTo (line 44)
	
 
	
	

Skip terms stream up to specified term preffix.


Prefix contains fully specified field info and portion of searched term

	
    
				
  • access: public
    • 
			

	
	

		void
		
			skipTo
		
					(Zend_Search_Lucene_Index_Term $prefix)
			

	
			
		
			
	

						
		

	


	
	

		Documentation generated on Mon, 21 Jun 2010 15:29:40 -0400 by phpDocumentor 1.4.3