package de.tudresden.gis.search;

import com.esri.gpt.catalog.search.ISearchFilter;
import com.esri.gpt.catalog.search.SearchException;
import com.esri.gpt.catalog.search.SearchParameterMap;
import com.esri.gpt.catalog.search.SearchParameterMap.Value;
import com.esri.gpt.framework.util.Val;

/**
 * Implements a filter for platforms 
 * 
 * @author Christin Henzen
 * 
 */
public class SearchFilterPlatform implements ISearchFilter { 
	
	/**
	 * generated id
	 */
	private static final long serialVersionUID = -7056583590049244708L;
	private static String KEY_PLATFORM = "platform";
	private String platform;
 
	/**
	 * Method to get selected platform value
	 * @return platform as string
	 */
	public String getPlatform() { 		
		return Val.chkStr(platform);
	}
 
	/**
	 * Method to set platform value from JSP pages.
	 * @param platform as string
	 */
	public void setPlatform(String platform) { 
		this.platform = platform;
	}
 
	/**
	 * Method to serialize selected platform as map
	 * @return platforms as map
	 */
	public SearchParameterMap getParams() {
		SearchParameterMap map = new SearchParameterMap();
		map.put(KEY_PLATFORM, map.new Value(this.getPlatform(), "")); 
		return map;
	}
 
	/**
	 * Method to filter platform from all given search parameters and to set the intern platform value.
	 */
	public void setParams(SearchParameterMap parameterMap) throws SearchException {
		Value val = parameterMap.get(KEY_PLATFORM);
		this.setPlatform(val.getParamValue());
	}
 
	/**
	 * Method to check whether search filter type is search filter platform
	 */
	public boolean isEquals(Object obj) {
		if (obj instanceof SearchFilterPlatform) 
			return ((SearchFilterPlatform) obj).getPlatform().equals(this.getPlatform());
		return false;
	}
 
	/**
	 * Method to reset selected values.
	 */
	public void reset() { 
		this.setPlatform("");
	}
 
	/**
	 * Method to validate.
	 * (non-Javadoc)
	 * @see com.esri.gpt.catalog.search.ISearchFilter#validate()
	 */
	public void validate() throws SearchException {
		if (this.getPlatform().equals("this should throw an exception")) { 
			throw new SearchException("this should throw an exception");
		}
	}

	/* @check unused? */
	public String getSelectedPlatform() { 
		return platform;
	}

	/* @check unused? */
	public void setSelectedPlatform(String platform) { 
		this.platform = platform;
	}
}