com.afrigis.services.search.extension.intiendoLS.api2.params.SeoidLatLongAbstractParams Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of search-extension Show documentation
Search extensions for API's such as Census and Postal Codes
The newest version!
package com.afrigis.services.search.extension.intiendoLS.api2.params;

import com.afrigis.services.KeyValue;
import com.afrigis.services.exceptions.AfriGISServicesException;
import com.afrigis.services.internal.saas.api2.AbstractParams;
import java.util.Collection;
import org.apache.commons.lang3.StringUtils;

/**
 *
 * @author Takalani
 */
public abstract class SeoidLatLongAbstractParams extends AbstractParams {

    protected static final String SEOID = "id";
    protected static final String EMAIL = "email";
    protected static final String LATITUDE = "latitude";
    protected static final String LONGITUDE = "longitude";
    protected static final String EMAIL_REGEX = "(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-zA-Z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])";
    private String seoid;
    private String email;
    private String latitude;
    private String longitude;

    /**
     *
     * @return String seoid to identify location information for
     */
    public String getSeoid() {
        return seoid;
    }

    /**
     *
     * @param seoid identify location to get information for
     */
    public void setSeoid(String seoid) {
        this.seoid = seoid;
    }

    /**
     * 
     * Email of client making AfriGIS service call
     * 
     *
     * @return String
     */
    public String getEmail() {
        return email;
    }

    /**
     *
     * @param email set client email making AfriGIS service call
     */
    public void setEmail(String email) {
        this.email = email;
    }

    /**
     * 
     * Latitude to identify location, used in conjunction with Longitude, an
     * alternative to using seoid
     * 
     *
     * @return String
     */
    public String getLatitude() {
        return latitude;
    }

    /**
     * 
     * Set latitude to identify location
     * 
     *
     * @param latitude
     */
    public void setLatitude(String latitude) {
        this.latitude = latitude;
    }

    /**
     * 
     * Latitude to identify location, used in conjunction with Latitude, an
     * alternative to using seoid
     * 
     *
     * @return String
     */
    public String getLongitude() {
        return longitude;
    }

    /**
     * 
     * Set longitude to identify location
     * 
     *
     * @param longitude
     */
    public void setLongitude(String longitude) {
        this.longitude = longitude;
    }

    public SeoidLatLongAbstractParams(String email, String seoid) {
        this.email = email;
        this.seoid = seoid;
    }

    public SeoidLatLongAbstractParams(String email, String latitude, String longitude) {
        this.latitude = latitude;
        this.longitude = longitude;
        this.email = email;
    }

//    @Override
//    public abstract String getServiceName();
    /**
     * 
     * Add AfriGIS service specific parameters
     * 
     *
     * @param input
     */
    @Override
    protected void completeRequestParamList(Collection input) {
        addKeyValParam(EMAIL, getEmail(), input);

        if (getSeoid() != null && getSeoid().trim().length() > 0) {
            addKeyValParam(SEOID, getSeoid(), input);
        } else {
            addKeyValParam(LATITUDE, getLatitude(), input);
            addKeyValParam(LONGITUDE, getLongitude(), input);
        }
    }

    /**
     * 
     * Verify all required service parameters and their format
     * 
     *
     * @throws AfriGISServicesException
     */
    @Override
    public void validate() throws AfriGISServicesException {
        if (StringUtils.isBlank(getEmail())) {
            throw new AfriGISServicesException(
                    "Exceptions - missing mandatory parameter (email)");
        }
        // Valid email?
        if (!getEmail().matches(EMAIL_REGEX)) {
            throw new AfriGISServicesException(
                    "Exceptions - invalid email");
        }

        if (StringUtils.isBlank(getSeoid()) && (StringUtils.isBlank(getLatitude()) || StringUtils.isBlank(getLongitude()))) {
            throw new AfriGISServicesException(
                    "Exceptions - missing mandatory parameter (" + (StringUtils.isBlank(getSeoid()) ? "seoid" : "latitude or longitude") + ")");
        }
    }
}