Java Doc for TermPositions.java in  » Search-Engine » lucene » org » apache » lucene » index » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Search Engine » lucene » org.apache.lucene.index 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.lucene.index.TermPositions

All known Subclasses:   org.apache.lucene.index.SegmentTermPositions,  org.apache.lucene.index.MultipleTermPositions,
TermPositions
public interface TermPositions extends TermDocs(Code)
TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term.

The document and frequency are the same as for a TermDocs. The positions portion lists the ordinal positions of each occurrence of a term in a document.
See Also:   IndexReader.termPositions





Method Summary
 byte[]getPayload(byte[] data, int offset)
     Returns the payload data at the current term position. This is invalid until TermPositions.nextPosition() is called for the first time. This method must not be called more than once after each call of TermPositions.nextPosition() .
 intgetPayloadLength()
     Returns the length of the payload at the current term position.
public  booleanisPayloadAvailable()
     Checks if a payload can be loaded at this position.
 intnextPosition()
     Returns next position in the current document.



Method Detail
getPayload
byte[] getPayload(byte[] data, int offset) throws IOException(Code)
Returns the payload data at the current term position. This is invalid until TermPositions.nextPosition() is called for the first time. This method must not be called more than once after each call of TermPositions.nextPosition() . However, payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons.

Parameters:
  data - the array into which the data of this payload is to bestored, if it is big enough; otherwise, a new byte[] arrayis allocated for this purpose.
Parameters:
  offset - the offset in the array into which the data of this payloadis to be stored. a byte[] array containing the data of this payload
throws:
  IOException -



getPayloadLength
int getPayloadLength()(Code)
Returns the length of the payload at the current term position. This is invalid until TermPositions.nextPosition() is called for the first time.
length of the current payload in number of bytes



isPayloadAvailable
public boolean isPayloadAvailable()(Code)
Checks if a payload can be loaded at this position.

Payloads can only be loaded once per call to TermPositions.nextPosition() . true if there is a payload available at this position that can be loaded




nextPosition
int nextPosition() throws IOException(Code)
Returns next position in the current document. It is an error to call this more than TermPositions.freq() times without calling TermPositions.next()

This is invalid until TermPositions.next() is called for the first time.




www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.