no.oslomet.aaas.model.AnonymizeResult Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of aaas Show documentation

AaaS is a Anonymization as a Service project implemented as a RESTful web application using Spring Boot.

There is a newer version: 0.2.2-RELEASE

package no.oslomet.aaas.model;


import java.util.Map;

/**
 * Model class for the result from an anonymization process.
 */
public class AnonymizeResult {

    private final String data;
    private final String anonymizationStatus;
    private final MetaData payloadMetaData;
    private final Map statistics;

    /***
     * Setter method for the response object the anonymization process.
     * @param data String containing the anonymized tabular dataset
     * @param anonymizationStatus String containing the {@link Anonymity} status
     * @param payloadMetaData Model class {@link MetaData} containing anonymization and analysation settings
     *                        for the dataset
     * @param statistics HashMap containing the statistics from the anonymization process. The HashMap contains a
     * String of fields that describe the type of statistic and a String that contains its risk value
     */
    public AnonymizeResult(String data, String anonymizationStatus,
                           MetaData payloadMetaData,
                           Map statistics) {
        this.data = data;
        this.anonymizationStatus = anonymizationStatus;
        this.payloadMetaData = payloadMetaData;
        this.statistics = statistics;
    }

    /***
     * Getter method for the anonymized tabular dataset.
     * @return String containing the anonymized tabular dataset
     */
    public String getData() {
        return data;
    }

    /***
     * Getter method for the {@link Anonymity} status.
     * @return Object of {@link Anonymity} status describing how anonymous that dataset is
     */
    public String getAnonymizationStatus() {
        return anonymizationStatus;
    }

    /***
     * Getter method for the model class {@link MetaData} containing the anonymization and analysation settings.
     * @return Object of {@link MetaData} containing the anonymization and analysation settings
     */
    public MetaData getPayloadMetaData() {
        return payloadMetaData;
    }

    /***
     * Getter method for the anonymization statistics.
     * @return HashMap containing the the anonymization statistics. The HashMap contains a
     * String of fields that describe the type of statistic and a String that contains its risk value
     */
    public Map getStatistics() {
        return statistics;
    }
}