com.afrigis.services.ConfidenceLevel Maven / Gradle / Ivy

Go to download
package com.afrigis.services;

/**
 * 
 * Gives an indication of how fine grained a geocoding response is (i.e. how
 * accurate).
 * 
 * 
 * @author hendrikc
 *
 */
public enum ConfidenceLevel {
    /**
     * 
     * Unknown confidence.
     * 
     */
    unknown,

    /**
     * 
     * Accurate.
     * 
     */
    accurate,

    /**
     * 
     * Accurate to erf level.
     * 
     */
    erf,

    /**
     * 
     * Accurate to sreet corner level.
     * 
     */
    streetCorner,

    /**
     * 
     * Accurate to within 5 numbers on the same street.
     * 
     */
    withinFiveOfStreetNumber,

    /**
     * 
     * Accurate to street name and suburb level.
     * 
     */
    streetNameAndSuburb,

    /**
     * 
     * Accurate to SG Town level.
     * 
     */
    sgTown,

    /**
     * 
     * Accurate to suburb level.
     * 
     */
    suburb,

    /**
     * 
     * Accurate to Town level.
     * 
     */
    town,

    /**
     * 
     * Accurate to municipality level.
     * 
     */
    municipalityOrDistrict,

    /**
     * 
     * Accurate to province level.
     * 
     */
    province;

    /**
     * 
     * Returns the level of the confidence.
     * 
     * 
     * @return the confidence level as an {@link Integer}
     */
    public Integer getLevel() {
        return this.ordinal();
    }

}