Java Doc for SearchPluginBase.java in  » Blogger-System » apache-roller-3.1 » org » apache » roller » ui » rendering » plugins » 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 » Blogger System » apache roller 3.1 » org.apache.roller.ui.rendering.plugins 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.roller.ui.rendering.plugins.SearchPluginBase

All known Subclasses:   org.apache.roller.ui.rendering.plugins.WikipediaLinkPlugin,  org.apache.roller.ui.rendering.plugins.GoogleLinkPlugin,
SearchPluginBase
abstract public class SearchPluginBase (Code)
Implements the common portion of search link plugins.
author:
   Anil Gangolli
version:
   2.1



Constructor Summary
public  SearchPluginBase()
     Instantiation is per request.

Method Summary
abstract public  StringgetDescription()
     Briefly describes the function of the Plugin.
abstract protected  MessageFormatgetLinkFormat()
     The MessageFormat for the replacement string (actual HTML link) that will form the replacement in the regular (non-"lucky") case.
abstract protected  LoggetLogger()
     Return the logger for this class.
abstract protected  MessageFormatgetLuckyLinkFormat()
     The MessageFormat for the replacement string (actual HTML link) that will form the replacement in the "lucky" case.
abstract public  StringgetName()
     Returns the human-friendly name of this Plugin.
abstract protected  PatterngetPattern()
     Get the regexp pattern for finding search links in the input text.
abstract protected  StringgetVersion()
     Return the implementation version.
public  voidinit(WebsiteData website)
     Initialize.
public  Stringrender(WeblogEntryData entry, String str)
     Apply plugin to content of specified String.
Parameters:
  str - String to which plugin should be applied.


Constructor Detail
SearchPluginBase
public SearchPluginBase()(Code)
Instantiation is per request.




Method Detail
getDescription
abstract public String getDescription()(Code)
Briefly describes the function of the Plugin. May contain HTML. A brief description of the Plugin.
See Also:   org.apache.roller.model.PagePlugin.getDescription



getLinkFormat
abstract protected MessageFormat getLinkFormat()(Code)
The MessageFormat for the replacement string (actual HTML link) that will form the replacement in the regular (non-"lucky") case. This must have two positional parameters "{2} and {3}" which are the link text and (URL-encoded) search text from the regexp pattern. Note that the parameters "{0}" and "{1}" are not used. They will be empty strings. the message format for non-"lucky" search links.



getLogger
abstract protected Log getLogger()(Code)
Return the logger for this class. the logger for this class.



getLuckyLinkFormat
abstract protected MessageFormat getLuckyLinkFormat()(Code)
The MessageFormat for the replacement string (actual HTML link) that will form the replacement in the "lucky" case. This must have two positional parameters "{2} and {3}" which are the link text and (URL-encoded) search text from the regexp pattern. Note that the parameters "{0}" and "{1}" are not used. They will be empty strings. the message format for "lucky" search links.



getName
abstract public String getName()(Code)
Returns the human-friendly name of this Plugin. This is what users will see. The human-friendly name of this Plugin.
See Also:   org.apache.roller.model.PagePlugin.getName



getPattern
abstract protected Pattern getPattern()(Code)
Get the regexp pattern for finding search links in the input text. Three matching groups are expected: (1) The lucky or not indicator (either ! or :) (2) the link text (3) the search text (optional, defaults to the link text). the regexp pattern for finding search links in the input text



getVersion
abstract protected String getVersion()(Code)
Return the implementation version. the implementation version.



init
public void init(WebsiteData website) throws RollerException(Code)
Initialize. Called once for each request.
See Also:    org.apache.roller.model.PagePlugin#init(WebsiteData, Object, String baseUrl, org.apache.velocity.context.Context)



render
public String render(WeblogEntryData entry, String str)(Code)
Apply plugin to content of specified String.
Parameters:
  str - String to which plugin should be applied. Results of applying plugin to string.
See Also:   org.apache.roller.model.PagePlugin.render(String)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(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.