GenericDaoHibernate.java
6.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
package com.myproject.dao.hibernate;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.analysis.standard.StandardAnalyzer;
import org.apache.lucene.queryParser.ParseException;
import org.apache.lucene.util.Version;
import com.myproject.dao.GenericDao;
import com.myproject.dao.SearchException;
import org.hibernate.*;
import org.hibernate.search.FullTextSession;
import org.hibernate.search.Search;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Required;
import org.springframework.orm.ObjectRetrievalFailureException;
import javax.annotation.Resource;
import java.io.Serializable;
import java.util.*;
/**
* This class serves as the Base class for all other DAOs - namely to hold
* common CRUD methods that they might all use. You should only need to extend
* this class when your require custom CRUD logic.
* <p/>
* <p>To register this class in your Spring context file, use the following XML.
* <pre>
* <bean id="fooDao" class="com.myproject.dao.hibernate.GenericDaoHibernate">
* <constructor-arg value="com.myproject.model.Foo"/>
* </bean>
* </pre>
*
* @param <T> a type variable
* @param <PK> the primary key for that type
* @author <a href="mailto:bwnoll@gmail.com">Bryan Noll</a>
* Updated by jgarcia: update hibernate3 to hibernate4
* @author jgarcia (update: added full text search + reindexing)
*/
public class GenericDaoHibernate<T, PK extends Serializable> implements GenericDao<T, PK> {
/**
* Log variable for all child classes. Uses LogFactory.getLog(getClass()) from Commons Logging
*/
protected final Log log = LogFactory.getLog(getClass());
private Class<T> persistentClass;
@Resource
private SessionFactory sessionFactory;
private Analyzer defaultAnalyzer;
/**
* Constructor that takes in a class to see which type of entity to persist.
* Use this constructor when subclassing.
*
* @param persistentClass the class type you'd like to persist
*/
public GenericDaoHibernate(final Class<T> persistentClass) {
this.persistentClass = persistentClass;
defaultAnalyzer = new StandardAnalyzer(Version.LUCENE_36);
}
/**
* Constructor that takes in a class and sessionFactory for easy creation of DAO.
*
* @param persistentClass the class type you'd like to persist
* @param sessionFactory the pre-configured Hibernate SessionFactory
*/
public GenericDaoHibernate(final Class<T> persistentClass, SessionFactory sessionFactory) {
this.persistentClass = persistentClass;
this.sessionFactory = sessionFactory;
defaultAnalyzer = new StandardAnalyzer(Version.LUCENE_36);
}
public SessionFactory getSessionFactory() {
return this.sessionFactory;
}
public Session getSession() throws HibernateException {
Session sess = getSessionFactory().getCurrentSession();
if (sess == null) {
sess = getSessionFactory().openSession();
}
return sess;
}
@Autowired
@Required
public void setSessionFactory(SessionFactory sessionFactory) {
this.sessionFactory = sessionFactory;
}
/**
* {@inheritDoc}
*/
@SuppressWarnings("unchecked")
public List<T> getAll() {
Session sess = getSession();
return sess.createCriteria(persistentClass).list();
}
/**
* {@inheritDoc}
*/
@SuppressWarnings("unchecked")
public List<T> getAllDistinct() {
Collection<T> result = new LinkedHashSet<T>(getAll());
return new ArrayList<T>(result);
}
/**
* {@inheritDoc}
*/
public List<T> search(String searchTerm) throws SearchException {
Session sess = getSession();
FullTextSession txtSession = Search.getFullTextSession(sess);
org.apache.lucene.search.Query qry;
try {
qry = HibernateSearchTools.generateQuery(searchTerm, this.persistentClass, sess, defaultAnalyzer);
} catch (ParseException ex) {
throw new SearchException(ex);
}
org.hibernate.search.FullTextQuery hibQuery = txtSession.createFullTextQuery(qry,
this.persistentClass);
return hibQuery.list();
}
/**
* {@inheritDoc}
*/
@SuppressWarnings("unchecked")
public T get(PK id) {
Session sess = getSession();
IdentifierLoadAccess byId = sess.byId(persistentClass);
T entity = (T) byId.load(id);
if (entity == null) {
log.warn("Uh oh, '" + this.persistentClass + "' object with id '" + id + "' not found...");
throw new ObjectRetrievalFailureException(this.persistentClass, id);
}
return entity;
}
/**
* {@inheritDoc}
*/
@SuppressWarnings("unchecked")
public boolean exists(PK id) {
Session sess = getSession();
IdentifierLoadAccess byId = sess.byId(persistentClass);
T entity = (T) byId.load(id);
return entity != null;
}
/**
* {@inheritDoc}
*/
@SuppressWarnings("unchecked")
public T save(T object) {
Session sess = getSession();
return (T) sess.merge(object);
}
/**
* {@inheritDoc}
*/
public void remove(T object) {
Session sess = getSession();
sess.delete(object);
}
/**
* {@inheritDoc}
*/
public void remove(PK id) {
Session sess = getSession();
IdentifierLoadAccess byId = sess.byId(persistentClass);
T entity = (T) byId.load(id);
sess.delete(entity);
}
/**
* {@inheritDoc}
*/
@SuppressWarnings("unchecked")
public List<T> findByNamedQuery(String queryName, Map<String, Object> queryParams) {
Session sess = getSession();
Query namedQuery = sess.getNamedQuery(queryName);
for (String s : queryParams.keySet()) {
Object val = queryParams.get(s);
if (val instanceof Collection) {
namedQuery.setParameterList(s, (Collection) val);
} else {
namedQuery.setParameter(s, val);
}
}
return namedQuery.list();
}
/**
* {@inheritDoc}
*/
public void reindex() {
HibernateSearchTools.reindex(persistentClass, getSessionFactory().getCurrentSession());
}
/**
* {@inheritDoc}
*/
public void reindexAll(boolean async) {
HibernateSearchTools.reindexAll(async, getSessionFactory().getCurrentSession());
}
}