Microsoft Word - SADI_Assignment1_sem2_2018.doc Software Architecture Design and Implementation COSC 2391/2401 Semester 2, 2018 Casino Style Card Game Assignment Part 1: Console Implementation (25...

I have attached both the code zip file as well as the assignment document.


Microsoft Word - SADI_Assignment1_sem2_2018.doc Software Architecture Design and Implementation COSC 2391/2401 Semester 2, 2018 Casino Style Card Game Assignment Part 1: Console Implementation (25 marks) NOTE: The provided Javadoc and commented interface source code is your main specification, this document only serves as an overview. You should also regularly follow the Canvas assignment discussion board for assignment related clarifications and discussion. This assignment requires you to implement a game engine and console based user interface (logging output only, no user interaction required) for a casino style card game that is loosely based on Black Jack but is for the gambler in a hurry that doesn’t want to think too hard and wants to trust in luck alone without having to worry about statistics! The rules are simple, the player places a bet and then receives a set of cards from the dealer (from a standard 52 card deck) until they bust by exceeding the limit of 21. The final score is the sum of the cards prior to the final card that caused the bust. The house then deals on their own behalf against the player .. Highest score wins! A draw is a no contest and the bet is returned to the player. The rules for cards are simple with no action required by the player. An Ace is always worth 1, Jack, Queen and King are 10 and the other cards are worth their face value. i.e. a seven of spades is worth 7 points. NOTE: players only play against the house not against each other. Also, do not worry about modelling a real Casino “Black Jack” game with its more complex rules. The focus here is on the implementation using a simple, highest card sum wins. HOW TO GET STARTED: For this assignment you are provided with a skeleton eclipse project (CardGame.zip) that contains a number of interfaces that you must implement to provide the specified behaviour as well as a simple client which will help you get started. The provided Javadoc documentation (load index.html from CardGame/docs/ into a browser to view), and commented interface source code (in the provided package model.interfaces) is your main specification, this document only serves as an overview. NOTE: You may copy and add to the provided console client code to facilitate more thorough testing. You must however ensure that the original unaltered code can still execute since we will use our own test client to check your code which is strictly based on the interfaces (this is the point of having interfaces after all!) i.e. DO NOT CHANGE ANY OF THE INTERFACES ETC. The supplied project also contains code that will validate your interfaces for the main four classes you must write (see implementation specification below), and will warn you if you have failed to implement the required interfaces or have otherwise added any non-private methods that break the public interface contract. By default the validator lists all the expected methods as well as your implemented methods so you can use output this to find problems if you fail the validation. You do not need to provide any console input, all your test data can be hard coded as in the provided SimpleTestClient.java Implementation Specifications Your primary goal is to implement the provided GameEngine, Player, GameEngineCallback and PlayingCard interfaces, in classes called GameEngineImpl, SimplePlayer, GameEngineCallbackImpl and PlayingCardImpl. You must provide the behaviour specified by the javadoc comments in the various interfaces and the generated javadoc index.html. The imports in SimpleTestClient.java show you which packages these classes should be placed in. More specifically, you must provide appropriate constructors (these can be determined from SimpleTestClient.java and are also documented in the relevant interfaces) and method implementations (from the four interfaces) in order to ensure that your solution can be complied and tested without modifying the provided SimpleTestClient.java1 (although you can and should extend this class to thoroughly test your code). A sample output trace (OutputTrace.txt) is provided to help you write correct behaviour in the GameEngineImpl which in turn calls the GameEngineCallbackImpl class to perform the actual logging. You should follow the exact output format although we will not be checking down to individual commas or spaces! Your client code (SimpleTestClient.java and any extended derivatives) should be separate from, and use, your GameEngineImpl implementation via the GameEngine interface. Furthermore, your client should NOT call methods on any of the other interfaces/classes since these are designed to be called directly from the GameEngine2 The main implementation classes GameEngineImpl and GameEngineCallbackImpl are described in more detail below. The SimplePlayer and PlayingCardImpl are relatively straightforward data classes and should not need further explanation for their implementation (beyond the comments provided in the respective interfaces). GameEngineImpl class This is where the main game functionality is contained. All methods from the client are called through this class (see footnote). Methods in the supporting classes should only be called from GameEngineImpl. The main feature of this class that is likely different to previous code you have written is that the GameEngineImpl does not provide any output of its own (i.e. it SHOULD HAVE NO println() or log() statements other than for debugging and these should be commented or removed prior to submission). Instead it calls appropriate methods on the GameEngineCallback as it runs (see below) which is where all output is logged to the console for assignment part 1. This provides a good level of isolation and will allow you to use your GameEngineImpl unchanged in assignment 2 when we add a graphical AWT/Swing use interface! NOTE: Your GameEngineImpl must maintain a collection (or array) of Players AND a collection (or array) of GameEngineCallbacks. When a callback method should be called this must be done in a loop iterating through all callbacks. Note that each callback receives the same data so there is no need to distinguish them (i.e. they are all the same and not player specific). SimpleTestClient.java gives an example for two players and shows it is trivial to add more (simply increase the array size by adding to the initialiser). 1 A common mistake is to change the imports (sometimes accidentally!) Therefore, you MUST NOT change the imports and must place the class implementations in the expected package so that we can test your code with our own testing client. 2 This is because we will be testing your code with our own client by calling the specified GameEngine methods. We will not call methods on any other classes and therefore if your GameEngineImpl code expected other methods to be called from the client (rather than calling them itself) it won’t work! GameEngineCallbackImpl class The sole purpose of this class is to support the user interface (view) which in assignment part 1 consists of simple console/logging output. Therefore all this class needs to do is log data to the console from the parameters passed to its methods. Apart from implementing the logging (we recommend String.format() here) the main thing is to make sure you call the right method at the right time! (see below). You should also as much as possible make use the of the overidden toString() methods you will implement in SimplePlayer and PlayingCardImpl since this will simplify the logging! The only class that will call the GameEngineCallbackImpl methods is the GameEngineImpl class. For example as the dealPlayer(…) method is executing in a loop it will call the nextCard(…) method on the GameEngineCallbackImpl (via the GameEngineCallback interface). Details of the exact flow and where GameEngineCallback methods should be called are provided in the GameEngineImpl source code and associated Javadoc. IMPORTANT: The main thing to watch out for (i.e. “gotcha”) is that this class should not manage any game state or implement any game based functionality which instead belongs in the GameEngineImpl. The core test here is that we should be able to replace your GameEngineCallbackImpl with our own (which obviously knows nothing about your implementation) and your GameEngineImpl code should still work. This is a true test of encapsulation and programming using interfaces (i.e. to a specification) and is one of the main objectives of this assignment! IF YOU DO NOT FOLLOW THE NOTE ABOVE YOUR CODE WILL NOT EXECUTE PROPERLY WITH OUR TEST HARNESS AND YOU WILL LOSE MARKS! PLEASE DON’T GET CAUGHT OUT .. IF IN DOUBT ASK, WE ARE HAPPY TO HELP :) IMPLEMENTATION TIPS Before you start coding make sure you have thoroughly read this overview document and carefully inspected the supplied Java code and Javadoc documentation. It might take a bit of work but the more carefully you read before beginning coding the better prepared you will be! 1. Start by importing the supplied Java project CardGame.zip. It will not compile yet but this is normal and to be expected. 2. The first step is to get the code to compile by writing a minimal implementation of the required classes. Most of the methods can be left blank at this stage, the idea is satisfy all of the dependencies in SimpleTestClient.java that are preventing successful compilation. Eclipse can help automate much of this with the right click Source ... context menu but it is a good idea to write at least a few of the classes by hand to make sure you are confident of the relationship between classes and the interfaces that they implement. It will also help familiarise you with the class/method names and their purpose. I have already provided a partial implementation of GameEngineCallbackImpl showing the use of the Java logging framework but you will need to complete it by implementing the missing methods. 3. When writing the SimplePlayer class you will need a 3 argument constructor for the code to compile. You could leave this blank at this stage but might as well implement it by saving the parameters as instance variables/attributes. In fact you might as well implement the methods while you are there