Revision f905a388
Added by Andreas Müller over 1 year ago
cdmlib-io/src/main/java/eu/etaxonomy/cdm/io/common/mapping/DbImportDefinedTermCreationMapperBase.java | ||
---|---|---|
1 |
/** |
|
2 |
* Copyright (C) 2007 EDIT |
|
3 |
* European Distributed Institute of Taxonomy |
|
4 |
* http://www.e-taxonomy.eu |
|
5 |
* |
|
6 |
* The contents of this file are subject to the Mozilla Public License Version 1.1 |
|
7 |
* See LICENSE.TXT at the top of this package for the full license terms. |
|
8 |
*/ |
|
9 |
|
|
10 |
package eu.etaxonomy.cdm.io.common.mapping; |
|
11 |
|
|
12 |
import java.sql.ResultSet; |
|
13 |
import java.sql.SQLException; |
|
14 |
import java.util.UUID; |
|
15 |
|
|
16 |
import org.apache.logging.log4j.LogManager;import org.apache.logging.log4j.Logger; |
|
17 |
|
|
18 |
import eu.etaxonomy.cdm.io.common.DbImportStateBase; |
|
19 |
import eu.etaxonomy.cdm.model.common.VersionableEntity; |
|
20 |
import eu.etaxonomy.cdm.model.reference.Reference; |
|
21 |
import eu.etaxonomy.cdm.model.term.DefinedTermBase; |
|
22 |
|
|
23 |
/** |
|
24 |
* This class either retrieves a defined Term from the database or creates and saves it in the database. |
|
25 |
* This is done by first checking the according transformer for term attributes map to an existing |
|
26 |
* CDM term (term that is available by static methods in the term classes), if not it tries to retrieve |
|
27 |
* it via its uuid available through the transformer, if not retrievable it tries to retrieve from the |
|
28 |
* database via the original source, if not retrievable it creates the new and stores it in the database.<BR> |
|
29 |
* Subclasses may decide if they implement a function to use the term immediately via |
|
30 |
* {@link #handleTermWithObject(VersionableEntity, DefinedTermBase)} |
|
31 |
* |
|
32 |
* @author a.mueller |
|
33 |
* @since 12.05.2009 |
|
34 |
* @param <TERM>The class of the term to be created or retrieved. |
|
35 |
* @param <TERMED>The class of the object the term is added to. |
|
36 |
* @param <STATE>The class of the import state that is available during import. |
|
37 |
*/ |
|
38 |
public abstract class DbImportDefinedTermCreationMapperBase<TERM extends DefinedTermBase, TERMED extends VersionableEntity, STATE extends DbImportStateBase<?,?>> |
|
39 |
extends DbImportObjectCreationMapperBase<TERMED, STATE> { |
|
40 |
|
|
41 |
private static final Logger logger = LogManager.getLogger(DbImportDefinedTermCreationMapperBase.class); |
|
42 |
|
|
43 |
//******************************* ATTRIBUTES ***************************************/ |
|
44 |
protected String dbTermAttribute; |
|
45 |
protected String dbLabelAttribute; |
|
46 |
protected String dbLabelAbbrevAttribute; |
|
47 |
|
|
48 |
//********************************* CONSTRUCTOR ****************************************/ |
|
49 |
/** |
|
50 |
* @param mappingImport |
|
51 |
*/ |
|
52 |
protected DbImportDefinedTermCreationMapperBase(String dbIdAttribute, String termNamespace, String dbTermAttribute, String dbLabelAttribute, String dbLabelAbbrevAttribute) { |
|
53 |
super(dbIdAttribute, termNamespace); |
|
54 |
this.dbTermAttribute = dbTermAttribute; |
|
55 |
this.dbLabelAttribute = dbLabelAttribute; |
|
56 |
this.dbLabelAbbrevAttribute = dbLabelAbbrevAttribute; |
|
57 |
} |
|
58 |
|
|
59 |
//************************************ METHODS *******************************************/ |
|
60 |
|
|
61 |
@Override |
|
62 |
public TERMED invoke(ResultSet rs, TERMED noObject) throws SQLException { |
|
63 |
String key = getKeyString(rs); |
|
64 |
if (key != null){ |
|
65 |
TERM definedTerm = getDefinedTermIfExist(rs); |
|
66 |
if (definedTerm == null){ |
|
67 |
definedTerm = createDefinedTerm(rs); |
|
68 |
Reference citation = null; |
|
69 |
getState().getCurrentIO().addOriginalSource(rs, definedTerm, dbIdAttribute, objectToCreateNamespace, citation); |
|
70 |
|
|
71 |
UUID transformerUuid = getUuidFromTransformer(rs); |
|
72 |
if (transformerUuid != null){ |
|
73 |
definedTerm.setUuid(transformerUuid); |
|
74 |
} |
|
75 |
getState().getCurrentIO().getTermService().save(definedTerm); |
|
76 |
saveTermToState(definedTerm); |
|
77 |
if (transformerUuid == null){ |
|
78 |
getState().addRelatedObject(objectToCreateNamespace, getKeyString(rs), definedTerm); |
|
79 |
} |
|
80 |
} |
|
81 |
handleTermWithObject(noObject, definedTerm); |
|
82 |
} |
|
83 |
return noObject; |
|
84 |
} |
|
85 |
|
|
86 |
private void makeUuid(ResultSet rs, TERM definedTerm) throws SQLException { |
|
87 |
UUID uuid = getUuidFromTransformer(rs); |
|
88 |
if (uuid != null){ |
|
89 |
definedTerm.setUuid(uuid); |
|
90 |
} |
|
91 |
} |
|
92 |
|
|
93 |
protected abstract TERM createDefinedTerm(ResultSet rs) throws SQLException; |
|
94 |
|
|
95 |
protected abstract void handleTermWithObject(TERMED termed, TERM term); |
|
96 |
|
|
97 |
/** |
|
98 |
* Returns the term if it is available via the transformer, or via the state (uuidMap or relatedObject) |
|
99 |
*/ |
|
100 |
private TERM getDefinedTermIfExist(ResultSet rs) throws SQLException { |
|
101 |
//get object from transformer, return if not null |
|
102 |
TERM definedTerm = getTermFromTransformer(rs); |
|
103 |
if (definedTerm == null){ |
|
104 |
//if null get uuid from transformer |
|
105 |
UUID uuidTerm = getUuidFromTransformer(rs); |
|
106 |
if (uuidTerm != null){ |
|
107 |
definedTerm = getTermByUuid(uuidTerm, rs); |
|
108 |
}else{ |
|
109 |
definedTerm = getTermByIdentifier(rs); |
|
110 |
} |
|
111 |
} |
|
112 |
return definedTerm; |
|
113 |
} |
|
114 |
|
|
115 |
protected TERM getTermByIdentifier(ResultSet rs) throws SQLException { |
|
116 |
//get object from stat.featur map |
|
117 |
String key = getKeyString(rs); |
|
118 |
if (key == null){ |
|
119 |
return null; |
|
120 |
} |
|
121 |
TERM term = (TERM)getState().getRelatedObject(objectToCreateNamespace, key); |
|
122 |
return term; |
|
123 |
} |
|
124 |
|
|
125 |
protected TERM getTermByUuid(UUID uuidTerm, ResultSet rs) throws SQLException{ |
|
126 |
TERM term = getTermFromState(uuidTerm); |
|
127 |
if (term == null){ |
|
128 |
term = (TERM)getState().getCurrentIO().getTermService().find(uuidTerm); |
|
129 |
if (term != null){ |
|
130 |
saveTermToState(term); |
|
131 |
} |
|
132 |
} |
|
133 |
return term; |
|
134 |
} |
|
135 |
|
|
136 |
/** |
|
137 |
* Saves the defined term to the state |
|
138 |
*/ |
|
139 |
protected abstract void saveTermToState(TERM term); |
|
140 |
|
|
141 |
protected abstract TERM getTermFromState(UUID uuid); |
|
142 |
|
|
143 |
protected UUID getUuidFromTransformer(ResultSet rs) throws SQLException{ |
|
144 |
IInputTransformer transformer = getTransformer(); |
|
145 |
String key = getKeyString(rs); |
|
146 |
UUID uuid; |
|
147 |
try { |
|
148 |
uuid = getUuidFromTransformer(key, transformer); |
|
149 |
} catch (UndefinedTransformerMethodException e) { |
|
150 |
logger.warn(e.getMessage()); |
|
151 |
return null; |
|
152 |
} |
|
153 |
return uuid; |
|
154 |
} |
|
155 |
|
|
156 |
protected abstract UUID getUuidFromTransformer(String key, IInputTransformer transformer) throws UndefinedTransformerMethodException; |
|
157 |
|
|
158 |
protected TERM getTermFromTransformer(ResultSet rs) throws SQLException{ |
|
159 |
IInputTransformer transformer = getTransformer(); |
|
160 |
String key = getKeyString(rs); |
|
161 |
TERM term; |
|
162 |
try { |
|
163 |
term = getTermFromTransformer(key, transformer); |
|
164 |
} catch (UndefinedTransformerMethodException e) { |
|
165 |
logger.warn(e.getMessage()); |
|
166 |
return null; |
|
167 |
} |
|
168 |
return term; |
|
169 |
} |
|
170 |
|
|
171 |
protected abstract TERM getTermFromTransformer(String key, IInputTransformer transformer) throws UndefinedTransformerMethodException; |
|
172 |
|
|
173 |
protected String getKeyString(ResultSet rs) throws SQLException { |
|
174 |
Object oKey = rs.getString(dbIdAttribute); |
|
175 |
if (oKey == null){ |
|
176 |
return null; |
|
177 |
} |
|
178 |
String key = String.valueOf(oKey); |
|
179 |
key = key.trim(); |
|
180 |
return key; |
|
181 |
} |
|
182 |
|
|
183 |
@Override |
|
184 |
protected TERMED doInvoke(ResultSet rs, TERMED createdObject) |
|
185 |
throws SQLException { |
|
186 |
return createdObject; //not needed because invoke is implemented separately |
|
187 |
} |
|
188 |
|
|
189 |
@Override |
|
190 |
protected TERMED createObject(ResultSet rs) throws SQLException { |
|
191 |
logger.warn("Never should read this"); |
|
192 |
return null; //not needed, object is created in createDefineTerm(rs) |
|
193 |
} |
|
194 |
} |
|
1 |
/** |
|
2 |
* Copyright (C) 2007 EDIT |
|
3 |
* European Distributed Institute of Taxonomy |
|
4 |
* http://www.e-taxonomy.eu |
|
5 |
* |
|
6 |
* The contents of this file are subject to the Mozilla Public License Version 1.1 |
|
7 |
* See LICENSE.TXT at the top of this package for the full license terms. |
|
8 |
*/ |
|
9 |
|
|
10 |
package eu.etaxonomy.cdm.io.common.mapping; |
|
11 |
|
|
12 |
import java.sql.ResultSet; |
|
13 |
import java.sql.SQLException; |
|
14 |
import java.util.UUID; |
|
15 |
|
|
16 |
import org.apache.logging.log4j.LogManager; |
|
17 |
import org.apache.logging.log4j.Logger; |
|
18 |
|
|
19 |
import eu.etaxonomy.cdm.io.common.DbImportStateBase; |
|
20 |
import eu.etaxonomy.cdm.model.common.VersionableEntity; |
|
21 |
import eu.etaxonomy.cdm.model.reference.Reference; |
|
22 |
import eu.etaxonomy.cdm.model.term.DefinedTermBase; |
|
23 |
|
|
24 |
/** |
|
25 |
* This class either retrieves a defined Term from the database or creates and saves it in the database. |
|
26 |
* This is done by first checking the according transformer for term attributes map to an existing |
|
27 |
* CDM term (term that is available by static methods in the term classes), if not it tries to retrieve |
|
28 |
* it via its uuid available through the transformer, if not retrievable it tries to retrieve from the |
|
29 |
* database via the original source, if not retrievable it creates the new and stores it in the database.<BR> |
|
30 |
* Subclasses may decide if they implement a function to use the term immediately via |
|
31 |
* {@link #handleTermWithObject(VersionableEntity, DefinedTermBase)} |
|
32 |
* |
|
33 |
* @author a.mueller |
|
34 |
* @since 12.05.2009 |
|
35 |
* @param <TERM>The class of the term to be created or retrieved. |
|
36 |
* @param <TERMED>The class of the object the term is added to. |
|
37 |
* @param <STATE>The class of the import state that is available during import. |
|
38 |
*/ |
|
39 |
public abstract class DbImportDefinedTermCreationMapperBase<TERM extends DefinedTermBase, TERMED extends VersionableEntity, STATE extends DbImportStateBase<?,?>> |
|
40 |
extends DbImportObjectCreationMapperBase<TERMED, STATE> { |
|
41 |
|
|
42 |
private static final Logger logger = LogManager.getLogger(); |
|
43 |
|
|
44 |
//******************************* ATTRIBUTES ***************************************/ |
|
45 |
protected String dbTermAttribute; |
|
46 |
protected String dbLabelAttribute; |
|
47 |
protected String dbLabelAbbrevAttribute; |
|
48 |
|
|
49 |
//********************************* CONSTRUCTOR ****************************************/ |
|
50 |
/** |
|
51 |
* @param mappingImport |
|
52 |
*/ |
|
53 |
protected DbImportDefinedTermCreationMapperBase(String dbIdAttribute, String termNamespace, String dbTermAttribute, String dbLabelAttribute, String dbLabelAbbrevAttribute) { |
|
54 |
super(dbIdAttribute, termNamespace); |
|
55 |
this.dbTermAttribute = dbTermAttribute; |
|
56 |
this.dbLabelAttribute = dbLabelAttribute; |
|
57 |
this.dbLabelAbbrevAttribute = dbLabelAbbrevAttribute; |
|
58 |
} |
|
59 |
|
|
60 |
//************************************ METHODS *******************************************/ |
|
61 |
|
|
62 |
@Override |
|
63 |
public TERMED invoke(ResultSet rs, TERMED noObject) throws SQLException { |
|
64 |
String key = getKeyString(rs); |
|
65 |
if (key != null){ |
|
66 |
TERM definedTerm = getDefinedTermIfExist(rs); |
|
67 |
if (definedTerm == null){ |
|
68 |
definedTerm = createDefinedTerm(rs); |
|
69 |
Reference citation = null; |
|
70 |
getState().getCurrentIO().addOriginalSource(rs, definedTerm, dbIdAttribute, objectToCreateNamespace, citation); |
|
71 |
|
|
72 |
UUID transformerUuid = getUuidFromTransformer(rs); |
|
73 |
if (transformerUuid != null){ |
|
74 |
definedTerm.setUuid(transformerUuid); |
|
75 |
} |
|
76 |
getState().getCurrentIO().getTermService().save(definedTerm); |
|
77 |
saveTermToState(definedTerm); |
|
78 |
if (transformerUuid == null){ |
|
79 |
getState().addRelatedObject(objectToCreateNamespace, getKeyString(rs), definedTerm); |
|
80 |
} |
|
81 |
} |
|
82 |
handleTermWithObject(noObject, definedTerm); |
|
83 |
} |
|
84 |
return noObject; |
|
85 |
} |
|
86 |
|
|
87 |
private void makeUuid(ResultSet rs, TERM definedTerm) throws SQLException { |
|
88 |
UUID uuid = getUuidFromTransformer(rs); |
|
89 |
if (uuid != null){ |
|
90 |
definedTerm.setUuid(uuid); |
|
91 |
} |
|
92 |
} |
|
93 |
|
|
94 |
protected abstract TERM createDefinedTerm(ResultSet rs) throws SQLException; |
|
95 |
|
|
96 |
protected abstract void handleTermWithObject(TERMED termed, TERM term); |
|
97 |
|
|
98 |
/** |
|
99 |
* Returns the term if it is available via the transformer, or via the state (uuidMap or relatedObject) |
|
100 |
*/ |
|
101 |
private TERM getDefinedTermIfExist(ResultSet rs) throws SQLException { |
|
102 |
//get object from transformer, return if not null |
|
103 |
TERM definedTerm = getTermFromTransformer(rs); |
|
104 |
if (definedTerm == null){ |
|
105 |
//if null get uuid from transformer |
|
106 |
UUID uuidTerm = getUuidFromTransformer(rs); |
|
107 |
if (uuidTerm != null){ |
|
108 |
definedTerm = getTermByUuid(uuidTerm, rs); |
|
109 |
}else{ |
|
110 |
definedTerm = getTermByIdentifier(rs); |
|
111 |
} |
|
112 |
} |
|
113 |
return definedTerm; |
|
114 |
} |
|
115 |
|
|
116 |
protected TERM getTermByIdentifier(ResultSet rs) throws SQLException { |
|
117 |
//get object from stat.featur map |
|
118 |
String key = getKeyString(rs); |
|
119 |
if (key == null){ |
|
120 |
return null; |
|
121 |
} |
|
122 |
TERM term = (TERM)getState().getRelatedObject(objectToCreateNamespace, key); |
|
123 |
return term; |
|
124 |
} |
|
125 |
|
|
126 |
protected TERM getTermByUuid(UUID uuidTerm, ResultSet rs) throws SQLException{ |
|
127 |
TERM term = getTermFromState(uuidTerm); |
|
128 |
if (term == null){ |
|
129 |
term = (TERM)getState().getCurrentIO().getTermService().find(uuidTerm); |
|
130 |
if (term != null){ |
|
131 |
saveTermToState(term); |
|
132 |
} |
|
133 |
} |
|
134 |
return term; |
|
135 |
} |
|
136 |
|
|
137 |
/** |
|
138 |
* Saves the defined term to the state |
|
139 |
*/ |
|
140 |
protected abstract void saveTermToState(TERM term); |
|
141 |
|
|
142 |
protected abstract TERM getTermFromState(UUID uuid); |
|
143 |
|
|
144 |
protected UUID getUuidFromTransformer(ResultSet rs) throws SQLException{ |
|
145 |
IInputTransformer transformer = getTransformer(); |
|
146 |
String key = getKeyString(rs); |
|
147 |
UUID uuid; |
|
148 |
try { |
|
149 |
uuid = getUuidFromTransformer(key, transformer); |
|
150 |
} catch (UndefinedTransformerMethodException e) { |
|
151 |
logger.warn(e.getMessage()); |
|
152 |
return null; |
|
153 |
} |
|
154 |
return uuid; |
|
155 |
} |
|
156 |
|
|
157 |
protected abstract UUID getUuidFromTransformer(String key, IInputTransformer transformer) throws UndefinedTransformerMethodException; |
|
158 |
|
|
159 |
protected TERM getTermFromTransformer(ResultSet rs) throws SQLException{ |
|
160 |
IInputTransformer transformer = getTransformer(); |
|
161 |
String key = getKeyString(rs); |
|
162 |
TERM term; |
|
163 |
try { |
|
164 |
term = getTermFromTransformer(key, transformer); |
|
165 |
} catch (UndefinedTransformerMethodException e) { |
|
166 |
logger.warn(e.getMessage()); |
|
167 |
return null; |
|
168 |
} |
|
169 |
return term; |
|
170 |
} |
|
171 |
|
|
172 |
protected abstract TERM getTermFromTransformer(String key, IInputTransformer transformer) throws UndefinedTransformerMethodException; |
|
173 |
|
|
174 |
protected String getKeyString(ResultSet rs) throws SQLException { |
|
175 |
Object oKey = rs.getString(dbIdAttribute); |
|
176 |
if (oKey == null){ |
|
177 |
return null; |
|
178 |
} |
|
179 |
String key = String.valueOf(oKey); |
|
180 |
key = key.trim(); |
|
181 |
return key; |
|
182 |
} |
|
183 |
|
|
184 |
@Override |
|
185 |
protected TERMED doInvoke(ResultSet rs, TERMED createdObject) |
|
186 |
throws SQLException { |
|
187 |
return createdObject; //not needed because invoke is implemented separately |
|
188 |
} |
|
189 |
|
|
190 |
@Override |
|
191 |
protected TERMED createObject(ResultSet rs) throws SQLException { |
|
192 |
logger.warn("Never should read this"); |
|
193 |
return null; //not needed, object is created in createDefineTerm(rs) |
|
194 |
} |
|
195 |
} |
Also available in: Unified diff
cleanup