Skip to content

Commit a2dba5b

Browse files
isabiqisabiq
committed
add logs, javadoc and format to checkstyle conventions
1 parent 40c00ca commit a2dba5b

11 files changed

Lines changed: 106 additions & 46 deletions

File tree

‎cqrs/src/main/java/com/iluwatar/cqrs/commandes/CommandServiceImpl.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88
import com.iluwatar.cqrs.domain.model.Book;
99
import com.iluwatar.cqrs.util.HibernateUtil;
1010

11+
/**
12+
* This class is implementation of {@link ICommandService} interface. It uses Hibernate as an api for persistence.
13+
*
14+
*/
1115
public class CommandServiceImpl implements ICommandService {
1216

1317
private SessionFactory sessionFactory = HibernateUtil.getSessionFactory();

‎cqrs/src/main/java/com/iluwatar/cqrs/commandes/ICommandService.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
package com.iluwatar.cqrs.commandes;
22

3+
/**
4+
* This interface represents the commands of the CQRS pattern
5+
*
6+
*/
37
public interface ICommandService {
48

59
public abstract void authorCreated(String username, String name, String email);

‎cqrs/src/main/java/com/iluwatar/cqrs/domain/model/Author.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66
import javax.persistence.Id;
77

88
/**
9-
*
10-
* @author Sabiq Ihab
9+
* This is an Author entity. It is used by Hibernate for persistence.
1110
*
1211
*/
1312
@Entity
@@ -22,8 +21,11 @@ public class Author {
2221
/**
2322
*
2423
* @param username
24+
* username of the author
2525
* @param name
26+
* name of the author
2627
* @param email
28+
* email of the author
2729
*/
2830
public Author(String username, String name, String email) {
2931
super();

‎cqrs/src/main/java/com/iluwatar/cqrs/domain/model/Book.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77
import javax.persistence.ManyToOne;
88

99
/**
10-
*
11-
* @author Sabiq Ihab
10+
* This is a Book entity. It is used by Hibernate for persistence. Many books can be written by one {@link Author}
1211
*
1312
*/
1413
@Entity
@@ -24,8 +23,11 @@ public class Book {
2423
/**
2524
*
2625
* @param title
26+
* title of the book
2727
* @param price
28+
* price of the book
2829
* @param author
30+
* author of the book
2931
*/
3032
public Book(String title, double price, Author author) {
3133
super();

cqrs/src/main/java/com/iluwatar/cqrs/dto/AuthorDTO.java renamed to cqrs/src/main/java/com/iluwatar/cqrs/dto/Author.java

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,33 @@
11
package com.iluwatar.cqrs.dto;
22

3-
public class AuthorDTO {
3+
/**
4+
*
5+
* This is a DTO (Data Transfer Object) author, contains only useful information to be returned
6+
*
7+
*/
8+
public class Author {
49

510
private String name;
611
private String email;
712
private String username;
813

9-
public AuthorDTO(String name, String email, String username) {
14+
/**
15+
*
16+
* @param name
17+
* name of the author
18+
* @param email
19+
* email of the author
20+
* @param username
21+
* username of the author
22+
*/
23+
public Author(String name, String email, String username) {
1024
super();
1125
this.name = name;
1226
this.email = email;
1327
this.username = username;
1428
}
1529

16-
public AuthorDTO() {
30+
public Author() {
1731
super();
1832
}
1933

cqrs/src/main/java/com/iluwatar/cqrs/dto/BookDTO.java renamed to cqrs/src/main/java/com/iluwatar/cqrs/dto/Book.java

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,29 @@
11
package com.iluwatar.cqrs.dto;
22

3-
public class BookDTO {
3+
/**
4+
*
5+
* This is a DTO (Data Transfer Object) book, contains only useful information to be returned
6+
*
7+
*/
8+
public class Book {
49

510
private String title;
611
private double price;
712

8-
public BookDTO(String title, double price) {
13+
/**
14+
*
15+
* @param title
16+
* title of the book
17+
* @param price
18+
* price of the book
19+
*/
20+
public Book(String title, double price) {
921
super();
1022
this.title = title;
1123
this.price = price;
1224
}
1325

14-
public BookDTO() {
26+
public Book() {
1527
super();
1628
}
1729

‎cqrs/src/main/java/com/iluwatar/cqrs/queries/IQueryService.java‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,21 @@
33
import java.math.BigInteger;
44
import java.util.List;
55

6-
import com.iluwatar.cqrs.dto.AuthorDTO;
7-
import com.iluwatar.cqrs.dto.BookDTO;
8-
6+
import com.iluwatar.cqrs.dto.Author;
7+
import com.iluwatar.cqrs.dto.Book;
8+
9+
/**
10+
*
11+
* This interface represents the query methods of the CQRS pattern
12+
*
13+
*/
914
public interface IQueryService {
1015

11-
public abstract AuthorDTO getAuthorByUsername(String username);
16+
public abstract Author getAuthorByUsername(String username);
1217

13-
public abstract BookDTO getBook(String title);
18+
public abstract Book getBook(String title);
1419

15-
public abstract List<BookDTO> getAuthorBooks(String username);
20+
public abstract List<Book> getAuthorBooks(String username);
1621

1722
public abstract BigInteger getAuthorBooksCount(String username);
1823

‎cqrs/src/main/java/com/iluwatar/cqrs/queries/QueryServiceImpl.java‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,51 @@
88
import org.hibernate.SessionFactory;
99
import org.hibernate.transform.Transformers;
1010

11-
import com.iluwatar.cqrs.dto.AuthorDTO;
12-
import com.iluwatar.cqrs.dto.BookDTO;
11+
import com.iluwatar.cqrs.dto.Author;
12+
import com.iluwatar.cqrs.dto.Book;
1313
import com.iluwatar.cqrs.util.HibernateUtil;
1414

15+
/**
16+
* This class is an implementation of {@link IQueryService}. It uses Hibernate native queries to return DTOs from the
17+
* database.
18+
*
19+
*/
1520
public class QueryServiceImpl implements IQueryService {
1621

1722
private SessionFactory sessionFactory = HibernateUtil.getSessionFactory();
1823

1924
@Override
20-
public AuthorDTO getAuthorByUsername(String username) {
25+
public Author getAuthorByUsername(String username) {
2126
Session session = sessionFactory.openSession();
2227
SQLQuery sqlQuery = session
2328
.createSQLQuery("SELECT a.username as \"username\", a.name as \"name\", a.email as \"email\""
2429
+ "FROM Author a where a.username=:username");
2530
sqlQuery.setParameter("username", username);
26-
AuthorDTO authorDTO = (AuthorDTO) sqlQuery.setResultTransformer(Transformers.aliasToBean(AuthorDTO.class))
27-
.uniqueResult();
31+
Author authorDTo = (Author) sqlQuery.setResultTransformer(Transformers.aliasToBean(Author.class)).uniqueResult();
2832
session.close();
29-
return authorDTO;
33+
return authorDTo;
3034
}
3135

3236
@Override
33-
public BookDTO getBook(String title) {
37+
public Book getBook(String title) {
3438
Session session = sessionFactory.openSession();
3539
SQLQuery sqlQuery = session
3640
.createSQLQuery("SELECT b.title as \"title\", b.price as \"price\"" + " FROM Book b where b.title=:title");
3741
sqlQuery.setParameter("title", title);
38-
BookDTO bookDTO = (BookDTO) sqlQuery.setResultTransformer(Transformers.aliasToBean(BookDTO.class)).uniqueResult();
42+
Book bookDTo = (Book) sqlQuery.setResultTransformer(Transformers.aliasToBean(Book.class)).uniqueResult();
3943
session.close();
40-
return bookDTO;
44+
return bookDTo;
4145
}
4246

4347
@Override
44-
public List<BookDTO> getAuthorBooks(String username) {
48+
public List<Book> getAuthorBooks(String username) {
4549
Session session = sessionFactory.openSession();
4650
SQLQuery sqlQuery = session.createSQLQuery("SELECT b.title as \"title\", b.price as \"price\""
4751
+ " FROM Author a , Book b where b.author_id = a.id and a.username=:username");
4852
sqlQuery.setParameter("username", username);
49-
List<BookDTO> bookDTOs = sqlQuery.setResultTransformer(Transformers.aliasToBean(BookDTO.class)).list();
53+
List<Book> bookDTos = sqlQuery.setResultTransformer(Transformers.aliasToBean(Book.class)).list();
5054
session.close();
51-
return bookDTOs;
55+
return bookDTos;
5256
}
5357

5458
@Override

‎cqrs/src/main/java/com/iluwatar/cqrs/util/HibernateUtil.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@
44
import org.hibernate.boot.MetadataSources;
55
import org.hibernate.boot.registry.StandardServiceRegistry;
66
import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
7+
import org.slf4j.Logger;
8+
import org.slf4j.LoggerFactory;
79

810
/**
9-
*
10-
* @author Sabiq Ihab
11+
* This class simply returns one instance of {@link SessionFactory} initialized when the application is started
1112
*
1213
*/
1314
public class HibernateUtil {
1415

1516
private static final SessionFactory SESSIONFACTORY = buildSessionFactory();
17+
private static final Logger LOGGER = LoggerFactory.getLogger(HibernateUtil.class);
1618

1719
private static SessionFactory buildSessionFactory() {
18-
// A SessionFactory is set up once for an application!
19-
final StandardServiceRegistry registry = new StandardServiceRegistryBuilder().configure() // configures settings //
20-
// from hibernate.cfg.xml
21-
.build();
20+
21+
// configures settings from hibernate.cfg.xml
22+
final StandardServiceRegistry registry = new StandardServiceRegistryBuilder().configure().build();
2223
try {
2324
return new MetadataSources(registry).buildMetadata().buildSessionFactory();
24-
} catch (Throwable ex) {
25+
} catch (Exception ex) {
2526
StandardServiceRegistryBuilder.destroy(registry);
26-
// TODO HibernateUtil : change print with logger
27-
System.err.println("Initial SessionFactory creation failed." + ex);
27+
LOGGER.error("Initial SessionFactory creation failed." + ex);
2828
throw new ExceptionInInitializerError(ex);
2929
}
3030
}

‎cqrs/src/main/resources/hibernate.cfg.xml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
"http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">
44

55
<hibernate-configuration>
6-
<session-factory>
7-
<property name="dialect">org.hibernate.dialect.H2Dialect</property>
8-
<property name="connection.driver_class">org.h2.Driver</property>
9-
<property name="connection.url">jdbc:h2:mem:test</property>
10-
<property name="connection.username">sa</property>
11-
<property name="hbm2ddl.auto">create</property>
12-
<mapping class="com.iluwatar.cqrs.domain.model.Author" />
13-
<mapping class="com.iluwatar.cqrs.domain.model.Book" />
14-
</session-factory>
6+
<session-factory>
7+
<property name="dialect">org.hibernate.dialect.H2Dialect</property>
8+
<property name="connection.driver_class">org.h2.Driver</property>
9+
<property name="connection.url">jdbc:h2:mem:test</property>
10+
<property name="connection.username">sa</property>
11+
<property name="hbm2ddl.auto">create</property>
12+
<mapping class="com.iluwatar.cqrs.domain.model.Author" />
13+
<mapping class="com.iluwatar.cqrs.domain.model.Book" />
14+
</session-factory>
1515
</hibernate-configuration>

0 commit comments

Comments
 (0)