com.thanglequoc.aqicalculator.AQIResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aqi-calculator Show documentation

AQI Calculator give the detail result from AQI calculation. It also supports NowCast

The newest version!

package com.thanglequoc.aqicalculator;

/**
 * An object which store all necessary AQI result information, include
 * theindex value, category, health effects statements and
 * cautionary statements,
 *
 * @author ThangLeQuoc
 */
public class AQIResult {
    
    private Pollutant pollutant;
    private double concentration;
    private int AQI;
    private String category;
    private String color;
    private String meaning;
    private String healthEffectsStatements;
    private String cautionaryStatements;
    private String sensitiveGroups;
    
    AQIResult(Pollutant pollutant, double concentration, int AQI, String category, String meaning, String color,
              String healthEffectStatements, String cautionaryStatements, String sensitiveGroups) {
        this.pollutant = pollutant;
        this.concentration = concentration;
        this.AQI = AQI;
        this.category = category;
        this.meaning = meaning;
        this.color = color;
        this.healthEffectsStatements = healthEffectStatements;
        this.cautionaryStatements = cautionaryStatements;
        this.sensitiveGroups = sensitiveGroups;
    }
    
    public Pollutant getPollutant() {
        return pollutant;
    }

    /**
     * Get the Air Quality Index
     * */
    public int getAQI() {
        return AQI;
    }

    /**
     * Get the Air Quality Category
     * */
    public String getCategory() {
        return category;
    }

    /**
     * Get the Health Effects Statements
     * */
    public String getHealthEffectsStatements() {
        return healthEffectsStatements;
    }

    /**
     * Get the Cautionary Statements for this pollutant at this category level
     * */
    public String getCautionaryStatements() {
        return cautionaryStatements;
    }

    /**
     * Get the meaning, health implications of this AQI level
     * */
    public String getMeaning() {
        return meaning;
    }

    /**
     * Get the concentration. If calculated from NowCast, this will be the NowCast concentration
     * */
    public double getConcentration() {
        return concentration;
    }

    /**
     * Get the specific color of this AQI level that assigned by EPA
     * */
    public String getColor() {
        return color;
    }

    /**
     * Get people that are sensitive to this pollutant
     * */
    public String getSensitiveGroups() {
       return sensitiveGroups;
    }
}