Skip to content

Latest commit

 

History

History
40 lines (22 loc) · 2.5 KB

DOCS.md

File metadata and controls

40 lines (22 loc) · 2.5 KB

Project Overview - CS205 G1T1

Our PortfolioTracker app is a simple single screen Android application to inform you of the health of various stocks between July 1 2021, 00:00:01 to Dec 31 2021, 23:59:59..

The configuration of the emulator and functionality is as specified in the project requirements.

Functionality

On running the application on Android Studio, the main screen consists of 5 text boxes on the left to input stock tickers, and the buttons on the right in each row are to indicate Download and Calculate respectively. Other than the basic functionalities in the requirements these are some additional ones.

  • Input validation for tickers, where an error popup shows up on the corresponding textbox where a ticker is invalid, or an empty string

  • The user can input up to 5 tickers, and choose to click on 'DOWNLOAD ALL' to synchronously download data for each of the tickers. For 'DOWNLOAD ALL', we allow our users to leave fields blank if they do not wish to query for 5 tickers. Subsequently, clicking on 'CALCULATE ALL' will calculate and display the metrics for each ticker currently on the screen.

  • Clicking on download for previously fetched tickers will eliminate the need for redownload, to save power and computation.

  • The calculate button will be inactive until the data for the ticker has been downloaded and persisted into the database.

Design Choices

In the main activity, we initialise all the Views and register all relevant BroadcastReceivers. A single array is used to hold the list of stocks chosen.

We utilise the following 3 BroadcastReceivers:

  • MyBroadcastReceiver

The main BroadcastReceiver for handling the Calculation intent and initialising a Cursor to query the data for the ticker, followed by the calculation.

  • ErrorBroadcastReceiver

As mentioned earlier, the app has the functionality to display an error when the ticker is invalid (i.e GOOGLE instead of GOOGL). This BroadcastReceiver enables the display of those errors.

  • DownloadBroadcastReceiver

This BroadcastReceiver enables the Calculate button once the intent is received after the completion of a download for the ticker.

The HistoricalDataProvider contains the methods that allow persistence and querying functionality, acting as the Data Layer of the app.

Finally, the FinnhubService does most of the heavy lifting, where it fetches data from the API for the tickers, in case they don't already exist in the database. It is also responsible for broadcasting various intents.