Fri, 23 Oct 2020 18:40:50 +0200
migrate WebColor
34
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
1 | /* |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
3 | * |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
4 | * Copyright 2018 Mike Becker. All rights reserved. |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
5 | * |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
6 | * Redistribution and use in source and binary forms, with or without |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
7 | * modification, are permitted provided that the following conditions are met: |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
8 | * |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
9 | * 1. Redistributions of source code must retain the above copyright |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
10 | * notice, this list of conditions and the following disclaimer. |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
11 | * |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
12 | * 2. Redistributions in binary form must reproduce the above copyright |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
13 | * notice, this list of conditions and the following disclaimer in the |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
14 | * documentation and/or other materials provided with the distribution. |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
15 | * |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
26 | * POSSIBILITY OF SUCH DAMAGE. |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
27 | * |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
28 | */ |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
29 | package de.uapcore.lightpit.dao; |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
30 | |
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
31 | import java.sql.SQLException; |
128
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
32 | import java.util.List; |
34
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
33 | |
128
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
34 | public interface ChildEntityDao<T, P> { |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
35 | |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
36 | /** |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
37 | * Lists all entities being a child of the specified parent. |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
38 | * @param parent the parent |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
39 | * @return the list of child instances |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
40 | * @throws SQLException on any kind of SQL errors |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
41 | */ |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
42 | List<T> list(P parent) throws SQLException; |
38
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
43 | |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
44 | /** |
47
57cfb94ab99f
projects can now be added and updated
Mike Becker <universe@uap-core.de>
parents:
38
diff
changeset
|
45 | * Finds an entity by its integer ID. |
75
33b6843fdf8a
adds the ability to create and edit issues
Mike Becker <universe@uap-core.de>
parents:
62
diff
changeset
|
46 | * It is not guaranteed that referenced entities are automatically joined. |
47
57cfb94ab99f
projects can now be added and updated
Mike Becker <universe@uap-core.de>
parents:
38
diff
changeset
|
47 | * |
57cfb94ab99f
projects can now be added and updated
Mike Becker <universe@uap-core.de>
parents:
38
diff
changeset
|
48 | * @param id the id |
57cfb94ab99f
projects can now be added and updated
Mike Becker <universe@uap-core.de>
parents:
38
diff
changeset
|
49 | * @return the enity or null if there is no such entity |
57cfb94ab99f
projects can now be added and updated
Mike Becker <universe@uap-core.de>
parents:
38
diff
changeset
|
50 | * @throws SQLException on any kind of SQL errors |
57cfb94ab99f
projects can now be added and updated
Mike Becker <universe@uap-core.de>
parents:
38
diff
changeset
|
51 | */ |
57cfb94ab99f
projects can now be added and updated
Mike Becker <universe@uap-core.de>
parents:
38
diff
changeset
|
52 | T find(int id) throws SQLException; |
57cfb94ab99f
projects can now be added and updated
Mike Becker <universe@uap-core.de>
parents:
38
diff
changeset
|
53 | |
57cfb94ab99f
projects can now be added and updated
Mike Becker <universe@uap-core.de>
parents:
38
diff
changeset
|
54 | /** |
38
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
55 | * Inserts an instance into database. |
75
33b6843fdf8a
adds the ability to create and edit issues
Mike Becker <universe@uap-core.de>
parents:
62
diff
changeset
|
56 | * It is not guaranteed that generated fields will be updated in the instance. |
38
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
57 | * |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
58 | * @param instance the instance to insert |
128
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
59 | * @param parent a reference to the parent |
38
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
60 | * @throws SQLException on any kind of SQL errors |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
61 | */ |
128
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
62 | void save(T instance, P parent) throws SQLException; |
38
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
63 | |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
64 | /** |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
65 | * Updates an instance in the database. |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
66 | * |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
67 | * @param instance the instance to insert |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
68 | * @return true if an instance has been updated, false if no instance with the specified ID was found |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
69 | * @throws SQLException on any kind of SQL errors |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
70 | */ |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
71 | boolean update(T instance) throws SQLException; |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
72 | |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
73 | /** |
128
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
74 | * Updates an instance in the database changing the parent. |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
75 | * This operation is not supported by default. |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
76 | * |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
77 | * @param instance the instance to insert |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
78 | * @param newParent a reference to the new parent |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
79 | * @return true if an instance has been updated, false if no instance with the specified ID was found |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
80 | * @throws SQLException on any kind of SQL errors |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
81 | * @see #isChangingParentSupported() |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
82 | */ |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
83 | default boolean update(T instance, P newParent) throws SQLException { |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
84 | throw new UnsupportedOperationException(); |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
85 | } |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
86 | |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
87 | /** |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
88 | * Returns true if changing the parent is supported by this DAO. |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
89 | * This method must return true, if {@link #update(Object, Object)} is implemented. |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
90 | * @return true, if changing the parent is supported |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
91 | */ |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
92 | default boolean isChangingParentSupported() { |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
93 | return false; |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
94 | } |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
95 | |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
96 | /** |
38
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
97 | * Inserts or updates an instance in the database. |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
98 | * Tries an update first and if that fails, performs a save. |
128
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
99 | * If changing a parent is not supported by this DAO, |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
100 | * specifying an alternate parent for an existing instance has no effect. |
38
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
101 | * |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
102 | * @param instance the instance to insert or update |
128
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
103 | * @param parent a reference to the parent |
38
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
104 | * @throws SQLException on any kind of SQL errors |
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
105 | * @see #update(Object) |
128
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
106 | * @see #update(Object, Object) |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
107 | * @see #save(Object, Object) |
38
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
108 | */ |
128
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
109 | default void saveOrUpdate(T instance, P parent) throws SQLException { |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
110 | if (isChangingParentSupported()) { |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
111 | if (!update(instance, parent)) save(instance, parent); |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
112 | } else { |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
113 | if (!update(instance)) save(instance, parent); |
947d0f6a6a83
changes the way how to deal with child entities + adds component lead
Mike Becker <universe@uap-core.de>
parents:
75
diff
changeset
|
114 | } |
38
cf85ef18f231
adds DAO for Project entity and save/update methods
Mike Becker <universe@uap-core.de>
parents:
34
diff
changeset
|
115 | } |
34
824d4042c857
cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
116 | } |