/**
* OLAT - Online Learning and Training<br>
* http://www.olat.org
* <p>
* Licensed under the Apache License, Version 2.0 (the "License"); <br>
* you may not use this file except in compliance with the License.<br>
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing,<br>
* software distributed under the License is distributed on an "AS IS" BASIS, <br>
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
* See the License for the specific language governing permissions and <br>
* limitations under the License.
* <p>
* Copyright (c) frentix GmbH<br>
* http://www.frentix.com<br>
* <p>
*/
package org.olat.search.ui;
import java.util.ArrayList;
import java.util.List;
import org.olat.core.commons.services.search.ResultDocument;
import org.olat.core.commons.services.search.SearchResults;
import org.olat.core.commons.services.search.ui.ResultController;
import org.olat.core.commons.services.search.ui.SearchEvent;
import org.olat.core.commons.services.search.ui.SearchServiceUIFactory;
import org.olat.core.gui.UserRequest;
import org.olat.core.gui.components.form.flexible.FormItem;
import org.olat.core.gui.components.form.flexible.FormItemContainer;
import org.olat.core.gui.components.form.flexible.elements.FormLink;
import org.olat.core.gui.components.form.flexible.impl.Form;
import org.olat.core.gui.components.form.flexible.impl.FormBasicController;
import org.olat.core.gui.components.form.flexible.impl.FormEvent;
import org.olat.core.gui.components.link.Link;
import org.olat.core.gui.control.Controller;
import org.olat.core.gui.control.Event;
import org.olat.core.gui.control.WindowControl;
import org.olat.core.service.ServiceFactory;
/**
* Description:<br>
* Controller which show the list of results, with paging.
* <P>
* Events:
* <ul>
* <li>SearchEvent</li>
* </ul>
*
* Initial Date: 3 dec. 2009 <br>
* @author srosse, stephane.rosse@frentix.com
*/
public class ResultsController extends FormBasicController {
private FormLink startLink, endLink;
private FormLink previousLink, nextLink;
private FormLink highlightLink, dishighlightLink;
private int currentPage;
private int resultPerPage = 10;
private boolean singlePageMode = false;
private boolean highlight = true;
private SearchResults searchResults;
private final List<ResultController> resultsCtrl = new ArrayList<ResultController>();
public ResultsController(UserRequest ureq, WindowControl wControl, Form mainForm) {
super(ureq, wControl, LAYOUT_CUSTOM, "results", mainForm);
initForm(ureq);
}
@Override
protected void doDispose() {
//
}
@Override
protected void initForm(FormItemContainer formLayout, Controller listener, UserRequest ureq) {
startLink = uifactory.addFormLink("paging.start", formLayout);
endLink = uifactory.addFormLink("paging.end", formLayout);
previousLink = uifactory.addFormLink("previous.page", formLayout);
nextLink = uifactory.addFormLink("next.page", formLayout);
highlightLink = uifactory.addFormLink("highlight.page", "enable.highlighting", "enable.highlighting", formLayout, Link.LINK);
dishighlightLink = uifactory.addFormLink("dishighlight.page", "disable.highlighting", "disable.highlighting", formLayout, Link.LINK);
flc.contextPut("highlight", true);
reset();
}
public int getCurrentPage() {
return currentPage;
}
public SearchResults getSearchResults() {
return searchResults;
}
public void setSearchResults(UserRequest ureq, SearchResults results, int page) {
reset();
currentPage = page;
searchResults = results;
List<Integer> pageList = new ArrayList<Integer>();
for (int i=0; i<getMaxPage(); i++) {
pageList.add(new Integer(i+1));
}
flc.contextPut("pageList", pageList);
flc.contextPut("numOfPages", pageList.size() + 1);
SearchServiceUIFactory searchUIFactory = (SearchServiceUIFactory)ServiceFactory.getService(SearchServiceUIFactory.class);
int count = 0;
int start = currentPage * resultPerPage;
for (int i = start ; (i < start + resultPerPage) && (i < searchResults.getList().size() ); i++) {
ResultDocument document = searchResults.getList().get(i);
ResultController ctrl = searchUIFactory.createController(ureq, getWindowControl(), mainForm, document);
ctrl.setHighlight(highlight);
listenTo(ctrl);
flc.add("result_" + ++count, ctrl.getInitialFormItem());
resultsCtrl.add(ctrl);
}
flc.contextPut("numOfResults", count);
flc.contextPut("results", resultsCtrl);
flc.contextPut("hasResult", results != null);
flc.contextPut("emptyResult", count == 0);
flc.contextPut("searchResults", results);
flc.contextPut("currentPage", currentPage + 1);
startLink.setEnabled(currentPage != 0);
previousLink.setEnabled(currentPage != 0);
endLink.setEnabled(currentPage != getMaxPage());
nextLink.setEnabled(currentPage != getMaxPage());
String [] args = {Integer.toString(getStartResult()), Integer.toString(getEndResult()), results.getLength()};
if (singlePageMode) {
flc.contextPut("resultTitle", getTranslator().translate("all.search.result.title",new String[] {results.getLength()} ));
} else {
flc.contextPut("resultTitle", getTranslator().translate("search.result.title",args));
}
}
public void reload(UserRequest ureq) {
setSearchResults(ureq, searchResults, currentPage);
}
@Override
protected void formOK(UserRequest ureq) {
//
}
@Override
protected void formInnerEvent(UserRequest ureq, FormItem source, FormEvent event) {
super.formInnerEvent(ureq, source, event);
if (source == highlightLink) {
highlight = true;
flc.contextPut("highlight", highlight);
reload(ureq);
} else if (source == dishighlightLink) {
highlight = false;
flc.contextPut("highlight", highlight);
reload(ureq);
} else if (source == startLink) {
setSearchResults(ureq, searchResults, 0);
} else if (source == endLink) {
setSearchResults(ureq, searchResults, getMaxPage());
} else if (source == previousLink) {
setSearchResults(ureq, searchResults, Math.max(0, --currentPage));
} else if (source == nextLink) {
setSearchResults(ureq, searchResults, Math.min(getMaxPage(), ++currentPage));
}
}
@Override
protected void event(UserRequest ureq, Controller source, Event event) {
if (event instanceof SearchEvent) {
if(resultsCtrl.contains(source)) {
fireEvent(ureq, event);
}
}
}
private void reset() {
flc.contextPut("numOfResults", 0);
flc.contextPut("hasResult", Boolean.FALSE);
flc.contextPut("emptyResult", Boolean.TRUE);
if(resultsCtrl != null && !resultsCtrl.isEmpty()) {
flc.contextPut("results", resultsCtrl);
for(int i=0; i<resultsCtrl.size(); i++) {
flc.remove("result_" + (i+1));
removeAsListenerAndDispose(resultsCtrl.get(i));
}
resultsCtrl.clear();
}
}
public int getStartResult() {
return currentPage * resultPerPage + 1;
}
public int getEndResult() {
if ( (getStartResult() + resultPerPage) > searchResults.getList().size() ) {
return searchResults.getList().size();
} else {
return getStartResult() + resultPerPage - 1;
}
}
/**
* @return Number of pages for current result-list.
*/
public int getMaxPage() {
int maxPage = searchResults.getList().size() / resultPerPage;
if ((searchResults.getList().size()) % resultPerPage == 0) {
maxPage--;
}
return maxPage;
}
public FormItem getFormItem() {
return this.flc;
}
}