Java Doc for CompassSearchController.java in  » Search-Engine » compass-2.0 » org » compass » spring » web » mvc » 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 » compass 2.0 » org.compass.spring.web.mvc 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.compass.spring.web.mvc.AbstractCompassCommandController
   org.compass.spring.web.mvc.CompassSearchController

CompassSearchController
public class CompassSearchController extends AbstractCompassCommandController (Code)

A general Spring's MVC Controller that perform the search operation of Compass.

Will perform the search operation on the Compass instance using the query supplied by the CompassSearchCommand .

Pagination can be enabled by setting the pageSize property on the controller, as well as providing the page number property on the CompassSearchCommand .

The controller has two views to be set, the searchView, which is the view that holds the screen which the user will initiate the search operation, and the searchResultsView, which will show the results of the search operation (they can be the same page).

The results of the search operation will be saved under the searchResultsName, which defaults to "searchResults".

In order to extend and execute additional operations during the search process org.compass.core.support.search.CompassSearchHelper should be extended and set using CompassSearchController.setSearchHelper(org.compass.core.support.search.CompassSearchHelper) .
author:
   kimchy




Constructor Summary
public  CompassSearchController()
    

Method Summary
public  voidafterPropertiesSet()
    
public  IntegergetPageSize()
     Sets the page size for the pagination of the results.
public  StringgetSearchResultsName()
     Returns the name of the results that the org.compass.core.support.search.CompassSearchResults will be saved under.
public  StringgetSearchResultsView()
     Returns the view which will show the results of the search operation.
public  StringgetSearchView()
     Returns the view that holds the screen which the user will initiate the search operation.
protected  ModelAndViewhandle(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors)
    
public  voidsetPageSize(Integer pageSize)
     Returns the page size for the pagination of the results.
public  voidsetSearchHelper(CompassSearchHelper searchHelper)
    

The search helper is used to execute teh actual search.

public  voidsetSearchResultsName(String searchResultsName)
     Sets the name of the results that the org.compass.core.support.search.CompassSearchResults will be saved under.
public  voidsetSearchResultsView(String resultsView)
     Sets the view which will show the results of the search operation.
public  voidsetSearchView(String searchView)
     Sets the view that holds the screen which the user will initiate the search operation.


Constructor Detail
CompassSearchController
public CompassSearchController()(Code)




Method Detail
afterPropertiesSet
public void afterPropertiesSet() throws Exception(Code)



getPageSize
public Integer getPageSize()(Code)
Sets the page size for the pagination of the results. If not set, not pagination will be used.



getSearchResultsName
public String getSearchResultsName()(Code)
Returns the name of the results that the org.compass.core.support.search.CompassSearchResults will be saved under. Defaults to "searchResults".



getSearchResultsView
public String getSearchResultsView()(Code)
Returns the view which will show the results of the search operation.



getSearchView
public String getSearchView()(Code)
Returns the view that holds the screen which the user will initiate the search operation.



handle
protected ModelAndView handle(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors) throws Exception(Code)



setPageSize
public void setPageSize(Integer pageSize)(Code)
Returns the page size for the pagination of the results. If not set, not pagination will be used.
Parameters:
  pageSize - The page size when using paginated results



setSearchHelper
public void setSearchHelper(CompassSearchHelper searchHelper)(Code)

The search helper is used to execute teh actual search. By default (if not set) the search controller will create a new search helper. If provided, the search controller will use it to perform the search.

Mainly used to extend the search helper and execute additional operation within specific calbacks the search helper exposes.
Parameters:
  searchHelper - A specific search helper to use




setSearchResultsName
public void setSearchResultsName(String searchResultsName)(Code)
Sets the name of the results that the org.compass.core.support.search.CompassSearchResults will be saved under. Defaults to "searchResults".



setSearchResultsView
public void setSearchResultsView(String resultsView)(Code)
Sets the view which will show the results of the search operation.



setSearchView
public void setSearchView(String searchView)(Code)
Sets the view that holds the screen which the user will initiate the search operation.



Methods inherited from org.compass.spring.web.mvc.AbstractCompassCommandController
public void afterPropertiesSet() throws Exception(Code)(Java Doc)
public Compass getCompass()(Code)(Java Doc)
protected CompassTemplate getCompassTemplate()(Code)(Java Doc)
public void setCompass(Compass compass)(Code)(Java Doc)

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