com.liferay.portal.kernel.search

Class BaseOpenSearchImpl

java.lang.Object

com.liferay.portal.kernel.search.BaseOpenSearchImpl

All Implemented Interfaces:

OpenSearch

Direct Known Subclasses:

HitsOpenSearchImpl

public abstract class BaseOpenSearchImpl
extends java.lang.Object
implements OpenSearch

Author:

Charles May, Brian Wing Shun Chan

Constructor Summary

Constructors

Constructor and Description
BaseOpenSearchImpl()
BaseOpenSearchImpl(java.lang.String openSearchURL, java.lang.String openSearchDescriptionURL)

Method Summary

Modifier and Type	Method and Description
protected void	addSearchResult(Element root, long groupId, long scopeGroupId, java.lang.String entryClassName, long entryClassPK, java.lang.String title, java.lang.String link, java.util.Date updated, java.lang.String summary, double score, java.lang.String format)
protected void	addSearchResult(Element root, long groupId, long scopeGroupId, java.lang.String entryClassName, long entryClassPK, java.lang.String title, java.lang.String link, java.util.Date updated, java.lang.String summary, java.lang.String[] tags, double ratings, double score, java.lang.String format)
protected void	addSearchResultAtom(Element root, long groupId, long scopeGroupId, java.lang.String entryClassName, long entryClassPK, java.lang.String title, java.lang.String link, java.util.Date updated, java.lang.String summary, java.lang.String[] tags, double ratings, double score)
protected void	addSearchResultRSS(Element root, long groupId, long scopeGroupId, java.lang.String entryClassName, long entryClassPK, java.lang.String title, java.lang.String link, java.util.Date updated, java.lang.String summary, java.lang.String[] tags, double ratings, double score)
protected java.lang.Object[]	addSearchResults(java.lang.String[] queryTerms, java.lang.String keywords, int startPage, int itemsPerPage, int total, int start, java.lang.String title, java.lang.String searchPath, java.lang.String format, ThemeDisplay themeDisplay)
protected java.lang.Object[]	addSearchResultsAtom(Document doc, java.lang.String[] queryTerms, java.lang.String keywords, int startPage, int itemsPerPage, int total, int start, int totalPages, int previousPage, int nextPage, java.lang.String title, java.lang.String searchPath, ThemeDisplay themeDisplay)
protected java.lang.Object[]	addSearchResultsRSS(Document doc, java.lang.String[] queryTerms, java.lang.String keywords, int startPage, int itemsPerPage, int total, int start, int totalPages, int previousPage, int nextPage, java.lang.String title, java.lang.String searchPath, ThemeDisplay themeDisplay)
java.lang.String	getClassName()
protected java.lang.String	getOpenSearchDescriptionURL(java.lang.String searchPath, ThemeDisplay themeDisplay)
protected java.lang.String	getOpenSearchURL(java.lang.String searchPath, ThemeDisplay themeDisplay)
protected long	getPlid(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String portletId, long scopeGroupId)
protected javax.portlet.PortletURL	getPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String portletId)
protected javax.portlet.PortletURL	getPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String portletId, long scopeGroupId)
protected javax.portlet.PortletURL	getPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String className, PortletProvider.Action action, long scopeGroupId)
boolean	isEnabled()
abstract java.lang.String	search(javax.servlet.http.HttpServletRequest httpServletRequest, long groupId, long userId, java.lang.String keywords, int startPage, int itemsPerPage, java.lang.String format)
java.lang.String	search(javax.servlet.http.HttpServletRequest httpServletRequest, long userId, java.lang.String keywords, int startPage, int itemsPerPage, java.lang.String format)
java.lang.String	search(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String url)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseOpenSearchImpl

public BaseOpenSearchImpl()

BaseOpenSearchImpl

public BaseOpenSearchImpl(java.lang.String openSearchURL,
                          java.lang.String openSearchDescriptionURL)

Method Detail

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in interface OpenSearch

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface OpenSearch

search

public abstract java.lang.String search(javax.servlet.http.HttpServletRequest httpServletRequest,
                                        long groupId,
                                        long userId,
                                        java.lang.String keywords,
                                        int startPage,
                                        int itemsPerPage,
                                        java.lang.String format)
                                 throws SearchException

Specified by:

search in interface OpenSearch

Throws:

SearchException

search

public java.lang.String search(javax.servlet.http.HttpServletRequest httpServletRequest,
                               long userId,
                               java.lang.String keywords,
                               int startPage,
                               int itemsPerPage,
                               java.lang.String format)
                        throws SearchException

Specified by:

search in interface OpenSearch

Throws:

SearchException

search

public java.lang.String search(javax.servlet.http.HttpServletRequest httpServletRequest,
                               java.lang.String url)
                        throws SearchException

Specified by:

search in interface OpenSearch

Throws:

SearchException

addSearchResult

protected void addSearchResult(Element root,
                               long groupId,
                               long scopeGroupId,
                               java.lang.String entryClassName,
                               long entryClassPK,
                               java.lang.String title,
                               java.lang.String link,
                               java.util.Date updated,
                               java.lang.String summary,
                               double score,
                               java.lang.String format)

addSearchResult

protected void addSearchResult(Element root,
                               long groupId,
                               long scopeGroupId,
                               java.lang.String entryClassName,
                               long entryClassPK,
                               java.lang.String title,
                               java.lang.String link,
                               java.util.Date updated,
                               java.lang.String summary,
                               java.lang.String[] tags,
                               double ratings,
                               double score,
                               java.lang.String format)

addSearchResultAtom

protected void addSearchResultAtom(Element root,
                                   long groupId,
                                   long scopeGroupId,
                                   java.lang.String entryClassName,
                                   long entryClassPK,
                                   java.lang.String title,
                                   java.lang.String link,
                                   java.util.Date updated,
                                   java.lang.String summary,
                                   java.lang.String[] tags,
                                   double ratings,
                                   double score)

addSearchResultRSS

protected void addSearchResultRSS(Element root,
                                  long groupId,
                                  long scopeGroupId,
                                  java.lang.String entryClassName,
                                  long entryClassPK,
                                  java.lang.String title,
                                  java.lang.String link,
                                  java.util.Date updated,
                                  java.lang.String summary,
                                  java.lang.String[] tags,
                                  double ratings,
                                  double score)

addSearchResults

protected java.lang.Object[] addSearchResults(java.lang.String[] queryTerms,
                                              java.lang.String keywords,
                                              int startPage,
                                              int itemsPerPage,
                                              int total,
                                              int start,
                                              java.lang.String title,
                                              java.lang.String searchPath,
                                              java.lang.String format,
                                              ThemeDisplay themeDisplay)

addSearchResultsAtom

protected java.lang.Object[] addSearchResultsAtom(Document doc,
                                                  java.lang.String[] queryTerms,
                                                  java.lang.String keywords,
                                                  int startPage,
                                                  int itemsPerPage,
                                                  int total,
                                                  int start,
                                                  int totalPages,
                                                  int previousPage,
                                                  int nextPage,
                                                  java.lang.String title,
                                                  java.lang.String searchPath,
                                                  ThemeDisplay themeDisplay)

addSearchResultsRSS

protected java.lang.Object[] addSearchResultsRSS(Document doc,
                                                 java.lang.String[] queryTerms,
                                                 java.lang.String keywords,
                                                 int startPage,
                                                 int itemsPerPage,
                                                 int total,
                                                 int start,
                                                 int totalPages,
                                                 int previousPage,
                                                 int nextPage,
                                                 java.lang.String title,
                                                 java.lang.String searchPath,
                                                 ThemeDisplay themeDisplay)

getOpenSearchDescriptionURL

protected java.lang.String getOpenSearchDescriptionURL(java.lang.String searchPath,
                                                       ThemeDisplay themeDisplay)

getOpenSearchURL

protected java.lang.String getOpenSearchURL(java.lang.String searchPath,
                                            ThemeDisplay themeDisplay)

getPlid

protected long getPlid(javax.servlet.http.HttpServletRequest httpServletRequest,
                       java.lang.String portletId,
                       long scopeGroupId)
                throws java.lang.Exception

Throws:

java.lang.Exception

getPortletURL

protected javax.portlet.PortletURL getPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                 java.lang.String portletId)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getPortletURL

protected javax.portlet.PortletURL getPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                 java.lang.String portletId,
                                                 long scopeGroupId)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getPortletURL

protected javax.portlet.PortletURL getPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                 java.lang.String className,
                                                 PortletProvider.Action action,
                                                 long scopeGroupId)
                                          throws java.lang.Exception

Throws:

java.lang.Exception