1.1 --- a/src/main/java/de/uapcore/lightpit/dao/ChildEntityDao.java Fri Nov 06 10:50:32 2020 +0100
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,116 +0,0 @@
1.4 -/*
1.5 - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.6 - *
1.7 - * Copyright 2018 Mike Becker. All rights reserved.
1.8 - *
1.9 - * Redistribution and use in source and binary forms, with or without
1.10 - * modification, are permitted provided that the following conditions are met:
1.11 - *
1.12 - * 1. Redistributions of source code must retain the above copyright
1.13 - * notice, this list of conditions and the following disclaimer.
1.14 - *
1.15 - * 2. Redistributions in binary form must reproduce the above copyright
1.16 - * notice, this list of conditions and the following disclaimer in the
1.17 - * documentation and/or other materials provided with the distribution.
1.18 - *
1.19 - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1.20 - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1.21 - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1.22 - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
1.23 - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
1.24 - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
1.25 - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
1.26 - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
1.27 - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
1.28 - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1.29 - * POSSIBILITY OF SUCH DAMAGE.
1.30 - *
1.31 - */
1.32 -package de.uapcore.lightpit.dao;
1.33 -
1.34 -import java.sql.SQLException;
1.35 -import java.util.List;
1.36 -
1.37 -public interface ChildEntityDao<T, P> {
1.38 -
1.39 - /**
1.40 - * Lists all entities being a child of the specified parent.
1.41 - * @param parent the parent
1.42 - * @return the list of child instances
1.43 - * @throws SQLException on any kind of SQL errors
1.44 - */
1.45 - List<T> list(P parent) throws SQLException;
1.46 -
1.47 - /**
1.48 - * Finds an entity by its integer ID.
1.49 - * It is not guaranteed that referenced entities are automatically joined.
1.50 - *
1.51 - * @param id the id
1.52 - * @return the enity or null if there is no such entity
1.53 - * @throws SQLException on any kind of SQL errors
1.54 - */
1.55 - T find(int id) throws SQLException;
1.56 -
1.57 - /**
1.58 - * Inserts an instance into database.
1.59 - * It is not guaranteed that generated fields will be updated in the instance.
1.60 - *
1.61 - * @param instance the instance to insert
1.62 - * @param parent a reference to the parent
1.63 - * @throws SQLException on any kind of SQL errors
1.64 - */
1.65 - void save(T instance, P parent) throws SQLException;
1.66 -
1.67 - /**
1.68 - * Updates an instance in the database.
1.69 - *
1.70 - * @param instance the instance to insert
1.71 - * @return true if an instance has been updated, false if no instance with the specified ID was found
1.72 - * @throws SQLException on any kind of SQL errors
1.73 - */
1.74 - boolean update(T instance) throws SQLException;
1.75 -
1.76 - /**
1.77 - * Updates an instance in the database changing the parent.
1.78 - * This operation is not supported by default.
1.79 - *
1.80 - * @param instance the instance to insert
1.81 - * @param newParent a reference to the new parent
1.82 - * @return true if an instance has been updated, false if no instance with the specified ID was found
1.83 - * @throws SQLException on any kind of SQL errors
1.84 - * @see #isChangingParentSupported()
1.85 - */
1.86 - default boolean update(T instance, P newParent) throws SQLException {
1.87 - throw new UnsupportedOperationException();
1.88 - }
1.89 -
1.90 - /**
1.91 - * Returns true if changing the parent is supported by this DAO.
1.92 - * This method must return true, if {@link #update(Object, Object)} is implemented.
1.93 - * @return true, if changing the parent is supported
1.94 - */
1.95 - default boolean isChangingParentSupported() {
1.96 - return false;
1.97 - }
1.98 -
1.99 - /**
1.100 - * Inserts or updates an instance in the database.
1.101 - * Tries an update first and if that fails, performs a save.
1.102 - * If changing a parent is not supported by this DAO,
1.103 - * specifying an alternate parent for an existing instance has no effect.
1.104 - *
1.105 - * @param instance the instance to insert or update
1.106 - * @param parent a reference to the parent
1.107 - * @throws SQLException on any kind of SQL errors
1.108 - * @see #update(Object)
1.109 - * @see #update(Object, Object)
1.110 - * @see #save(Object, Object)
1.111 - */
1.112 - default void saveOrUpdate(T instance, P parent) throws SQLException {
1.113 - if (isChangingParentSupported()) {
1.114 - if (!update(instance, parent)) save(instance, parent);
1.115 - } else {
1.116 - if (!update(instance)) save(instance, parent);
1.117 - }
1.118 - }
1.119 -}
