JavaDoc Upload

ImAleeexx · May 23, 2022 · 1d48325 · 1d48325
1 parent 5727509
commit 1d48325
Show file tree

Hide file tree

Showing 127 changed files with 29,680 additions and 69 deletions.
diff --git a/Codigo Fuente/src/src/com/imaleex/esportapp/Controllers/AdminController.java b/Codigo Fuente/src/src/com/imaleex/esportapp/Controllers/AdminController.java
@@ -113,7 +113,7 @@ public static void deleteJugador(Jugador jugador) throws DbException {
      * Metodo que devuelve un partido encontrado en la base de datos
      * @param idPartido id del partido a buscar
      * @return partido encontrado
-     * @throws DataNotFoundException si no se encuentra el partido
+     * @throws DbException si no se encuentra el partido
      */
     public static Partido buscarPartidoId(int idPartido) throws DbException {
         assert Main.user.getType() == 1;
@@ -138,7 +138,7 @@ public static Double sueldoTotalJugadores() throws DbException {
     //Dueños
     /**
      * Buscar un dueño por su dni en la base de datos
-     * @param dni
+     * @param dni dni del dueño a buscar
      * @return dueño encontrado
      * @throws DataNotFoundException si no se encuentra el dueño
      */
@@ -149,7 +149,7 @@ public static Dueno buscarDueno(String dni) throws DataNotFoundException {
 
     /**
      * Buscar un dueño por su id en la base de datos
-     * @param id
+     * @param id id del dueño a buscar
      * @return dueño encontrado
      * @throws DataNotFoundException si no se encuentra el dueño
      */
@@ -170,7 +170,7 @@ public static ArrayList<Dueno> listDuenos() throws DbException {
 
     /**
      * Actualizar dueño de la base de datos
-     * @param dueno
+     * @param dueno dueño a actualizar
      * @throws DbException si no se puede actualizar el dueño
      */
     public static void updateDueno(Dueno dueno) throws DbException {
@@ -180,7 +180,7 @@ public static void updateDueno(Dueno dueno) throws DbException {
 
     /**
      * Insertar dueño en la base de datos
-     * @param dueno
+     * @param dueno dueño a insertar
      * @throws DbException si no se puede insertar el dueño
      */
     public static void insertarDueno(Dueno dueno) throws DbException {
@@ -190,7 +190,7 @@ public static void insertarDueno(Dueno dueno) throws DbException {
 
     /**
      * Eliminar dueño de la base de datos
-     * @param dueno
+     * @param dueno dueño a eliminar
      * @throws DbException si no se puede eliminar el dueño
      */
     public static void eliminarDueno(Dueno dueno) throws DbException {
@@ -202,9 +202,9 @@ public static void eliminarDueno(Dueno dueno) throws DbException {
 
     /**
      * Buscar usuario por nombre en la base de datos
-     * @param username
+     * @param username nombre del usuario a buscar
      * @return usuario encontrado
-     * @throws DataNotFoundException si no se encuentra el usuario
+     * @throws UserNotFoundException si no se encuentra el usuario
      */
     public static Usuario buscarUsuario(String username) throws UserNotFoundException {
         assert Main.user.getType() == 1;
@@ -213,7 +213,7 @@ public static Usuario buscarUsuario(String username) throws UserNotFoundExceptio
 
     /**
      * Eliminar a un usuario por nombre en la base de datos
-     * @param username
+     * @param username nombre del usuario a eliminar
      * @throws DbException si no se puede eliminar el usuario
      */
     public static void deleteUserByName(String username) throws DbException {
@@ -223,7 +223,7 @@ public static void deleteUserByName(String username) throws DbException {
 
     /**
      * Editar usuario en la base de datos
-     * @param user
+     * @param user usuario a editar
      * @throws DbException si no se puede editar el usuario
      */
     public static void editUser(Usuario user) throws DbException {
@@ -233,7 +233,7 @@ public static void editUser(Usuario user) throws DbException {
 
     /**
      * Insertar usuario en la base de datos
-     * @param user
+     * @param user usuario a insertar
      * @throws DbException si no se puede insertar el usuario
      */
     public static void createUser(Usuario user) throws DbException {
@@ -254,7 +254,7 @@ public static ArrayList<Usuario> listUsers() throws DbException {
 
     /**
      * Buscar entrenador por dni en la base de datos
-     * @param dni
+     * @param dni dni del entrenador a buscar
      * @return entrenador encontrado
      * @throws DataNotFoundException si no se encuentra el entrenador
      * @throws DbException si no se puede obtener el entrenador
@@ -266,7 +266,7 @@ public static Entrenador buscarEntrenadorDni(String dni) throws DataNotFoundExce
 
     /**
      * Buscar entrenador por Id en la base de datos
-     * @param id
+     * @param id    id del entrenador a buscar
      * @return entrenador encontrado
      * @throws DataNotFoundException si no se encuentra el entrenador
      * @throws DbException si no se puede obtener el entrenador
@@ -288,7 +288,7 @@ public static ArrayList<Entrenador> listaEntrenadores() throws DbException {
 
     /**
      * Entrenador para actualizarlo en la base de datos
-     * @param entrenador
+     * @param entrenador entrenador a actualizar
      * @throws DbException si no se puede actualizar el entrenador
      */
     public static void updateEntrenador(Entrenador entrenador) throws DbException {
@@ -298,7 +298,7 @@ public static void updateEntrenador(Entrenador entrenador) throws DbException {
 
     /**
      * Entrenador para insertarlo en la base de datos
-     * @param entrenador
+     * @param entrenador entrenador a insertar
      * @throws DbException si no se puede insertar el entrenador
      */
     public static void insertEntrenador(Entrenador entrenador) throws DbException {
@@ -308,7 +308,7 @@ public static void insertEntrenador(Entrenador entrenador) throws DbException {
 
     /**
      * Entrenador para eliminarlo de la base de datos
-     * @param entrenador
+     * @param entrenador entrenador a eliminar
      * @throws DbException si no se puede eliminar el entrenador
      */
     public static void deleteEntrenador(Entrenador entrenador) throws DbException {
@@ -320,7 +320,7 @@ public static void deleteEntrenador(Entrenador entrenador) throws DbException {
 
     /**
      *  Nombre de equipo para buscarlo en la base de datos
-     * @param equipo
+     * @param equipo nombre del equipo a buscar
      * @return equipo encontrado
      * @throws DataNotFoundException si no se encuentra el equipo
      */
@@ -331,7 +331,7 @@ public static Equipo buscarEquipo(String equipo) throws DataNotFoundException {
 
     /**
      * Cargar los jugadores en un objeto Equipo
-     * @param equipo
+     * @param equipo equipo a cargar
      */
     public static void loadJugadoresToEquipo(Equipo equipo) {
         assert Main.user.getType() == 1;
@@ -344,7 +344,7 @@ public static void loadJugadoresToEquipo(Equipo equipo) {
 
     /**
      * Insertar el equipo que le pasamos en la base de datos
-     * @param equipo
+     * @param equipo equipo a insertar
      * @throws DbException si no se puede insertar el equipo
      */
     public static void insertEquipo(Equipo equipo) throws DbException {
@@ -355,7 +355,7 @@ public static void insertEquipo(Equipo equipo) throws DbException {
 
     /**
      * Actualizar el equipo que le pasamos en la base de datos
-     * @param equipo
+     * @param equipo equipo a actualizar
      * @throws DbException si no se puede actualizar el equipo
      */
     public static void updateEquipo(Equipo equipo) throws DbException {
@@ -366,7 +366,7 @@ public static void updateEquipo(Equipo equipo) throws DbException {
 
     /**
      * Equipo para mirar si el dueño, el entrenador o el asistente ya tienen un equipo asignado
-     * @param equipo
+     * @param equipo equipo a comprobar
      * @throws DbException si no se puede mirar el equipo
      */
     private static void checkDuplicatesEquipo(Equipo equipo) throws DbException {
@@ -398,8 +398,9 @@ public static ArrayList<Equipo> listaEquipos() throws DbException {
 
     /**
      * Insertamos una Persona en la base de datos
-     * @param persona
+     * @param persona persona a insertar
      * @throws DbException si no se puede insertar la persona
+     * @return objeto persona insertado con el id
      */
     public static Persona insertarPersona(Persona persona) throws DbException {
         assert Main.user.getType() == 1;
@@ -421,7 +422,7 @@ public static ArrayList<Jornada> getJornadas() throws DbException {
     //Partidos
     /**
      * Actualiza el marcador de un partido
-     * @param partido
+     * @param partido partido a actualizar
      * @throws DbException si no se puede actualizar el partido
      */
     public static void actualizarMarcador(Partido partido) throws DbException {
@@ -519,6 +520,7 @@ public static void generateMatchCalendar() throws DbException {
     }
     /**
      * Revisamos si la liga esta iniciada
+     * @return true si esta iniciada, false si no
      */
     public static boolean checkLeagueStarted(){
         try {

diff --git a/Codigo Fuente/src/src/com/imaleex/esportapp/Controllers/UserController.java b/Codigo Fuente/src/src/com/imaleex/esportapp/Controllers/UserController.java
@@ -76,7 +76,7 @@ private static ArrayList<Equipo> listaEquipos() throws DbException {
 
     /**
      * Lista de los partidos de la jornada
-     * @param jornada
+     * @param jornada jornada a buscar
      * @return lista de los partidos de la jornada
      * @throws DbException error al optener la lista de partidos
      */

diff --git a/Codigo Fuente/src/src/com/imaleex/esportapp/Db/Dao/EquipoDAO.java b/Codigo Fuente/src/src/com/imaleex/esportapp/Db/Dao/EquipoDAO.java
@@ -369,7 +369,7 @@ public static Equipo searchEquipoById(Integer id) throws DataNotFoundException {
      * Metodo para cargar un objeto de la base de datos
      * @param equipo Equipo a cargar
      * @param rs ResultSet con los datos del equipo
-     * @throws SQLException
+     * @throws SQLException si hay un error en la base de datos o en la conexion
      */
     private static void loadObject(Equipo equipo, ResultSet rs) throws SQLException {
         equipo.setId(rs.getInt("id"));

diff --git a/Codigo Fuente/src/src/com/imaleex/esportapp/Db/Dao/JornadaDAO.java b/Codigo Fuente/src/src/com/imaleex/esportapp/Db/Dao/JornadaDAO.java
@@ -10,7 +10,7 @@
 import java.sql.SQLException;
 import java.util.ArrayList;
 /**
- * <h1>DAO de objeto jornada</h1></h1>
+ * <h1>DAO de objeto jornada</h1>
  *
  * @author Alex Cortes
  * @author Aritz Castillo
@@ -53,7 +53,8 @@ public static Jornada searchJornada(int id) throws DataNotFoundException {
     /**
      * Metodo insertar una jornada
      * @param jornada jornada a insertar
-     * @throws DataNotFoundException si se da un error al insertar la jornada
+     * @return jornada insertada
+     * @throws DbException si se da un error al insertar la jornada
      */
     public static Jornada insertJornada(Jornada jornada) throws DbException {
         try {
@@ -84,7 +85,7 @@ public static Jornada insertJornada(Jornada jornada) throws DbException {
     /**
      * Metodo para actualizar una jornada
      * @param jornada jornada a actualizar
-     * @throws DataNotFoundException si se da un error al actualizar la jornada
+     * @throws DbException si se da un error al actualizar la jornada
      */
     public static void updateJornada(Jornada jornada) throws DbException {
         String sql = "UPDATE jornadas SET fecha = ? WHERE id = ?";
@@ -109,7 +110,7 @@ public static void updateJornada(Jornada jornada) throws DbException {
     /**
      * Metodo para eliminar una jornada por su id
      * @param id id de la jornada
-     * @throws DataNotFoundException si se da un error al eliminar la jornada
+     * @throws DbException si se da un error al eliminar la jornada
      */
     public static void deleteJornada(int id) throws DbException {
         String sql = "DELETE FROM jornadas WHERE id = ?";
@@ -132,7 +133,7 @@ public static void deleteJornada(int id) throws DbException {
 
     /**
      * Metodo para eliminar todas las jornadas
-     * @throws DataNotFoundException si se da un error al eliminar todas las jornadas
+     * @throws DbException si se da un error al eliminar todas las jornadas
      */
     public static void deleteAllJornadas() throws DbException {
         String sql = "DELETE FROM jornadas";
@@ -150,7 +151,7 @@ public static void deleteAllJornadas() throws DbException {
     /**
      * Metodo para obtener todas las jornadas
      * @return lista de jornadas
-     * @throws DataNotFoundException si se da un error al obtener la lista de jornadas
+     * @throws DbException si se da un error al obtener la lista de jornadas
      */
     public static ArrayList<Jornada> getJornadas() throws DbException {
         String sql = "SELECT * FROM jornadas";

diff --git a/Codigo Fuente/src/src/com/imaleex/esportapp/Db/Dao/PartidoDAO.java b/Codigo Fuente/src/src/com/imaleex/esportapp/Db/Dao/PartidoDAO.java
@@ -14,7 +14,7 @@
 import java.sql.SQLException;
 import java.util.ArrayList;
 /**
- * <h1>DAO de objeto partido</h1></h1>
+ * <h1>DAO de objeto partido</h1>
  *
  * @author Alex Cortes
  * @author Aritz Castillo
@@ -26,7 +26,8 @@ public class PartidoDAO {
      * Metodo para buscar un partido por su id
      * @param id id del partido
      * @return Partido con el id pasado por parametro
-     * @throws DataNotFoundException si no se encuentra el partido
+     * @throws DbException si no se encuentra el partido
+     *
      */
     public static Partido searchPartido(int id) throws DbException {
         String sql = "SELECT * FROM partidos  WHERE id LIKE ? ";
@@ -69,7 +70,8 @@ public static Partido searchPartido(int id) throws DbException {
     /**
      * Metodo para insertar un partido
      * @param partido partido que vamos a insertar
-     * @throws DataNotFoundException si se da un error al insertar el partido
+     * @throws DbException si se da un error al insertar el partido
+     * @return objeto partido con el id del partido insertado
      */
     public static Partido insertPartido(Partido partido) throws DbException {
         String sql = "INSERT INTO partidos (id_local, id_visitante, hora, resultado_local, resultado_visitante, id_jornada) VALUES (?,?,?,?,?,?)";
@@ -98,7 +100,7 @@ public static Partido insertPartido(Partido partido) throws DbException {
     /**
      * Metodo para actualizar un partido
      * @param partido partido que vamos a actualizar
-     * @throws DataNotFoundException si nos da un error al actualizar
+     * @throws DbException si nos da un error al actualizar
      */
     public static void updatePartido(Partido partido) throws DbException {
         String sql = "UPDATE partidos SET id_local = ?, id_visitante = ?, hora = ?, resultado_local = ?, resultado_visitante = ?, id_jornada = ? WHERE id = ?";
@@ -123,7 +125,7 @@ public static void updatePartido(Partido partido) throws DbException {
     /**
      * Metodo para eliminar un partido
      * @param partido partido que queremos eliminar
-     * @throws DataNotFoundException si nos da un error al eliminar el partido
+     * @throws DbException si nos da un error al eliminar el partido
      */
     public static void deletePartido(Partido partido) throws DbException {
         String sql = "DELETE FROM partidos WHERE id = ?";
@@ -141,7 +143,7 @@ public static void deletePartido(Partido partido) throws DbException {
 
     /**
      * Metodo para eliminar todos los partidos
-     * @throws DataNotFoundException si nnos da un error al eliminar todos los partidos
+     * @throws DbException si nnos da un error al eliminar todos los partidos
      */
     public static void deleteAllPartidos() throws DbException {
         String sql = "DELETE FROM partidos";
@@ -158,7 +160,7 @@ public static void deleteAllPartidos() throws DbException {
      * Metodo para listar todos los partidos de una jornada
      * @param jornada jornada de la que queremos listar los partidos
      * @return lista de los partidos de la jornada
-     * @throws DataNotFoundException si no se encuentran los partidos de la jornada
+     * @throws DbException si no se encuentran los partidos de la jornada
      */
     public static ArrayList<Partido> listaPartidosByJornada(Jornada jornada) throws DbException {
         ArrayList<Partido> partidos = new ArrayList<>();
@@ -177,7 +179,7 @@ public static ArrayList<Partido> listaPartidosByJornada(Jornada jornada) throws
     /**
      * Metodo para buscar partidos jugados
      * @return lista con los partidos jugados
-     * @throws DataNotFoundException si no se encuentran los partidos jugados
+     * @throws DbException si no se encuentran los partidos jugados
      */
     public static ArrayList<Partido> listaPartidosJugados() throws DbException {
         ArrayList<Partido> partidos = new ArrayList<>();
@@ -193,10 +195,10 @@ public static ArrayList<Partido> listaPartidosJugados() throws DbException {
     }
 
     /**
-     * Metodo para cargar la lista de partidos usados en el metodo @link{listaPartidosJugados} y @link{listaPartidosByJornada}
+     * Metodo para cargar la lista de partidos usados en el metodo {@link #listaPartidosJugados} y {@link #listaPartidosByJornada}
      * @param partidos id de la jornada
      * @param stmt conexion a la base de datos
-     * @throws DataNotFoundException si nos da un error al cargar la lista de partidos
+     * @throws SQLException si nos da un error al cargar la lista de partidos
      */
     private static void loadListaPartidos(ArrayList<Partido> partidos, PreparedStatement stmt) throws SQLException {
         ResultSet rs = stmt.executeQuery();