Java Doc for IndexQuery.java in  » Search-Engine » Jofti » com » jofti » api » 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 » Jofti » com.jofti.api 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.jofti.api.IndexQuery

All known Subclasses:   com.jofti.query.EJBQuery,  com.jofti.query.namespace.MatchNSInQuery,  com.jofti.query.SQLQuery,  com.jofti.query.MatchInQuery,  com.jofti.parser.SQLQueryWrapper,  com.jofti.query.MatchNotQuery,  com.jofti.parser.ParsedQueryWrapper,  com.jofti.parser.ParsedQuery,  com.jofti.query.namespace.MatchNSNotQuery,  com.jofti.query.MatchQuery,  com.jofti.query.Query,  com.jofti.query.namespace.MatchNSQuery,  com.jofti.query.namespace.MatchNSRangeQuery,  com.jofti.query.MatchRangeQuery,
IndexQuery
public interface IndexQuery (Code)
Root interface for query objects. All IndexQueries will implement this interface, but not all are required to provide implementations of the optional parameter setting methods.


author:
   Steve Woodcock

version:
   1.7





Method Summary
public  IndexQuerysetFirstResult(int firstResult)
    

Sets the first result number to be returned.

public  IndexQuerysetMaxResults(int maxResults)
    

Sets a maximum number of results to return in the query.

public  IndexQuerysetParameter(String name, Object value)
    

Sets a parameter on a Query by name.

public  IndexQuerysetParameter(int position, Object value)
    

Sets a parameter on a Query by name.




Method Detail
setFirstResult
public IndexQuery setFirstResult(int firstResult)(Code)

Sets the first result number to be returned. If this is used in conjunction with maxResults then a paging type mechanism can be emulated (providing the results are ordered). A negative value will result in a runtimeException and setting the value larger than the number of results will result in zero results returned.

The method returns the IndexQuery in order to allow method chaining for parameter setting.


Parameters:
  firstResult - - the position of the first result - this is 0 indexed. - The indexQuery that the parameter was set on.



setMaxResults
public IndexQuery setMaxResults(int maxResults)(Code)

Sets a maximum number of results to return in the query. If the results are not ordered then repeated calling of the method could return different results irrespective of data changes.

When ordering is set repeated calls with this value set will return the same results providing that the data has not changed. However, in order to provide ordering the full result set must be evaluated and are therefore loaded into memory. The results falling outside the return range will then be discarded.

A negative value will return a runtime IllegalArgumentException. Zero is equivalent to all results. Setting the value to more than the number of results found will results in all results being returned. The method returns the IndexQuery in order to allow method chaining for parameter setting.


Parameters:
  maxResults - - the maximum number of results to return. - The indexQuery that the parameter was set on.



setParameter
public IndexQuery setParameter(String name, Object value)(Code)

Sets a parameter on a Query by name. The name should match a String representation of the parameter in the query implementation. The format of the name is defined by the type of query.

The method returns the IndexQuery in order to allow method chaining for parameter setting.


Parameters:
  name - - the name for the parameter.
Parameters:
  value - - the Object that is used to bind to the parameter. - The indexQuery that the parameter was set on.



setParameter
public IndexQuery setParameter(int position, Object value)(Code)

Sets a parameter on a Query by name. The name should match the numeric position of the parameter in the query implmentation. The format of the name is defined by the type of query.

The method returns the IndexQuery in order to allow method chaining for parameter setting.


Parameters:
  position - - the position for the parameter.
Parameters:
  value - - the Object that is used to bind to the parameter. - The indexQuery that the parameter was set on.



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