com.vportal.portal.search.HitsOpenSearchImpl.java Source code

Introduction

Here is the source code for com.vportal.portal.search.HitsOpenSearchImpl.java

Source

/**
 * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.vportal.portal.search;

import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.search.BaseOpenSearchImpl;
import com.liferay.portal.kernel.search.Document;
import com.liferay.portal.kernel.search.Field;
import com.liferay.portal.kernel.search.Hits;
import com.liferay.portal.kernel.search.Indexer;
import com.liferay.portal.kernel.search.SearchContext;
import com.liferay.portal.kernel.search.SearchContextFactory;
import com.liferay.portal.kernel.search.SearchException;
import com.liferay.portal.kernel.search.Summary;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.kernel.util.WebKeys;
import com.liferay.portal.kernel.xml.Element;
import com.liferay.portal.model.Portlet;
import com.liferay.portal.service.PortletLocalServiceUtil;
import com.liferay.portal.theme.ThemeDisplay;
import com.liferay.portlet.ratings.model.RatingsStats;
import com.liferay.portlet.ratings.service.RatingsStatsLocalServiceUtil;

import java.util.Date;

import javax.portlet.PortletURL;

import javax.servlet.http.HttpServletRequest;

/**
 * @author Charles May
 * @author Brian Wing Shun Chan
 */
public abstract class HitsOpenSearchImpl extends BaseOpenSearchImpl {

    public abstract String getPortletId();

    public abstract String getSearchPath();

    public abstract Hits getHits(long companyId, long groupId, String keywords, int start, int end)
            throws Exception;

    public Summary getSummary(Indexer indexer, Document document, String snippet, PortletURL portletURL) {

        return indexer.getSummary(document, snippet, portletURL);
    }

    public abstract String getTitle(String keywords);

    public String search(HttpServletRequest request, long groupId, long userId, String keywords, int startPage,
            int itemsPerPage, String format) throws SearchException {

        try {
            ThemeDisplay themeDisplay = (ThemeDisplay) request.getAttribute(WebKeys.THEME_DISPLAY);

            int start = (startPage * itemsPerPage) - itemsPerPage;
            int end = startPage * itemsPerPage;

            SearchContext searchContext = SearchContextFactory.getInstance(request);

            searchContext.setGroupIds(new long[] { groupId });
            searchContext.setEnd(end);
            searchContext.setKeywords(keywords);
            searchContext.setScopeStrict(false);
            searchContext.setStart(start);
            searchContext.setUserId(userId);

            addSearchAttributes(themeDisplay.getCompanyId(), searchContext, keywords);

            Portlet portlet = PortletLocalServiceUtil.getPortletById(themeDisplay.getCompanyId(), getPortletId());

            Indexer indexer = portlet.getIndexerInstance();

            Hits results = indexer.search(searchContext);

            String[] queryTerms = results.getQueryTerms();

            int total = results.getLength();

            Object[] values = addSearchResults(queryTerms, keywords, startPage, itemsPerPage, total, start,
                    getTitle(keywords), getSearchPath(), format, themeDisplay);

            com.liferay.portal.kernel.xml.Document doc = (com.liferay.portal.kernel.xml.Document) values[0];
            Element root = (Element) values[1];

            for (int i = 0; i < results.getDocs().length; i++) {
                Document result = results.doc(i);

                String portletId = result.get(Field.PORTLET_ID);

                String snippet = results.snippet(i);

                long resultGroupId = GetterUtil.getLong(result.get(Field.GROUP_ID));

                PortletURL portletURL = getPortletURL(request, portletId, resultGroupId);

                Summary summary = getSummary(indexer, result, snippet, portletURL);

                String title = summary.getTitle();
                String url = getURL(themeDisplay, resultGroupId, result, portletURL);
                Date modifedDate = result.getDate(Field.MODIFIED);
                String content = summary.getContent();

                String[] tags = new String[0];

                Field assetTagNamesField = result.getFields().get(Field.ASSET_TAG_NAMES);

                if (assetTagNamesField != null) {
                    tags = assetTagNamesField.getValues();
                }

                double ratings = 0.0;

                String entryClassName = result.get(Field.ENTRY_CLASS_NAME);
                long entryClassPK = GetterUtil.getLong(result.get(Field.ENTRY_CLASS_PK));

                if ((Validator.isNotNull(entryClassName)) && (entryClassPK > 0)) {

                    RatingsStats stats = RatingsStatsLocalServiceUtil.getStats(entryClassName, entryClassPK);

                    ratings = stats.getTotalScore();
                }

                double score = results.score(i);

                addSearchResult(root, resultGroupId, entryClassName, entryClassPK, title, url, modifedDate, content,
                        tags, ratings, score, format);
            }

            if (_log.isDebugEnabled()) {
                _log.debug("Return\n" + doc.asXML());
            }

            return doc.asXML();
        } catch (Exception e) {
            throw new SearchException(e);
        }
    }

    protected void addSearchAttributes(long companyId, SearchContext searchContext, String keywords) {
    }

    protected String getURL(ThemeDisplay themeDisplay, long groupId, Document result, PortletURL portletURL)
            throws Exception {

        return portletURL.toString();
    }

    private static Log _log = LogFactoryUtil.getLog(HitsOpenSearchImpl.class);

}