com.imsweb.geocoder.GeocodeInput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of naaccr-geocoder-client Show documentation
API mapping for NAACCR Geocoder in Java
There is a newer version: 1.18
Show newest version
/*
 * Copyright (C) 2016 Information Management Services, Inc.
 */
package com.imsweb.geocoder;

import java.util.HashMap;
import java.util.Map;

public class GeocodeInput {

    public static final Integer CURRENT_CENSUS_YEAR = 2010;

    public enum TieBreakingStrategy {
        FLIP_A_COIN,         // choose and return one of the ties at random
        REVERT_TO_HIERARCHY  // fail on a tie and match to the next level of the geographic hierarchy - parcel, then street, then ZIP, then city, etc.
    }

    public enum FeatureMatchingHierarchy {
        UNCERTAINTY_BASED,         // choose and return one of the ties at random
        FEATURE_MATCHING_SELECTION_METHOD  // fail on a tie and match to the next level of the geographic hierarchy - parcel, then street, then ZIP, then city, etc.
    }

    private String _streetAddress;
    private String _city;
    private String _state;
    private String _zip;
    private Boolean _allowTies;
    private TieBreakingStrategy _tieBreakingStrategy;
    private Boolean _census;
    private Boolean _currentCensusYearOnly;
    private Boolean _geom;
    private Boolean _notStore;
    private String _confidenceLevels;
    private String _minScore;
    private Boolean _shouldDoExhaustiveSearch;
    private Boolean _useAliasTable;
    private Boolean _shouldUseRelaxation;
    private String _relaxedAttributes;
    private Boolean _allowSubstringMatching;
    private Boolean _allowSoundex;
    private String _soundexAttributes;
    private FeatureMatchingHierarchy _featureMatchingHierarchy;
    private String _referenceDataSources;

    public String getStreetAddress() {
        return _streetAddress;
    }

    public void setStreetAddress(String streetAddress) {
        _streetAddress = streetAddress;
    }

    public String getCity() {
        return _city;
    }

    public void setCity(String city) {
        _city = city;
    }

    public String getState() {
        return _state;
    }

    public void setState(String state) {
        _state = state;
    }

    public String getZip() {
        return _zip;
    }

    public void setZip(String zip) {
        _zip = zip;
    }

    public Boolean getAllowTies() {
        return _allowTies;
    }

    public void setAllowTies(Boolean allowTies) {
        _allowTies = allowTies;
    }

    public TieBreakingStrategy getTieBreakingStrategy() {
        return _tieBreakingStrategy;
    }

    public void setTieBreakingStrategy(TieBreakingStrategy tieBreakingStrategy) {
        _tieBreakingStrategy = tieBreakingStrategy;
    }

    public Boolean getCensus() {
        return _census;
    }

    public void setCensus(Boolean census) {
        _census = census;
    }

    public Boolean getCurrentCensusYearOnly() {
        return _currentCensusYearOnly;
    }

    public void setCurrentCensusYearOnly(Boolean currentCensusYearOnly) {
        _currentCensusYearOnly = currentCensusYearOnly;
    }

    public Boolean getNotStore() {
        return _notStore;
    }

    public void setNotStore(Boolean notStore) {
        _notStore = notStore;
    }

    public Boolean getGeom() {
        return _geom;
    }

    public void setGeom(Boolean geom) {
        _geom = geom;
    }

    public String getConfidenceLevels() {
        return _confidenceLevels;
    }

    public void setConfidenceLevels(String confidenceLevels) {
        _confidenceLevels = confidenceLevels;
    }

    public String getMinScore() {
        return _minScore;
    }

    public void setMinScore(String minScore) {
        _minScore = minScore;
    }

    public Boolean getShouldDoExhaustiveSearch() {
        return _shouldDoExhaustiveSearch;
    }

    public void setShouldDoExhaustiveSearch(Boolean shouldDoExhaustiveSearch) {
        _shouldDoExhaustiveSearch = shouldDoExhaustiveSearch;
    }

    public Boolean getUseAliasTable() {
        return _useAliasTable;
    }

    public void setUseAliasTable(Boolean useAliasTable) {
        _useAliasTable = useAliasTable;
    }

    public Boolean getShouldUseRelaxation() {
        return _shouldUseRelaxation;
    }

    public void setShouldUseRelaxation(Boolean shouldUseRelaxation) {
        this._shouldUseRelaxation = shouldUseRelaxation;
    }

    public String getRelaxedAttributes() {
        return _relaxedAttributes;
    }

    public void setRelaxedAttributes(String relaxedAttributes) {
        this._relaxedAttributes = relaxedAttributes;
    }

    public Boolean getAllowSubstringMatching() {
        return _allowSubstringMatching;
    }

    public void setAllowSubstringMatching(Boolean allowSubstringMatching) {
        this._allowSubstringMatching = allowSubstringMatching;
    }

    public Boolean getAllowSoundex() {
        return _allowSoundex;
    }

    public void setAllowSoundex(Boolean allowSoundex) {
        this._allowSoundex = allowSoundex;
    }

    public String getSoundexAttributes() {
        return _soundexAttributes;
    }

    public void setSoundexAttributes(String soundexAttributes) {
        this._soundexAttributes = soundexAttributes;
    }

    public FeatureMatchingHierarchy getFeatureMatchingHierarchy() {
        return _featureMatchingHierarchy;
    }

    public void setFeatureMatchingHierarchy(FeatureMatchingHierarchy featureMatchingHierarchy) {
        this._featureMatchingHierarchy = featureMatchingHierarchy;
    }

    public String getReferenceDataSources() {
        return _referenceDataSources;
    }

    public void setReferenceDataSources(String referenceDataSources) {
        this._referenceDataSources = referenceDataSources;
    }

    /**
     * Convert to a map of parameters for the API call
     */
    Map toQueryParams() {
        Map params = new HashMap<>();

        // may want to turn this on for debugging
        //        params.put("includeHeader", "true");

        // address information
        if (getStreetAddress() != null)
            params.put("streetAddress", getStreetAddress());
        if (getCity() != null)
            params.put("city", getCity());
        if (getState() != null)
            params.put("state", getState());
        if (getZip() != null)
            params.put("zip", getZip());

        // tie settings
        if (getAllowTies() != null)
            params.put("allowTies", getAllowTies() ? "true" : "false");
        if (Boolean.TRUE.equals(getAllowTies()) && getTieBreakingStrategy() != null)
            params.put("tieBreakingStrategy", TieBreakingStrategy.FLIP_A_COIN.equals(getTieBreakingStrategy()) ? "flipACoin" : "revertToHierarchy");

        // census settings
        if (Boolean.TRUE.equals(getCensus())) {
            params.put("census", "true");
            if (Boolean.TRUE.equals(getCurrentCensusYearOnly()))
                params.put("censusYear", Integer.toString(CURRENT_CENSUS_YEAR));
            else
                params.put("censusYear", "allAvailable");   // default to allAvailable
        }

        if (getGeom() != null)
            params.put("geom", getGeom() ? "true" : "false");
        if (getNotStore() != null)
            params.put("notStore", getNotStore() ? "true" : "false");

        if (getConfidenceLevels() != null)
            params.put("confidenceLevels", getConfidenceLevels());
        if (getMinScore() != null)
            params.put("minScore", getMinScore());
        if (getShouldDoExhaustiveSearch() != null)
            params.put("shouldDoExhaustiveSearch", getShouldDoExhaustiveSearch() ? "true" : "false");
        if (getUseAliasTable() != null)
            params.put("aliasTables", getUseAliasTable() ? "true" : "false");

        if (getShouldUseRelaxation() != null && !getShouldUseRelaxation())
            params.put("r", "false");
        else if (getRelaxedAttributes() != null) {
            params.put("r", "true");
            params.put("ratts", getRelaxedAttributes());
        }
        if (getAllowSubstringMatching() != null)
            params.put("sub", getAllowSubstringMatching() ? "true" : "false");
        if (getAllowSoundex() != null && !getAllowSoundex())
            params.put("sou", "false");
        else if (getSoundexAttributes() != null) {
            params.put("sou", "true");
            params.put("souatts", getSoundexAttributes());
        }
        if (getFeatureMatchingHierarchy() != null)
            params.put("h", FeatureMatchingHierarchy.UNCERTAINTY_BASED.equals(getFeatureMatchingHierarchy()) ? "uncertaintyBased" : "FeatureMatchingSelectionMethod");
        if (getReferenceDataSources() != null)
            params.put("refs", getReferenceDataSources());
        return params;
    }
}