SOFT3202 S1 2022 Major Project Specification Part 1 16/04/2022
MAJOR PROJECT
The SOFT3202 Major Project will comprise a custom piece of software you will develop during the semester, which you will further modify in the ‘long release’ window during the exam period with an extra set of instructions. You will be building a desktop GUI Java application, which consumes web APIs to achieve specified functionality.
The specification of your software is governed by a pair of APIs that vary from student to student. Each API has specific requirements within a wider framework that is the same for all students.
Copyright By PowCoder代写 加微信 powcoder
Submission
As done in previous assignments, you will use a private GitHub repository located at: https://github.sydney.edu.au. The repository must be named SCD2_2022 and you must add the following collaborators:
• jbur2821
• aest9988
• agha0431
• efis3423
• hzen5475
• phao5814
Your major project submission should be in the directory
This submission may only be modified up until 23:59 on the Sunday of Week 13 (29MAY). At this time, your work on the given features must have been completed – your work during the 48 hours of the exam itself must be based on the state of your repository at this time to be accepted. Note there will be milestone assessments of your work at the end of Week 9, 11, and 13.
Specifications
There are 6 parts to the instructions you will be sent over the course of your work on this project.
• This document: explains the work you will be doing up to the end of Milestone 1. The same for all students.
• An email indicating what APIs you have been assigned to work with. You should receive this soon after this document is released.
• Your tutor feedback requirements after Milestone 1. Adds any extra requirements the tutor believes to be necessary after reviewing your initial submission.
• The Optional Features specification, also after Milestone 1. Indicates the optional features required for Credit/Distinction/High Distinction results.
• The ‘exam period modification’ specification. Explains the work you will be doing in the 48-hour exam window during the exam period. This will be released prior to the exam so you know what to expect, but will not tell you what the modification is. The same for all students.
• An email indicating what your personal modification is. This will be sent at the beginning of the exam window.
As always Ed announcements and API specific clarifications should also be considered part of the specification. Page 1 of 12
SOFT3202 S1 2022 Major Project Specification Part 1 16/04/2022
The APIs are divided up into 2 categories – an ‘input’ list API, and an ‘output’ list API (note that you may need to both send and receive information from either category, it is a thematic difference rather than a purely technical one). You will be assigned 1 API from each category – in essence your application will take information from one API and output it in some way through another.
You grade is initially determined by the completion level of the API. Each API will follow a similar scheme:
• You must implement the required features as indicated for your assigned input and output APIs.
• Your application must run without crashing.
• Your UI must be functional, with no raw JSON displayed, features are clearly visible.
• Your code must be free of obvious, major design flaws. Examples of these (which are not a complete
list) would be:
o ‘God classes’ or ‘god methods’ that know too much or do too much. Break your
implementation down into components.
o Spaghetti code, where functionality or data that should be kept together is split over many
methods or classes
o Major breaches in encapsulation – public attributes, liberal use of instanceof, etc
In most cases detailed UI requirements will not be mandated, but you should ensure that the presented information of your entity is easily readable, and the interaction is simple.
• You must pass the Test Checkpoints at the 4 key submission dates: o Milestone 1
o Milestone 2
o Milestone 2 Resubmission o Exam
• To pass a Test Checkpoint your Model code must be fully tested (not using real database or HTTP calls) at the time of submission. If no submission is made or the submission was unsuccessful, you must still have a working test suite at the appropriate commits in your repository history:
o 1 where you have the Pass criteria implemented but no further o 1 at your final in-semester commit
o 1attheendoftheexam
• You must have correct Model-View separation in your design
• You must correct anything your tutor tells you to correct after Milestone 1. If you do not submit
Milestone 1, you must see your tutor for these corrections as soon as you have a working submission. If you do not do this in time for Milestone 2, your maximum possible cap for Milestone 2 will be Pass. If you do not do this in time for the Milestone 2 resubmission, your maximum possible cap for the Exam will be Pass.
• You must cache the appropriate data to a local SQLite file database
• This database must be created from scratch by your application when it is run with no database file
• You must complete 2 standard optional features
Page 2 of 12
SOFT3202 S1 2022 Major Project Specification Part 1 16/04/2022
DISTINCTION:
• You must use concurrency such that your UI remains responsive throughout slow network calls
• You must additionally complete 1 advanced optional feature
HIGH DISTINCTION:
• You must use a multi-layer architecture such as MVC, MVP, MVVM
• You must additionally complete 1 difficult optional feature
Other requirements
Note that the above requirements are feature requirements only, and should be considered as a ‘ceiling’ – that is, if you do not implement the Credit requirements, your maximum mark is 64%. How close to your earned ceiling your mark reaches, is based on the design, process, testing, style, and documentation requirements listed later, as well as from your work during the exam period itself. See the week 8 lecture for details.
Further information about the Credit and higher tiers will be available after Milestone 1.
https://www.abstractapi.com/holidays-api
Your GUI must begin with a world map (use of https://github.com/controlsfx/controlsfx World Map View is recommended). From this world map view the user must be able to select a country by clicking on it. All input API requests will use the chosen country (changing countries requires quitting and re-starting).
Your application GUI must then display a calendar. This calendar should display month-at-a-time, and have selection available from the user to change year and month, for any date from 1/1/1970-31/12/2037. Each day should display the date (1-31), and the user must be able to click on each day to determine whether there are any holidays on that day. If there are none, the day should indicate ‘no holidays’. If there are, the day should be shaded a different colour, and the day should indicate the name(s) of the holiday(s). If the user clicks on the name of a holiday, a popup window should indicate a description of the holiday.
‘long’ form report output from this input is:
a list of all the *already* known holidays in a given month for the given country.
‘short’ form report output from this input is:
a list of each day that has an already known holiday in the given month for the given country.
What to cache: holidays for any given country+date combination.
https://coinmarketcap.com/api/documentation/v1/
Your application GUI must begin with an empty list. The user can ‘add currency’ at which point a separate window showing a list of all active coinmarketcap cryptocurrencies is displayed (Name and Symbol only). The user can select one of these cryptocurrencies from this window and close it, at which point the selected currency is added to the main window list. This main window list shows more detail about the cryptocurrency selected – logo (displayed visually), name, symbol, description, date launched, website (a url that can be clicked, launching the default browser – see HostServices in JavaFX).
Page 3 of 12
SOFT3202 S1 2022 Major Project Specification Part 1 16/04/2022
Once multiple currencies have been selected, the user is now able to ask for conversions between them. The user must be able to input an amount of a given currency, select a target currency, and be told what the conversion rate is between those 2 currencies, and what the result from their given input value would be. The user can clear the list, or remove individual currencies from the list.
‘long’ form report output from this input is:
A report on a given conversion: including all main-window information about the 2 selected currencies, conversion rate, starting value, finishing value.
‘short’ form report output from this input is:
A report on a given conversion: including all selection-window information (name and symbol only) about the 2 selected currencies, conversion rate, starting value, finishing value.
What to cache: Info on each given currency. Not conversions.
https://currencyscoop.com/api-documentation
Your application GUI must begin with an empty list. The user can ‘add currency’ at which point a separate window showing a world map is displayed (use of https://github.com/controlsfx/controlsfx World Map View is recommended). Selecting a country in that map and closing the window adds the fiat currency for that country to the main window list. This main window list shows info on all selected currencies (currency code, name). Once multiple currencies have been selected, the user is now able to ask for conversions between them. The user must be able to input an amount of a given currency, select a target currency, and be told what the conversion rate is between those 2 currencies, and what the result from their given input value would be. The user can clear the list, or remove individual currencies from the list.
‘long’ form report output from this input is:
A report on a given conversion: including all information about the 2 selected currencies including countries, conversion rate, starting value, finishing value.
‘short’ form report output from this input is:
A report on a given conversion: including all main-window information (name and code only) about the 2 selected currencies, conversion rate, starting value, finishing value.
What to cache: All conversion rates
https://www.abstractapi.com/ip-geolocation-api
Your application GUI must display a world map (use of https://github.com/controlsfx/controlsfx World Map View is recommended), and an empty list. The user must be able to enter IP addresses, at which point a display is added to the main window indicating the IP address, city, region, and country. In the world map, the country is highlighted in red, and a dot is placed at the correct longitude/latitude. The user can keep checking IP addresses, which keep adding to the list, red countries, and location dots. The user can clear the list, or remove individual IP addresses from the list.
‘long’ form report output from this input is:
A list of all checked IP addresses with all displayed info (not the map)
‘short’ form report output from this input is:
Page 4 of 12
SOFT3202 S1 2022 Major Project Specification Part 1 16/04/2022
Info on the last checked IP address with all displayed info (not the map) What to cache: Results for each IP address
https://developer.oxforddictionaries.com/
Your application GUI should allow the user to enter a word in English. Upon entering a word, the application should retrieve the entry for that word. If the word does not have an entry, it should check for lemmas. If there is 1 lemma, it should retrieve the corresponding entry. If there are multiple lemmas, it should offer the choice to the user then retrieve the selected entry. If there are no lemmas the user should be told there are no matching words. Once an entry is retrieved, it should be displayed with all provided information neatly formatted. Any audio pronunciation files should be able to be played by the user. Any synonyms or antonyms should be able to be clicked by the user to retrieve that entry and display it.
The GUI should provide a ‘breadcrumbs’ feature that allows the user to see their selected word history, and to navigate backwards and forwards in this history. This display should visually distinguish between movement where the user clicked a synonym/antonym, and where the user searched for a new word.
‘long’ form report output from this input is:
Info on the currently selected entry, with all data for that word included.
‘short’ form report output from this input is:
A text representation of the user’s entry history
What to cache: entry and lemma results
https://www.alphavantage.co/
Your application should present the user with a search bar with autocomplete functionality. This should not be based on each character typed, but rather upon pressing enter/clicking search a list of matching company symbols is displayed. The user can then either continue typing/searching or select one of the matching companies.
Once a company is selected, the application should display information about the selected company (symbol, name, description). Along with this the application should create and display line charts for the following cash flow values for the selected company: operatingCashflow, capitalExpenditures, profitLoss, dividendPayout, netIncome. These line charts should be displayed one at a time with the user being able to select any chart to display. The user can search for a new company at any time.
‘long’ form report output from this input is:
Info on the currently selected company, with all line chart data
‘short’ form report output from this input is:
Info on the currently selected company (symbol and name only), along with the most recent value of the currently selected line chart.
What to cache: Info for each selected company.
Page 5 of 12
SOFT3202 S1 2022 Major Project Specification Part 1 16/04/2022
https://developer.edamam.com/food-database-api
The application should start by having the user enter an ingredient. The user should then be presented with a list of matching foods to choose from. Once the user has made a choice, the user should then be shown the nutritional values for that ingredient, along with a running total of each. The user can continue to search for and select ingredients to add, which are all visible in the application (this is not required to be all at once), with the running total for all currently selected ingredients.
The ingredients selected have both a ‘measure’ attribute and a value for that measure. These measures and values should be selectable by the user for each ingredient, and the nutritional information adjusted accordingly.
The user is able to indicate a maximum for any given nutritional value. The application should be able to show the user a % stacked bar chart comparing each nutritional value against its set maximum
‘long’ form report output from this input is:
The list of currently selected ingredients (name, measure, value) along with the total nutritional value.
‘short’ form report output from this input is:
The list of currently selected ingredients (name, measure, value)
What to cache: The nutritional information for specific food items for specific measures and values.
https://developer.marvel.com/
Your application should present the user with a search bar with autocomplete functionality. This should not be based on each character typed, but rather upon pressing enter/clicking search a list of characters that start with the given string is displayed. The user can then either continue typing/searching or select one of the matching characters.
Upon selecting a character, the application should display information about that character (thumbnail – displayed as an image, and name). A list of comics that character has appeared in (by comic name and volume) should also be displayed.
The user should be able to click a comic, and see what characters are also in that comic. They should then be able to select a character, and the character display should update with the new characters info (thumbnail and name). This character->comic->character navigation should continue as long as there are comics/characters to select.
The GUI should provide a ‘breadcrumbs’ feature that allows the user to see their selected character/comic history, and to navigate backwards and forwards in this history. Duplicates do not need to be handled in any special way; they can reappear in the list.
‘long’ form report output from this input is:
Info on the currently selected character – name, list of comics, stories, events.
‘short’ form report output from this input is:
A text representation of the user’s character/comic search history
What to cache: Character and Comic query results
Page 6 of 12
SOFT3202 S1 2022 Major Project Specification Part 1 16/04/2022
https://developers.pandascore.co/ – Overwatch
The application should allow the user to search for teams by name. If no team is found, the user should be told there is no match and allowed to search again. If a team is found, the user should be shown information about that team (name, image – displayed, not just the uri, location). For each player in the team also display (professional name, image – displayed).
The user should be able to select the team or any individual player, and list their upcoming matches (dates, number of games, opponent name) – up to 50.
Where the opponent is a team, the user should be able to select the team and list it in place of the original team. This team->match->team navigation should continue as long as there are matches/teams to select.
The GUI should provide a ‘breadcrumbs’ feature that allows the user to see their selected match/team history, and to navigate backwards and forwards in this history. Duplicates do not need to be handled in any special way; they can reappear in the list.
‘long’ form report output from this input is:
Info on the currently selected team – name, list of players, upcoming matches.
‘short’ form report output from this input is:
A text representation of the user’s team/match search history
What to cache: Team and match query results
https://developer.riotgames.com/ use OC1 region
The application begins by allowing the user to search for a given summoner (player) by exact name – see https://www.leagueofgraphs.com/rankings/summoners/oce. Given a selected summoner, the application should display the name, summoner level, and for each queue type with data for that summoner, league wins, and league losses. Use https://ddragon.leagueoflegends.com/cdn/12.7.1/img/profileicon/
There should also be a set of pie charts showing the balance between wins and losses for each queue type with data – these should be displayed one at a time with the user being able to select any chart to display.
The user can search for a new summoner at any time. ‘long’ form report output from this input is:
The summoner name, level, id, [queue type, wins, losses, win%] for each queue type ‘short’ form report output from this input is:
The summoner name, level, and win% for the currently selected queue type What to cache: Summoner and league query results.
Page 7 of 12
SOFT3202 S1 2022 Major Project Specification Part 1 16/04/2022
https://open-platform.theguardian.com/
Your application should present the user with a search bar with autocomplete functionality. This should not be based on each character typed, but rather upon pressing enter/clicking search a list of matching tags (matching the starting string) is displayed. The user can then either continue typing/searching or select one of the matching tags.
With a tag selected, the user then searches for content within the currently selected tag. The results of that content search are then displa
程序代写 CS代考 加微信: powcoder QQ: 1823890830 Email: powcoder@163.com