Mastering Data Aggregation and Data Streams in Java

Welcome to our lesson on mastering data aggregation and data streams in Java. In this lesson, we'll start by building a basic sales records aggregator. Then, we'll extend its functionality to handle more complex operations such as filtering, data aggregation, and formatted outputs. By the end of this session, you'll be able to manage and format data streams efficiently using Java.

Starter Task Methods

To begin, we'll implement a basic sales record aggregator. Here are the methods we'll be focusing on:

  • addSale(int saleId, double amount) - Adds a sale record with a unique identifier saleId and an amount. If a sale with the same saleId already exists, it updates the amount.
  • getSale(int saleId) - Retrieves the sale amount associated with the saleId. If the sale does not exist, it returns null.
  • deleteSale(int saleId) - Deletes the sale record with the given saleId. Returns true if the sale was deleted and false if the sale does not exist.

Are these methods clear so far? Great! Let's now look at how we would implement them.

Starter Task Implementation

Here is the complete code for the starter task:

import java.util.HashMap;

public class SalesAggregator {
    private HashMap<Integer, Double> sales;

    public SalesAggregator() {
        sales = new HashMap<>();  // Initialize an empty HashMap to store sales records.
    }

    public void addSale(int saleId, double amount) {
        sales.put(saleId, amount);  // Add or update the sale with the provided saleId and amount.
    }

    public Double getSale(int saleId) {
        return sales.getOrDefault(saleId, null);  // Retrieve and return the sale amount for the given saleId, or null if it doesn't exist.
    }

    public boolean deleteSale(int saleId) {
        return sales.remove(saleId) != null;  // Remove the sale record and return true if it existed, false otherwise.
    }

    public static void main(String[] args) {
        SalesAggregator aggregator = new SalesAggregator();

        // Add sales
        aggregator.addSale(1, 100.50);
        aggregator.addSale(2, 200.75);

        // Get sale
        System.out.println(aggregator.getSale(1));  // Output: 100.5

        // Delete sale
        System.out.println(aggregator.deleteSale(2));  // Output: true
        System.out.println(aggregator.getSale(2));  // Output: null
    }
}

Explanation:

  • The SalesAggregator class initializes an empty HashMap to store sales records.
  • The addSale method adds a new sale or updates the amount for an existing sale ID.
  • The getSale method retrieves the amount for a given sale ID or returns null if the sale does not exist.
  • The deleteSale method removes the sale record for the given sale ID or returns false if the sale does not exist.

Now that we have our basic aggregator, let's extend it to include more advanced functionalities.

New Methods and Their Definitions

To increase the complexity and usefulness of our sales aggregator, we'll adjust some existing methods and introduce some new methods and functionalities involving formatted outputs.

  • addSale(int saleId, double amount, LocalDateTime date) - Adds or updates a sale record with a unique identifier saleId, amount, and a date.
  • aggregateSales(double minAmount) - Returns an object with the total number of sales and the total amount of sales where the sale amount is above minAmount. The object format looks like this: 
    public class SalesStatistics {
    private int totalSales;
    private double totalAmount;

    public SalesStatistics(int totalSales, double totalAmount) {
        this.totalSales = totalSales;
        this.totalAmount = totalAmount;
    }

    // Getter methods
    public int getTotalSales() {
        return totalSales;
    }

    public double getTotalAmount() {
        return totalAmount;
    }
}
  • formatSales(double minAmount) - Returns the sales data, filtered by minAmount, formatted as JSON. Includes aggregated sales statistics in the output.
  • getSalesInDateRange(LocalDateTime startDate, LocalDateTime endDate) - Retrieves all sales that occurred within the given date range, inclusive. Each sale includes saleId, amount, and date.

Let's implement these methods step-by-step.

Step 1: Enhancing the addSale Method to Include Date

We'll first modify the addSale method to accept a date.

import java.time.LocalDateTime;

public void addSale(int saleId, double amount, LocalDateTime date) {
    // Add or update the sale with the provided saleId, amount, and date.
    sales.put(saleId, new SaleRecord(amount, date));
}

private class SaleRecord {
    private double amount;
    private LocalDateTime date;

    public SaleRecord(double amount, LocalDateTime date) {
        this.amount = amount;
        this.date = date;
    }

    // Getter methods
    public double getAmount() {
        return amount;
    }

    public LocalDateTime getDate() {
        return date;
    }
}

This ensures that each sale record includes a date in addition to the amount.

Step 2: Implementing the aggregateSales Method

Now, we create the aggregateSales method:

public SalesStatistics aggregateSales(double minAmount) {
    int totalSales = 0;
    double totalAmount = 0.0;
    for (SaleRecord sale : sales.values()) {
        if (sale.getAmount() > minAmount) {
            totalSales += 1;  // Increment the total sales count.
            totalAmount += sale.getAmount();  // Add to the total amount.
        }
    }
    return new SalesStatistics(totalSales, totalAmount);  // Return the aggregated results.
}

// Define SalesStatistics class
public class SalesStatistics {
    private int totalSales;
    private double totalAmount;

    public SalesStatistics(int totalSales, double totalAmount) {
        this.totalSales = totalSales;
        this.totalAmount = totalAmount;
    }

    // Getter methods
    public int getTotalSales() {
        return totalSales;
    }

    public double getTotalAmount() {
        return totalAmount;
    }
}

public static void main(String[] args) {
    SalesAggregator aggregator = new SalesAggregator();

    // Add sales with date
    aggregator.addSale(1, 100.50, LocalDateTime.of(2023, 1, 1, 0, 0));
    aggregator.addSale(2, 200.75, LocalDateTime.of(2023, 1, 15, 0, 0));

    // Aggregate sales
    SalesStatistics stats = aggregator.aggregateSales(50);
    System.out.println("Total Sales: " + stats.getTotalSales() + ", Total Amount: " + stats.getTotalAmount()); 
    // Output: Total Sales: 2, Total Amount: 301.25
}

This method iterates through the sales and sums up those that exceed the minAmount.

Step 3: Implementing the formatSales Method

Next, we'll create the formatSales method to output data in JSON format using Gson.

import com.google.gson.Gson;
import java.util.ArrayList;
import java.util.List;

public String formatSales(double minAmount) {
    // Filter and format sales data based on minAmount.
    List<Object> filteredSales = new ArrayList<>();
    for (Integer saleId : sales.keySet()) {
        SaleRecord sale = sales.get(saleId);
        if (sale.getAmount() > minAmount) {
            filteredSales.add(new SaleDetails(saleId, sale.getAmount(), sale.getDate()));
        }
    }

    // Aggregate sales statistics.
    SalesStatistics statistics = aggregateSales(minAmount);

    // Combine sales data and statistics into the final result.
    SalesReport result = new SalesReport(filteredSales, statistics);

    Gson gson = new Gson();
    return gson.toJson(result);  // Convert the result to JSON.
}

private class SaleDetails {
    private int saleId;
    private double amount;
    private LocalDateTime date;

    public SaleDetails(int saleId, double amount, LocalDateTime date) {
        this.saleId = saleId;
        this.amount = amount;
        this.date = date;
    }
}

private class SalesReport {
    private List<Object> Sales;
    private SalesStatistics Statistics;

    public SalesReport(List<Object> sales, SalesStatistics statistics) {
        this.Sales = sales;
        this.Statistics = statistics;
    }
}

public static void main(String[] args) {
    SalesAggregator aggregator = new SalesAggregator();

    // Add sales with date
    aggregator.addSale(1, 100.50, LocalDateTime.of(2023, 1, 1, 0, 0));
    aggregator.addSale(2, 200.75, LocalDateTime.of(2023, 1, 15, 0, 0));

    // Format sales to JSON
    String formattedSales = aggregator.formatSales(50);
    System.out.println(formattedSales);
    // Output: {"Sales":[{"saleId":1,"amount":100.5,"date":"2023-01-01T00:00"},{"saleId":2,"amount":200.75,"date":"2023-01-15T00:00"}],"Statistics":{"totalSales":2,"totalAmount":301.25}}
}

This function utilizes Gson, a Java library from Google that converts Java objects to JSON representations, to format sales data as JSON, and includes aggregated statistics.

Step 4: Implementing the getSalesInDateRange Method

Finally, let's implement the getSalesInDateRange method:

import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.List;

public List<SaleDetails> getSalesInDateRange(LocalDateTime startDate, LocalDateTime endDate) {
    List<SaleDetails> result = new ArrayList<>();
    for (Integer saleId : sales.keySet()) {
        SaleRecord sale = sales.get(saleId);
        if ((sale.getDate().isEqual(startDate) || sale.getDate().isAfter(startDate)) &&
            (sale.getDate().isEqual(endDate) || sale.getDate().isBefore(endDate))) {
            result.add(new SaleDetails(saleId, sale.getAmount(), sale.getDate()));
        }
    }
    return result;
}

public static void main(String[] args) {
    SalesAggregator aggregator = new SalesAggregator();

    // Add sales with date
    aggregator.addSale(1, 100.50, LocalDateTime.of(2023, 1, 1, 0, 0));
    aggregator.addSale(2, 200.75, LocalDateTime.of(2023, 1, 15, 0, 0));

    // Get sales in date range
    List<SaleDetails> salesInRange = aggregator.getSalesInDateRange(LocalDateTime.of(2023, 1, 1, 0, 0), LocalDateTime.of(2023, 12, 31, 0, 0));
    for (SaleDetails sale : salesInRange) {
        System.out.println(sale);
    }
    // Output: SaleDetails[saleId=1, amount=100.5, date=2023-01-01T00:00]
    //         SaleDetails[saleId=2, amount=200.75, date=2023-01-15T00:00]
}

This method retrieves all sales within the specified date range.

Summary

Congratulations! You've now extended a basic sales aggregator to an advanced one capable of filtering, aggregating, and providing formatted outputs in Java. These skills are crucial for handling data streams efficiently, especially when dealing with large datasets. Feel free to experiment with similar challenges to reinforce your understanding. Well done, and see you in the next lesson!

Previous
Sign up
Join the 1M+ learners on CodeSignal
Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal