AbstractQueryController.java

/**   
 * License Agreement for OpenSearchServer
 *
 * Copyright (C) 2008-2014 Emmanuel Keller / Jaeksoft
 * 
 * http://www.open-search-server.com
 * 
 * This file is part of OpenSearchServer.
 *
 * OpenSearchServer is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 * OpenSearchServer 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with OpenSearchServer. 
 *  If not, see <http://www.gnu.org/licenses/>.
 **/

package com.jaeksoft.searchlib.web.controller.query;

import org.zkoss.bind.annotation.AfterCompose;
import org.zkoss.bind.annotation.BindingParam;
import org.zkoss.bind.annotation.GlobalCommand;

import com.jaeksoft.searchlib.Client;
import com.jaeksoft.searchlib.SearchLibException;
import com.jaeksoft.searchlib.geo.GeoParameters;
import com.jaeksoft.searchlib.geo.GeoParameters.CoordUnit;
import com.jaeksoft.searchlib.geo.GeoParameters.DistanceReturn;
import com.jaeksoft.searchlib.request.AbstractRequest;
import com.jaeksoft.searchlib.request.RequestTypeEnum;
import com.jaeksoft.searchlib.result.AbstractResult;
import com.jaeksoft.searchlib.web.controller.CommonController;
import com.jaeksoft.searchlib.web.controller.ScopeAttribute;

@AfterCompose(superclass = true)
public abstract class AbstractQueryController extends CommonController {

	private final static RequestTypeEnum[] DEFAULT_TYPE_LIST = {
			RequestTypeEnum.SearchRequest, RequestTypeEnum.SearchFieldRequest };

	private final RequestTypeEnum[] requestTypes;

	public AbstractQueryController(RequestTypeEnum... requestTypes)
			throws SearchLibException {
		super();
		if (requestTypes != null && requestTypes.length > 0)
			this.requestTypes = requestTypes;
		else
			this.requestTypes = DEFAULT_TYPE_LIST;
	}

	final public AbstractRequest getRequest() throws SearchLibException {
		AbstractRequest request = getAbstractRequest();
		if (request == null)
			return null;
		for (RequestTypeEnum requestType : requestTypes)
			if (request.getType() == requestType)
				return request;
		return null;
	}

	final public AbstractRequest getAbstractRequest() throws SearchLibException {
		return (AbstractRequest) getAttribute(ScopeAttribute.QUERY_REQUEST);
	}

	protected AbstractResult<?> getAbstractResult() {
		return (AbstractResult<?>) getAttribute(ScopeAttribute.QUERY_RESULT);
	}

	protected AbstractResult<?> getResult(RequestTypeEnum type) {
		AbstractResult<?> result = getAbstractResult();
		if (result == null)
			return null;
		if (result.getRequest().getType() != type)
			return null;
		return result;
	}

	final public AbstractResult<?> getResult() throws SearchLibException {
		AbstractResult<?> result = getAbstractResult();
		if (result == null)
			return null;
		AbstractRequest request = result.getRequest();
		if (request == null)
			return null;
		for (RequestTypeEnum requestType : requestTypes)
			if (request.getType() == requestType)
				return result;
		return null;
	}

	private boolean isResult(RequestTypeEnum... types) {
		AbstractResult<?> result = getAbstractResult();
		if (result == null)
			return false;
		for (RequestTypeEnum type : types)
			if (result.getRequest().getType() == type)
				return true;
		return false;
	}

	public boolean isResultNamedEntity() {
		return isResult(RequestTypeEnum.NamedEntityExtractionRequest);
	}

	public boolean isResultSearch() {
		return isResult(RequestTypeEnum.SearchRequest,
				RequestTypeEnum.SearchFieldRequest);
	}

	public boolean isResultSpellCheck() {
		return isResult(RequestTypeEnum.SpellCheckRequest);
	}

	public boolean isResultMoreLikeThis() {
		return isResult(RequestTypeEnum.MoreLikeThisRequest);
	}

	public boolean isResultDocuments() {
		return isResult(RequestTypeEnum.DocumentsRequest,
				RequestTypeEnum.NamedEntityExtractionRequest);
	}

	public CoordUnit[] getGeoCoordUnits() {
		return GeoParameters.CoordUnit.values();
	}

	public DistanceReturn[] getGeoDistanceReturns() {
		return GeoParameters.DistanceReturn.values();
	}

	@Override
	@GlobalCommand
	public void eventRequestListChange(Client client) throws SearchLibException {
		super.eventRequestListChange(client);
		reload();
	}

	@Override
	@GlobalCommand
	public void eventEditRequest(
			@BindingParam("request") AbstractRequest request)
			throws SearchLibException {
		super.eventEditRequest(request);
		reload();
	}

	@Override
	@GlobalCommand
	public void eventEditRequestResult(
			@BindingParam("result") AbstractResult<?> result)
			throws SearchLibException {
		super.eventEditRequestResult(result);
		reload();
	}

}