lucene search in liferay on custom portlet ~ Getting into Liferay

This Topic is all about Indexing and Searching at application level for the portal, so far we've heard about indexing at database level. Indexing at database level is a data structure that improve the speed of data retrieval operation on data base table at the cost of slower writes and less storage space.

Indices can be created using one or more columns of a database table, providing the facility for random look up of record. But if we need to index at application level then apache lucene is a great feature to use.

Liferay by default support lucene for indexing and searching for data at application level. Apache Lucene is a high-performance, full-featured text search engine library written entirely in Java and it is open source. Any application which is require full-text search, cross-platform Apache Lucene is a great tool to use.

following steps will cover how we will search and index for custom portal data at application level.

Steps 1 : create any custom portlet and create service.xml file as we need to search custom table data through out the portal.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE service-builder PUBLIC "-//Liferay//DTD Service Builder 6.2.0//EN" "http://www.liferay.com/dtd/liferay-service-builder_6_2_0.dtd">
<service-builder package-path="com.liferay.slayer">
 <author>Admin</author>
 <namespace>foo</namespace>

 <entity name="Employee" local-service="true" remote-service="true">

  <!-- PK fields -->

  <column name="employeeId" type="long" primary="true" />

  <!-- Group instance -->

  <column name="groupId" type="long" />

  <!-- Audit fields -->

  <column name="companyId" type="long" />
  <column name="userId" type="long" />
  <column name="userName" type="String" />
  <column name="createDate" type="Date" />
  <column name="modifiedDate" type="Date" />

  <!-- Other fields -->

  <column name="employeeName" type="String" />
  <column name="employeeAddress" type="String" />

 </entity>
</service-builder>

Step 2 : In your liferay-portlet.xml file put this entry for new indexer class

<indexer-class>com.liferay.search.EmployeeIndexer</indexer-class>

This entry should be in pattern how its display below :

<portlet>
<portlet-name>LucenSearchProject</portlet-name>
<icon>/icon.png</icon>
<indexer-class>com.liferay.search.EmployeeIndexer</indexer-class>
<header-portlet-css>/css/main.css</header-portlet-css>
<footer-portlet-javascript>/js/main.js</footer-portlet-javascript>
<css-class-wrapper>LucenSearchProject-portlet</css-class-wrapper>
</portlet>

the above class entry in liferay-portlet.xml is the class which will help in indexing and searching of the Portlet's data. May be while you put this entry in liferay-portlet.xml file it can give error like class not found t specified path. so lets create this class at package com.liferay.search.

Step 3 : Create a class EmployeeIndexer inside package com.liferay.search. This class should extend BaseIndexer class and overwrite some of basic method as shown below. There are total of nine methods – two of them public and seven protected.

package com.liferay.search;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Locale;

import javax.portlet.PortletURL;

import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.search.BaseIndexer;
import com.liferay.portal.kernel.search.Document;
import com.liferay.portal.kernel.search.DocumentImpl;
import com.liferay.portal.kernel.search.Field;
import com.liferay.portal.kernel.search.Indexer;
import com.liferay.portal.kernel.search.SearchContext;
import com.liferay.portal.kernel.search.SearchEngineUtil;
import com.liferay.portal.kernel.search.Summary;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.slayer.model.Employee;
import com.liferay.slayer.service.EmployeeLocalServiceUtil;

public class EmployeeIndexer extends BaseIndexer{

 public static final String[] CLASS_NAMES = { Employee.class.getName() };
 public static final String PORTLET_ID = "book_WAR_Bookportlet";
 public static int COUNT = getCount(); 
  
 public static int getCount() {
  int count = 1;
  try {
   count = EmployeeLocalServiceUtil.getEmployeesCount();
  } catch (SystemException e) {
   e.printStackTrace();
  }
  return count;
 }
  
 @Override
 public String[] getClassNames() {
  return CLASS_NAMES;
 }

 @Override
 public String getPortletId() {
  return PORTLET_ID;
 }

 @Override
 protected void doDelete(Object arg0) throws Exception {
  Employee sample = (Employee) arg0;
  Document document = new DocumentImpl();
  document.addUID(PORTLET_ID, sample.getEmployeeId());
  String searchEngineId = SearchEngineUtil.getDefaultSearchEngineId();
  SearchEngineUtil.deleteDocument(searchEngineId, sample.getCompanyId(),document.get(Field.UID));
  reindexSamplesDelete(sample.getCompanyId());
 }

 @Override
 protected Document doGetDocument(Object arg0) throws Exception {
  Employee sample = (Employee) arg0;
  long groupId = getParentGroupId(sample.getGroupId());
  long scopeGroupId = sample.getGroupId();
  long companyId = sample.getCompanyId(); 
  String description = sample.getEmployeeAddress();
  String title = sample.getEmployeeName();
  Document document = getBaseModelDocument(PORTLET_ID, sample);
  document.addKeyword(Field.COMPANY_ID, companyId);
  document.addKeyword(Field.GROUP_ID, groupId);
  document.addKeyword(Field.SCOPE_GROUP_ID, scopeGroupId);
    
  document.addText(Field.DESCRIPTION, description);
  document.addKeyword("employeeId", sample.getEmployeeId());
  document.addText(Field.TITLE, title);
  return document;
 }
 protected Document getDocumentUpdate(Object arg0) throws Exception {
  Employee sample = (Employee) arg0;
  long groupId = getParentGroupId(sample.getGroupId());
  long scopeGroupId = sample.getGroupId();
  long companyId= sample.getCompanyId(); 
  String description = sample.getEmployeeAddress();
  String title = sample.getEmployeeName();
  Document document = getBaseModelDocument(PORTLET_ID, sample);
  document.addKeyword(Field.COMPANY_ID, companyId);
  document.addKeyword(Field.GROUP_ID, groupId);
  document.addKeyword(Field.SCOPE_GROUP_ID, scopeGroupId);
    
  document.addText(Field.DESCRIPTION, description);
  document.addKeyword("employeeId", sample.getEmployeeId());
  document.addText(Field.TITLE, title);
  return document;
 }
 @Override
 protected Summary doGetSummary(Document arg0, Locale arg1, String arg2,
   PortletURL arg3) throws Exception {
  long employeeId = GetterUtil.getLong(arg0.get("employeeId"));
    System.out.println("Employee Detail is as follows -: "+employeeId);
    Employee employee = null;
    List<employee> totalRecord = new ArrayList<employee>();
    if(employeeId > 0) {
     employee = EmployeeLocalServiceUtil.fetchEmployee(employeeId);
    }
    String title = arg0.get(Field.TITLE);
    String content = arg2;
    List<employee> emplList = null;
    
    emplList = EmployeeLocalServiceUtil.getEmployees(0, -1);
    for(Employee tr:emplList) { 
     totalRecord.add(tr);     
    }
    int pos = totalRecord.indexOf(employee) + 1;
    if(pos > 0) {
     int page = pos/10;
     if(pos%10 > 0) {
      page = page + 1;
     }
     if(page == 0) {
      page = 1;
     }
     arg3.setParameter("cur", String.valueOf(page));
    }
    return new Summary( title, content, arg3);
 }

 @Override
 protected void doReindex(Object arg0) throws Exception {
   Employee sample = (Employee) arg0;
   String searchEngineId = SearchEngineUtil.getDefaultSearchEngineId();
   SearchEngineUtil.updateDocument(searchEngineId, sample.getCompanyId(),getDocument(sample));
   reindexSamplesDelete(sample.getCompanyId());
  
 }
 protected void doReindexUpdate(Object arg0) throws Exception {
  Employee sample = (Employee) arg0;
  String searchEngineId = SearchEngineUtil.getDefaultSearchEngineId();
  SearchEngineUtil.updateDocument(searchEngineId, sample.getCompanyId(),getDocumentUpdate(sample));
 }
 @Override
 protected void doReindex(String[] arg0) throws Exception {
  long companyId = GetterUtil.getLong(arg0[0]);
  doReindexAll(companyId);
 }
 private void doReindexAll(long companyId) throws Exception {
  int count = EmployeeLocalServiceUtil.getEmployeesCount();
  int pages = count / Indexer.DEFAULT_INTERVAL;
  for (int i = 0; i <= pages; i++) {
   int start = (i * Indexer.DEFAULT_INTERVAL);
   int end = start + Indexer.DEFAULT_INTERVAL;
   reindexSamples(companyId, start, end);
  }
 }
 @Override
 protected void doReindex(String arg0, long arg1) throws Exception {
  Employee sample = EmployeeLocalServiceUtil.getEmployee(arg1);
  doReindex(sample);
 }

 @Override
 protected String getPortletId(SearchContext arg0) {
  return PORTLET_ID;
 }
 protected void reindexSamples(long companyId, int start, int end) throws Exception {
  List<employee> samples= EmployeeLocalServiceUtil.getEmployees(start, end);
  if ( samples.isEmpty()) {
   return;
  }
  Collection<document> documents = new ArrayList<document>();
  COUNT = 1;
  for (Employee sample: samples) {
   Document document = getDocument( sample);
   document.addText("count", String.valueOf(COUNT++));
   documents.add(document);
  }
  String searchEngineId = SearchEngineUtil.getDefaultSearchEngineId();
  SearchEngineUtil.updateDocuments(searchEngineId, companyId, documents);
 }
 public void reindexSamplesDelete(long companyId) throws Exception {
  List<employee> samples= EmployeeLocalServiceUtil.getEmployees(-1, -1);
  if ( samples.isEmpty()) {
   return;
  }
  Collection<document> documents = new ArrayList<document>();
  COUNT = 1;
  for (Employee sample: samples) {
   Document document = getDocument( sample);
   document.addText("count", String.valueOf(COUNT++));
   documents.add(document);
  }
  String searchEngineId = SearchEngineUtil.getDefaultSearchEngineId();
  SearchEngineUtil.updateDocuments(searchEngineId, companyId, documents);
 }
}

Step 3 : After this our next step is to index our record whenever we insert any employee to our table it should be index so that the next time if we search our employee by its name or its address its should search. This kind of searching from the index is going to drastically improve the performance so for this open your Action Class or Controller class. In my case i have added this in my controller class below is the code for this :

package com.liferay.portlet;

import java.io.IOException;

import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;
import javax.portlet.PortletException;

import com.liferay.counter.service.CounterLocalServiceUtil;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.search.Indexer;
import com.liferay.portal.kernel.search.IndexerRegistryUtil;
import com.liferay.portal.kernel.search.SearchException;
import com.liferay.portal.kernel.util.ParamUtil;
import com.liferay.portal.service.UserLocalServiceUtil;
import com.liferay.portal.util.PortalUtil;
import com.liferay.slayer.model.Employee;
import com.liferay.slayer.model.impl.EmployeeImpl;
import com.liferay.slayer.service.EmployeeLocalServiceUtil;
import com.liferay.util.bridges.mvc.MVCPortlet;

public class EmployeeController extends MVCPortlet {

 public void addEmployee(ActionRequest actionRequest, ActionResponse actionResponse) throws IOException, PortletException {
     
  String employeeName = ParamUtil.getString(actionRequest, "employeeName");
  String employeeAddress = ParamUtil.getString(actionRequest, "employeeAddress");
  long employeeId = 0l;
  try {
   employeeId = CounterLocalServiceUtil.increment(Employee.class.getName());
  } catch (SystemException e1) {
   e1.printStackTrace();
  }
    
  Employee employee = new EmployeeImpl();
  String userName = "";
  long groupId = 0l;
  try {
   groupId = PortalUtil.getScopeGroupId(actionRequest);
  } catch (PortalException e2) {
   e2.printStackTrace();
  } catch (SystemException e2) {
   e2.printStackTrace();
  }
  employee.setEmployeeId(employeeId);;
  employee.setCompanyId(PortalUtil.getCompanyId(actionRequest));
  employee.setGroupId(groupId);
  employee.setUserId(PortalUtil.getUserId(actionRequest));
  try {
   userName = UserLocalServiceUtil.getUser(PortalUtil.getUserId(actionRequest)).getFullName();
  } catch (PortalException e1) {
   e1.printStackTrace();
  } catch (SystemException e1) {
   e1.printStackTrace();
  }
  employee.setUserName(userName);
  employee.setEmployeeName(employeeName);;
  employee.setEmployeeAddress(employeeAddress);;
  try {
   EmployeeLocalServiceUtil.addEmployee(employee);
  } catch (SystemException e) {
   e.printStackTrace();
  }
  Indexer indexer = IndexerRegistryUtil.getIndexer(Employee.class);
  try {
   indexer.reindex(employee);
  } catch (SearchException e) {
   e.printStackTrace();
  }
 }
}

below is my JSP for calling this controller

<%@page import="javax.portlet.PortletURL"%>
<%@taglib uri="http://java.sun.com/portlet_2_0" prefix="portlet"%>
<%@taglib uri="http://alloy.liferay.com/tld/aui" prefix="aui"%>
<portlet:defineObjects/>
<%
 PortletURL addbook = renderResponse.createActionURL();
 addbook.setParameter(actionRequest.ACTION_NAME, "addEmployee");
%>


<aui:form name="fm" action="<%=addbook.toString() %>">
 <aui:input name="employeeName" type="text"></aui:input>
 <aui:input name="employeeAddress" type="textarea"></aui:input>
 <aui:button name="submit" type="submit"></aui:button>
</aui:form>

Step 4 : Now go to your liferay portal page and from add application add liferay search tool portlet to your page. as shown below :

then go click on configuration tab of the search tool portlet you will see a screen like shown below :

Now at end add your model class Name as i have added for my employee model in the above image .

This is it, all you have to do is now insert any record from you portlet and search it from search tool portlet you should see your record in search result as i have added a employee with name "Jhon Dane" and then search with search tool portlet, result is as shown below :

Note : Some time it happen like after inserting record also it wont index our record and search from search tool so in that case do indexing manually, for this navigate to control panel and go for this path Control Panel>Apps>App Manager>Manage

In Manage tab you will see all the portlet available to the portal. Navigate to the page where your portlet is available now in the action tab you should see the option for ReIndex in action tab as shown below, but in 6.2 i didn't find any option for re-indexing from portlet level so another option is go to Control Panel> Configuration >Server Administration >Resource and click execute for Reindex All Search indexes as shown below :

it will re index all the portlet available to the portal ans create document.

So This Way we can achieve the lucene search of Liferay.

6 comments:

AnonymousAugust 31, 2015 at 1:56 AM
This code works for you?
Software EngineeringAugust 31, 2015 at 1:59 AM
Are you getting any issue
AnonymousAugust 31, 2015 at 4:30 AM
This code have errors of type.
For example:
List totalRecord = new ArrayList();
"book" actually is "Book".

You must explain that for the line <%@include file="init.jsp"%> copy&paste init.jsp of "/html/common/" in "/docroot/js" first.

And there are more.
All files have errors like Unknown tags or anotations cannot be resolved

UnknownSeptember 5, 2015 at 10:58 AM
Code Is corrected now please refer.
AnonymousJanuary 15, 2016 at 2:53 AM
Your posts is really helpful for me.Thanks for your wonderful post. I am very happy to read your post. It is really very helpful for us and I have gathered some important information from this blog. liferay training in hyderabad
AnonymousMay 10, 2017 at 4:08 AM

I really appreciate information shared above. It’s of great help. If someone want to learn Online (Virtual) instructor lead live training in TECHNOLOGY , kindly contact us http://www.maxmunus.com/contact
MaxMunus Offer World Class Virtual Instructor-led training on TECHNOLOGY. We have industry expert trainer. We provide Training Material and Software Support. MaxMunus has successfully conducted 100000+ pieces of training in India, USA, UK, Australia, Switzerland, Qatar, Saudi Arabia, Bangladesh, Bahrain and UAE etc.
For Demo Contact us.
Pratik Shekhar
MaxMunus
E-mail: pratik@maxmunus.com
Ph:(0) +91 9066268701
http://www.maxmunus.com/

Getting into Liferay

This blog is created for helping Developers in Liferay Portal Technology

Sunday, April 26, 2015

lucene search in liferay on custom portlet

6 comments:

ad

Total Pageviews

Popular Posts

Blog Archive

Categories

Liferay Contributors