Skip to content
Gustavo Ortiz edited this page Oct 30, 2023 · 1 revision

Documentación de la Clase Conexion

La clase Conexion proporciona métodos para establecer una conexión a una base de datos MySQL.

Método getConnection

Descripción

Este método estático se utiliza para obtener una conexión a la base de datos especificada.

Parámetros

Ninguno.

Valor de retorno

  • Tipo: Connection
  • Descripción: Un objeto de tipo Connection que representa la conexión a la base de datos.

Ejemplo de uso

java Connection conexion = Conexion.getConnection();

Excepciones Si ocurre un error al cargar el controlador de la base de datos o al establecer la conexión, se capturan las excepciones ClassNotFoundException y SQLException. Variables de configuración baseDatos: Nombre de la base de datos a la que se desea conectar. url: URL de conexión a la base de datos. usuario: Nombre de usuario para acceder a la base de datos. password: Contraseña para acceder a la base de datos. Ejemplo de configuración var baseDatos = "estudiantes"; var url = "jdbc:mysql://localhost:3306/" + baseDatos; var usuario = "root"; var password = "admin"; Ejemplo completo de uso

import UNT.conexion.Conexion; import java.sql.Connection; import java.sql.SQLException;

public class EjemploConexion { public static void main(String[] args) { // Obtener una conexión a la base de datos Connection conexion = Conexion.getConnection();

    `if (conexion != null) {`
        `System.out.println("Conexión exitosa a la base de datos.");`
        `try {`
            `// Realizar operaciones en la base de datos aquí`
            `// ...`
            `// Cerrar la conexión cuando haya terminado`
            `conexion.close();`
        `} catch (SQLException e) {`
            `System.out.println("Error al cerrar la conexión: " + e.getMessage());`
        `}`
    `} else {`
        `System.out.println("No se pudo establecer la conexión a la base de datos.");`
    `}`
`}`

}

Documentación de la Clase EstudianteDAO

La clase EstudianteDAO se encarga de interactuar con la base de datos para realizar operaciones relacionadas con los estudiantes.

Método modificarEstudiante

Descripción

Este método se utiliza para modificar los datos de un estudiante en la base de datos.

Parámetros

  • estudiante: Un objeto de tipo Estudiante con los datos actualizados del estudiante a modificar.

Valor de retorno

  • Tipo: boolean
  • Descripción: true si la modificación se realizó con éxito; false en caso contrario.

Ejemplo de uso

Estudiante estudianteModificado = new Estudiante(2, "Alejandra", "Costas", "alecostas@gmail.com", "8456156"); boolean modificado = estudianteDao.modificarEstudiante(estudianteModificado);

Excepciones Si ocurre un error durante la modificación, se captura una excepción y se imprime un mensaje de error. Método listarEstudiantes Descripción Este método se utiliza para obtener una lista de todos los estudiantes almacenados en la base de datos.

Parámetros Ninguno.

Valor de retorno Tipo: List Descripción: Una lista de objetos Estudiante que representan a todos los estudiantes almacenados en la base de datos. Ejemplo de uso List estudiantes = estudianteDao.listarEstudiantes();

Excepciones Si ocurre un error al recuperar los datos de la base de datos, se captura una excepción y se imprime un mensaje de error. Método buscarEstudiantePorId Descripción Este método se utiliza para buscar un estudiante en la base de datos por su ID.

Parámetros estudiante: Un objeto de tipo Estudiante con el ID del estudiante a buscar. Valor de retorno Tipo: boolean Descripción: true si se encontró el estudiante; false en caso contrario. Ejemplo de uso Estudiante estudiante10 = new Estudiante(10, "", "", "", ""); boolean encontrado = estudianteDao.buscarEstudiantePorId(estudiante10);

Excepciones Si ocurre un error durante la búsqueda, se captura una excepción y se imprime un mensaje de error. Método agregarEstudiante Descripción Este método se utiliza para agregar un nuevo estudiante a la base de datos.

Parámetros estudiante: Un objeto de tipo Estudiante con los datos del nuevo estudiante a agregar. Valor de retorno Tipo: boolean Descripción: true si se agregó el estudiante con éxito; false en caso contrario. Ejemplo de uso

Estudiante nuevoEstudiante = new Estudiante(0, "Carlos", "Lara", "2457863", "carloslara@gmail.com"); boolean agregado = estudianteDao.agregarEstudiante(nuevoEstudiante);

Excepciones Si ocurre un error durante la inserción, se captura una excepción y se imprime un mensaje de error. Método eliminarEstudiante Descripción Este método se utiliza para eliminar un estudiante de la base de datos por su ID.

Parámetros estudiante: Un objeto de tipo Estudiante con el ID del estudiante a eliminar. Valor de retorno Tipo: boolean Descripción: true si se eliminó el estudiante con éxito; false en caso contrario. Ejemplo de uso Estudiante estudianteEliminar = new Estudiante(3); boolean eliminado = estudianteDao.eliminarEstudiante(estudianteEliminar);

Excepciones Si ocurre un error durante la eliminación, se captura una excepción y se imprime un mensaje de error. Ejemplo completo de uso // Crear una instancia de EstudianteDAO EstudianteDAO estudianteDao = new EstudianteDAO();

// Modificar estudiante Estudiante estudianteModificado = new Estudiante(2, "Alejandra", "Costas", "alecostas@gmail.com", "8456156"); boolean modificado = estudianteDao.modificarEstudiante(estudianteModificado);

// Agregar estudiante Estudiante nuevoEstudiante = new Estudiante(0, "Carlos", "Lara", "2457863", "carloslara@gmail.com"); boolean agregado = estudianteDao.agregarEstudiante(nuevoEstudiante);

// Eliminar estudiante con ID 3 Estudiante estudianteEliminar = new Estudiante(3); boolean eliminado = estudianteDao.eliminarEstudiante(estudianteEliminar);

// Listar estudiantes List estudiantes = estudianteDao.listarEstudiantes();

// Buscar estudiante por ID Estudiante estudiante10 = new Estudiante(10, "", "", "", ""); boolean encontrado = estudianteDao.buscarEstudiantePorId(estudiante10);

Documentación de la Clase Estudiante

La clase Estudiante representa un estudiante con sus atributos básicos como ID, nombre, apellido, teléfono y correo electrónico.

Constructores

Constructor por defecto

public Estudiante()

Este constructor crea una instancia de Estudiante con todos los atributos inicializados a sus valores por defecto.

Constructor con parámetros
public Estudiante(int idEstudiante, String nombre, String apellido, String telefono, String email)

Este constructor crea una instancia de Estudiante con los valores proporcionados para cada atributo.

Parámetros
idEstudiante: Un entero que representa el ID del estudiante.
nombre: Una cadena de texto que representa el nombre del estudiante.
apellido: Una cadena de texto que representa el apellido del estudiante.
telefono: Una cadena de texto que representa el número de teléfono del estudiante.
email: Una cadena de texto que representa la dirección de correo electrónico del estudiante.
Métodos Getters y Setters
La clase Estudiante proporciona métodos Getters y Setters para acceder y modificar los atributos de un estudiante.

getIdEstudiante(): Obtiene el ID del estudiante.
setIdEstudiante(int idEstudiante): Establece el ID del estudiante.
getNombre(): Obtiene el nombre del estudiante.
setNombre(String nombre): Establece el nombre del estudiante.
getApellido(): Obtiene el apellido del estudiante.
setApellido(String apellido): Establece el apellido del estudiante.
getTelefono(): Obtiene el número de teléfono del estudiante.
setTelefono(String telefono): Establece el número de teléfono del estudiante.
getEmail(): Obtiene la dirección de correo electrónico del estudiante.
setEmail(String email): Establece la dirección de correo electrónico del estudiante.

Método toString
@Override
public String toString()

Este método devuelve una representación en cadena de texto del objeto Estudiante. Es útil para imprimir los detalles del estudiante en formato legible.

Ejemplo de uso
// Crear una instancia de Estudiante
Estudiante estudiante = new Estudiante(1, "John", "Doe", "123-456-7890", "john.doe@example.com");

// Obtener los atributos del estudiante
int id = estudiante.getIdEstudiante();
String nombre = estudiante.getNombre();
String apellido = estudiante.getApellido();
String telefono = estudiante.getTelefono();
String email = estudiante.getEmail();

// Modificar los atributos del estudiante
estudiante.setNombre("Jane");
estudiante.setTelefono("987-654-3210");

// Obtener una representación en cadena del estudiante
String detalles = estudiante.toString();

Esta clase Estudiante se utiliza para representar a los estudiantes y gestionar sus datos en el contexto de la aplicación.

# Documentación de la Clase SistemaEstudiantesApp

La clase `SistemaEstudiantesApp` es una aplicación que permite interactuar con la base de datos de estudiantes utilizando la clase `EstudianteDAO`.

## Método `main`

### Descripción
El método `main` es el punto de entrada de la aplicación y controla el flujo principal del programa. Permite al usuario realizar operaciones como listar estudiantes, buscar estudiantes, agregar estudiantes, modificar estudiantes y eliminar estudiantes.

### Parámetros
- Ninguno.

### Valor de retorno
- Tipo: `void`
- Descripción: No retorna ningún valor.

### Ejemplo de uso
```java
public static void main(String[] args) {
    // ...
}

Método mostrarMenu
Descripción
El método mostrarMenu muestra un menú de opciones en la consola para que el usuario pueda seleccionar la operación que desea realizar.

Parámetros
Ninguno.
Valor de retorno
Tipo: void
Descripción: No retorna ningún valor.
Ejemplo de uso
private static void mostrarMenu() {
    // ...
}

Método ejecutarOpciones
Descripción
El método ejecutarOpciones permite al usuario seleccionar una opción del menú y ejecutar la operación correspondiente utilizando la clase EstudianteDAO.

Parámetros
consola: Un objeto de tipo Scanner para leer la entrada del usuario.
estudianteDao: Un objeto de tipo EstudianteDAO para interactuar con la base de datos.
Valor de retorno
Tipo: boolean
Descripción: true si el usuario selecciona la opción "Salir" y la aplicación debe finalizar; false en caso contrario.
Ejemplo de uso
private static boolean ejecutarOpciones(Scanner consola, EstudianteDao estudianteDao) {
    // ...
    return salir;
}

Excepciones
Si ocurre un error durante la ejecución de una operación, se captura una excepción y se imprime un mensaje de error.
Ejemplo completo de uso
// Crear una instancia de EstudianteDAO
EstudianteDAO estudianteDao = new EstudianteDAO();

// Configurar el menú y las operaciones
var salir = false;
var consola = new Scanner(System.in);

while (!salir) {
    try {
        mostrarMenu();
        salir = ejecutarOpciones(consola, estudianteDao);
    } catch (Exception e) {
        System.out.println("Ocurrió un error al ejecutar la operación " + e.getMessage());
    }
}