README.md

BILL

A project that imitates a universities billing system.

Last Modified: 28 November 2017

Getting Started

git clone https://github.com/theblindprophet/BILL.git

Prerequisites

• Java
• Maven
• Eclipse

Structure

• BILL
  • LICENSE
  • README
  • list.md
  • pom.xml
  • src
    • test
      • java
        • edu
          • sc
            • BILLTest.java
            • BILLTestMain.java
        • resources
      • resources
        • Fall17-InputOutputKeyMap.pdf
        • README
        • bill.txt
        • students.txt
        • users.txt
    • main
      • java
        • edu
          • sc
            • csce740
              • BILL.java
              • BILLIntf.java
              • model
                • AVPS.java
                • Action.java
                • AdminRightsException.java
                • Bill.java
                • Billing.java
                • Course.java
                • DHCS.java
                • EditRecordException.java
                • EnumFee.java
                • Fee.java
                • GetRecordException.java
                • InvalidPaymentException.java
                • InvalidUserIdException.java
                • StudentDemographics.java
                • StudentRecord.java
                • Term.java
                • Transaction.java
                • User.java
      • resources
        • README
        • bill.txt
        • users.txt
        • students.txt

Running the tests

All unit tests, written with JUnit 5 are in src/test/java/edu/sc/BILLTest.java and can be run by opening that file in Eclipse and clicking Play.

Break down into end to end tests

Each test covers at least one, in most cases 2, code paths from the class BILL in src/main/java/edu/sc/csce740/BILL.java.

Built With

• Java 8
• Maven - Dependency Management
• Eclipse

Notes on data files:

These files are in the JSON format. To read them into BILL, it is easiest to use Google's GSON library, which can be downloaded from here: gson

For example, to deserialize (read text into object model):

List<StudentRecord> studentRecords = new Gson().fromJson( new FileReader( new File("students.txt")), new TypeToken<List<StudentRecord>>(){}.getType());

and then to serialize (write object model back to text):

String representation = new GsonBuilder().setPrettyPrinting().create().toJson(studentRecords);

For the project, you will need to read in:

• students.txt (student records)
• users.txt (user permissions)

bill.txt is an example of a bill written back to a file. You don't need to read it into your system. It is just included as an example.

Authors

• Jamie Gross - Computer Science BS
• Preston Barbare - Computer Science MS
• Logan Murray - Computer Science MS

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details