Luna's Project | Slang Dictionary

Overview

This is probably a very nothing in your eyes once you read that it’s an assignment for a university course. But that’s your first mistake, to underestimate the almighty Luny.

Takeaways

Main takeaways of this project are:

Ability to establish, manage, and work in a team. (This doesn’t work since he changed it to a solo project instead with how few students there are)
Ability to analyze and write technical documentation for an application.
Ability to understand and use basic native Java data structures.
Ability to write basic syntax in Java.
Ability to utilize Java IO.
Ability to utilize Java Collections.
Ability to manage and handle Exceptions.
Ability to manage a project structure.
Ability to analyze the given prompt.
Ability to separate the given required tasks into smaller actions, and finding the appropriate Java classes to implement.
Ability to work with an IDE. Recommendations: IntellIJ IDEA, Eclipse, NetBeans.

Description

This project focuses more on IO, OOP, Generics and Collections.

Required Tasks

Must utilize Java IO, OOP, and Collections. The application can use Console, Swing or Java FX.
Must have a menu to pick an option, regardless of UI choices.
Must load data from files into objects.
Must have a search time under 1s for 100.000 words, even though the provided default file doesn’t have that many.
Must save the current data after modifications.
Must use a version control system, with at least 10 commits spread across multiple days.

Screenshots

Main Screen

Create New Dictionary

View Screen

Quiz Start Screen

Quiz Screen

Features

Required Features

Find by the word.
Find by the definition.
View search history.
Add a new word. Notify if duplicated, and allow overwriting or adding new.
Edit a word.
Delete a word, with confirmation.
Reset back to default list.
Randomly select a word and display it as the “Word of the Day”.
Quiz Feature that shows a word, and picks a definition.

All Features

Databases

This application uses multiple databases, so you can effectively have multiple types of dictionaries, maybe one for English slangs, one for German slangs and one for Russian slangs. Only one database is loaded and viewed at one time to prevent loading too many entries into the memory, as the entire dictionary loads in memory.

Feature	Name	Action
`file.open`	Open Database	Open an existing database, usually under the name `<uuid>.dict`.
`file.new`	Create Database	Create a new database bound to a file, with options to bootstrap the database with default values, like the 7,000 slang words dictionary or the randomly generated 100,000 entries dictionary for testing.
`file.close`	Close Database	Close the database after asking if the user wants to save any changes.
`file.reload`	Reload Database	Drop all changes and reload the database from the file, if it still exists.
`file.save`	Save Database	Save all changes done to the currently opened database.
`file.bomb`	Bomb Database	Nuke all entries on the database. To save this change, use the `file.save` feature.
`file.reset`	Reset Database	Reset the database back into default entries.
`file.rename`	Rename Database	Rename the database, but the file name shouldn’t be changed.

Editing

This section provides actions to manipulate the dictionary.

Feature	Name	Action
`edit.add`	Add a word	Appends a new entry into the dictionary.
`edit.edit`	Edit a word	Edits an entry’s word or definition.
`edit.star`	Favorite a word	Marks a word as favorite and prevents its deletion. You can mark multiple at once.
`edit.unstar`	Unfavorite a word	Unmarks a word from faovirte and allows its deletion. You can unmark multiple at once.
`edit.lock`	Lock a word	Locks a word and prevents it from edits. You can lock multiple at once.
`edit.unlock`	Unlock a word	Unlocks a word and allows it to be edited. You can unlock multiple at once.
`edit.remove`	Remove a word	Deletes a word from the dictionary.

Searching

This application provides multiple ways to customize your searches.

Feature	Name	Action
`search.sort`	Sort Favorites	Ability to sort favorite words to top, to bottom, hidden, only show favorites or in an ordinary order with other words.
`search.instant`	Instant Search	Ability to search as you type using Swing Workers.
`search.match`	Match Searches	Ability to pick whether the search should match against words or definitions, or casings or uses the search text as a regex.
`search.random`	Random Word	See the word of the day, and ability to request a new word. Ability to see a certain message if there is nothing within the database.
`search.history`	View Search History	You can see what words were queried, how many results returned, how much time elapsed and when that query happened.

Quiz

The quiz is formatted in a way, so that your goal would be to go for the highest score possible. Score is affected by your Combo Stack, which goes up by how many answers you get correct in a row. The higher your combo goes, the higher your multiplier scales. But be aware, one wrong answer will collapse your multiplier back to 1x.

There are partners, acting as lifelines, you can choose up to 4, each having a unique one-time use ability that may help planning to max out your score gain:

Noah: Grants immunity to damage and combo break for 10s.
Mio: Converts 30% of damage taken into score.
Eunie: Heals 20% of your max HP.
Taion: Grants immunity to damage from incorrect answers for the next 3 incorrect answers.
Sena: The next score change is multiplied by 4.
Lanz: Reduces all damage taken, but also score gains.
Matthew: Increases combo multiplier by 1.5x.
A: Heals 5% of your max HP and grants immunity to damage for 10s. (She originally was going to grant immunity to damage, heal and slow down time for that period, but that seems too difficult to do)
Nikol: Reduces all damage taken greatly, but combo multiplier no longer stacks.
Glimmer: Heals 10% of your max HP, and grants a multiplier on the next 3 questions.
Rex: The next score change is multiplied by 10.
Shulk: Heal 10% of your HP once you take fatal damage.