Se movieron las documentaciones a las interfaces

This commit is contained in:
Daniel Cortés
2019-03-22 18:50:18 -03:00
parent e7cd4e3f5d
commit b525a92f86
26 changed files with 2195 additions and 1703 deletions

View File

@@ -38,10 +38,6 @@ import java.util.Optional;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
/**
* Objeto DAO que realiza las querys y mapeos necesarios del objecto Documentos
* En especifico esta implementacion se comunica con la base de datos SQLite
*/
public class SQLiteDocumentosDAO implements DocumentosDAO {
private static final Logger log = LogManager.getLogger(SQLiteDocumentosDAO.class);
private ConnectionHolder connectionHolder;
@@ -50,10 +46,6 @@ public class SQLiteDocumentosDAO implements DocumentosDAO {
this.connectionHolder = new SQLiteConnectionHolder();
}
/**
* Obtiene todas las instancias de Documentos que existen en la base de datos
* @return Una lista con los Documentos
*/
@Override
public List<Documentos> getAll() {
log.debug("Se intentaran conseguir todos los Documentos");
@@ -85,12 +77,6 @@ public class SQLiteDocumentosDAO implements DocumentosDAO {
return documentosList;
}
/**
* Obtiene un Documento dado su id en la base de datos
* @param id el id de la fila del documento en la base de datos
* @return Un optional que contiene el documento que puede ser vacio, dado que no es
* 100% seguro que el id entregado sea valido o exista en la base de datos.
*/
@Override
public Optional<Documentos> getById(int id) {
log.debug("Se intentara conseguir el Documentos con id " + id);
@@ -122,12 +108,6 @@ public class SQLiteDocumentosDAO implements DocumentosDAO {
return Optional.ofNullable(documentos);
}
/**
* Obtiene el Documentos que esta relacionado con la Caja
* @param caja caja con la cual esta relacionado el Documentos
* @return Un optional que contiene el Documentos el cual puede ser vacio, dado que no
* es 100% seguro que exista un Documentos con esa caja.
*/
@Override
public Optional<Documentos> getByCaja(Caja caja) {
log.debug("Se intentara conseguir el Documentos de la caja " + caja);
@@ -161,12 +141,6 @@ public class SQLiteDocumentosDAO implements DocumentosDAO {
return Optional.ofNullable(documentos);
}
/**
* Obtiene la suma de los documentos pertenecientes a una caja
* @param caja caja a la que pertenecen los documentos que se sumaran
* @return Un int con la suma obtenida, en caso que la caja entregada sea igual a
* Caja.EMPTY se retornara 0, al igual que si no existe ningun documentos para la caja
*/
@Override
public int getTotalDocumentos(Caja caja) {
log.debug("Se intentara conseguir el total de Documentos de la caja " + caja);
@@ -193,10 +167,6 @@ public class SQLiteDocumentosDAO implements DocumentosDAO {
return total;
}
/**
* Inserta en la base de datos una instancia de Documentos nuevo
* @param documentos Documentos a insertar, una vez que ocurra se le otorgara un id
*/
@Override
public void insert(Documentos documentos) {
log.debug("Se intentara insertar un nuevo documentos " + documentos);
@@ -223,12 +193,6 @@ public class SQLiteDocumentosDAO implements DocumentosDAO {
log.debug("Se inserto el documentos " + documentos);
}
/**
* Inserta un documentos por default, teniendo los campos cheques, tarjetas y retiros
* siendo 0.
* @param documentos Instancia de documentos la cual se guardara con esas caracteristicas
* Solo se tomara el objecto caja para obtener el id de esta y asociarlo en la base de datos
*/
@Override
public void insertDefault(Documentos documentos) {
log.debug("Se intentara insertar el documento default " + documentos);
@@ -250,10 +214,6 @@ public class SQLiteDocumentosDAO implements DocumentosDAO {
log.debug("Se inserto el documento por default " + documentos);
}
/**
* Actualiza un Documentos existente en la base de datos
* @param documentos el documentos a actualizar
*/
@Override
public void update(Documentos documentos) {
log.debug("Se intentara actualizar el documentos " + documentos);
@@ -273,10 +233,6 @@ public class SQLiteDocumentosDAO implements DocumentosDAO {
log.debug("Se actualizo el documentos " + documentos);
}
/**
* Elimina un Documentos existente en la base de datos
* @param documentos El documentos a eliminar
*/
@Override
public void delete(Documentos documentos) {
log.debug("Se intentara eliminar el documentos " + documentos);