# Uses of Package
edu.wisc.game.sql

- Packages that use edu.wisc.game.sql
  Package | Description
  --- | ---
  edu.wisc.game.engine | Top-level Game Server code
  edu.wisc.game.pseudo |
  edu.wisc.game.rest | The RESTful web API
  edu.wisc.game.saved |
  edu.wisc.game.sql | Persistent data structures
  edu.wisc.game.svg |
  edu.wisc.game.web | Back-end classes for some auxiliary JSP pages
  edu.wisc.game.websocket |

- Classes in edu.wisc.game.sql used by edu.wisc.game.engine
  Class | Description
  --- | ---
  Board |
  GameGenerator | A GameGenerator generates random games (with the same rule set and randomly created initial boards) based on the provided parameter range specifications
  MlcLog | An auxiliary class used by the Captive Game Server for the optional logging of MLC run results.
  Piece | Represents a piece of a specified type at a specified location.
  Piece.Color |
  Piece.Shape |

- Classes in edu.wisc.game.sql used by edu.wisc.game.pseudo
  Class | Description
  --- | ---
  Episode.Move | A Move instance describes an [attempted] act of picking a piece and dropping it into a bucket.
  EpisodeInfo | An EpisodeInfo instance extends an Episode, containing additional information related to it being played as part of an experiment.
  PlayerInfo | A PlayerInfo object represent information about a player (what trial list he's in, what episodes he's done etc) stored in the SQL database.

- Classes in edu.wisc.game.sql used by edu.wisc.game.rest
  Class | Description
  --- | ---
  Board |
  Episode.Display | Can be sent to the web client in JSON format, where it would be used to display the current state of the episode
  EpisodeInfo.ExtendedDisplay | Provides some extra information related to the episode's context within the experiment.
  ImageObject.Generator | An image generator is an object that can be used to obtain a random IPB object.
  Piece | Represents a piece of a specified type at a specified location.
  Piece.Color |
  Piece.Shape |
  PlayerInfo | A PlayerInfo object represent information about a player (what trial list he's in, what episodes he's done etc) stored in the SQL database.
  PlayerInfo.TransitionMap |
  User | Information about a repeat user (who may own multiple playerId) stored in the SQL database.

- Classes in edu.wisc.game.sql used by edu.wisc.game.saved
  Class | Description
  --- | ---
  Board |
  Episode.Pick | A Pick instance describes the act of picking a piece, without specifying its destination

- Classes in edu.wisc.game.sql used by edu.wisc.game.sql
  Class | Description
  --- | ---
  Board |
  Board.Pos | Can be used to describe the position of a piece on the [1:N]x[1:N] grid, or that of a bucket (at (0,0), ...
  Episode | An Episode is a single instance of a Game played by a person or machine with our game server.
  Episode.Display | Can be sent to the web client in JSON format, where it would be used to display the current state of the episode
  Episode.Move | A Move instance describes an [attempted] act of picking a piece and dropping it into a bucket.
  Episode.OutputMode |
  Episode.Pick | A Pick instance describes the act of picking a piece, without specifying its destination
  EpisodeInfo | An EpisodeInfo instance extends an Episode, containing additional information related to it being played as part of an experiment.
  EpisodeInfo.ExtendedDisplay | Provides some extra information related to the episode's context within the experiment.
  Game | A Game object defines how an Episode may be created.
  GameGenerator | A GameGenerator generates random games (with the same rule set and randomly created initial boards) based on the provided parameter range specifications
  GameGenerator.Features |
  ImageObject | Describes an image-and-properties-based object.
  ImageObject.Generator | An image generator is an object that can be used to obtain a random IPB object.
  MlcLog.LogFormat | Supported log file formats
  Piece | Represents a piece of a specified type at a specified location.
  Piece.Color |
  Piece.PseudoEnum | A flexible replacement for an Enum
  Piece.Shape |
  PlayerInfo | A PlayerInfo object represent information about a player (what trial list he's in, what episodes he's done etc) stored in the SQL database.
  PlayerInfo.Action | What type of action takes the player to a particular destination?
  PlayerInfo.Series | A Series is a list of all episodes played under a specific param set.
  PlayerInfo.Transition | Where can we go from here?
  PlayerInfo.TransitionMap |
  PropertiesTable | This is an auxiliary class, used to read the entire content of a properties file, and to create ImageObject objects for all image files in the directory.
  RecentKnowledge | An auxiliary data structure, used as an element of EpisodeInfo.ExtendedDisplay, used to sent to the GUI client, in a concise form, the info about the knowledge of the board acquired through the recent players' actions (those since the last board change, i.e the last successful move).
  ReplayedEpisode.RandomPlayer | The possible random player models.
  Role | A role is simply a database-storable wrapper around the role name
  Role.Name |
  Test | Used for testing JPA persistence features
  TestChild | An EpisodeInfo instance extends an Episode, containing additional information related to it being played as part of an experiment.
  TestParent |
  User | Information about a repeat user (who may own multiple playerId) stored in the SQL database.

- Classes in edu.wisc.game.sql used by edu.wisc.game.svg
  Class | Description
  --- | ---
  ImageObject | Describes an image-and-properties-based object.
  ImageObject.Generator | An image generator is an object that can be used to obtain a random IPB object.

- Classes in edu.wisc.game.sql used by edu.wisc.game.web
  Class | Description
  --- | ---
  ImageObject | Describes an image-and-properties-based object.
  PlayerInfo | A PlayerInfo object represent information about a player (what trial list he's in, what episodes he's done etc) stored in the SQL database.
  User | Information about a repeat user (who may own multiple playerId) stored in the SQL database.

- Classes in edu.wisc.game.sql used by edu.wisc.game.websocket
  Class | Description
  --- | ---
  Episode.Pick | A Pick instance describes the act of picking a piece, without specifying its destination