com.imsweb.algorithms.ruralurban.RuralUrbanDataProvider Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2014 Information Management Services, Inc.
 */
package com.imsweb.algorithms.ruralurban;

/**
 * The purpose of the RuralUrbanContinuumDataProvider is to:
 * 
 * get the rural urban continuum code for the provided year category, state of dx, and county of dx
 * get the rural urban commuting area code for the provided year category, state of dx, county of dx, and census tract
 * get the rural urban census code for the provided year category, state of dx, county of dx, and census tract
 * 
 * either from the database or csv lookup based on the implementation.
 * 
 * Created on Aug 11, 2014 by HoweW
 * @author howew
 */
public interface RuralUrbanDataProvider {

    String BEALE_CATEGORY_1 = "1993";
    String BEALE_CATEGORY_2 = "2003";
    String BEALE_CATEGORY_3 = "2013";

    String TRACT_CATEGORY_1 = "2000";
    String TRACT_CATEGORY_2 = "2010";

    /**
     * Returns urban rural indicator code (URIC) for provided year category, state of dx, county of dx, and census tract.
     * 

     * Created Aug 11, 2014 by HoweW
     * @param state state at DX
     * @param county county at DX
     * @param tractCategory census tract
     * @return the corresponding rural urban census code
     */
    String getUrbanRuralIndicatorCode(String tractCategory, String state, String county, String censusTract);

    /**
     * Returns urban rural indicator code (URIC) percentage for provided year category, state of dx, county of dx, and census tract.
     * 

     * Created Feb 28, 2015 by depryf
     * @param state state at DX
     * @param county county at DX
     * @param tractCategory census tract
     * @return the corresponding rural urban census percentage
     */
    Float getRuralUrbanCensusPercentage(String tractCategory, String state, String county, String censusTract);

    /**
     * Returns rural urban commuting area (RUCA) code for provided year category, state of dx, county of dx, and census tract.
     * 

     * Created Aug 11, 2014 by HoweW
     * @param state state at DX
     * @param county county at DX
     * @param tractCategory census tract
     * @return the corresponding rural urban commuting area code
     */
    String getRuralUrbanCommutingArea(String tractCategory, String state, String county, String censusTract);

    /**
     * Returns rural urban continuum code for provided year category, state of dx, and county of dx.
     * 
     * Created Aug 11, 2014 by HoweW
     * @param bealeCategory year of beale
     * @param state state at DX
     * @param county county at DX
     * @return the corresponding rural urban continuum code
     */
    String getRuralUrbanContinuum(String bealeCategory, String state, String county);
}