Implement DAO Factory pattern #3282

letdtcode · 2025-05-17T09:16:14Z

Pull Request Template

What does this PR do?

This pull request implements the DAO Factory pattern, which demonstrates how the application should be switch between three different types of data sources (H2, Mongo, Json flat file). It includes code documented implementation, comprehensive tests, detailed documentation.

Key features

Customer: A model class presenting object that needs persistence in data source
DAOFactory: Abstract class provides a way to get the appropriate DAO based on the data source.
H2DataSourceFactory, MongoDataSourceFactory, FlatFileDataSourceFactory: Concrete factory which implement DAOFactory and return specific DAO Customer.
CustomerDAO: Define CRUD operation with Customer model.
FlatFileCustomerDAO, H2CustomerDAO, MongoCustomerDAO: Concrete DAO Customer which implement CRUD operation with data source.

Related Issue

Closes #1270

github-actions · 2025-05-17T09:16:27Z

PR Summary

This PR implements the DAO Factory pattern, providing flexible data access by switching between H2, Mongo, and JSON flat file data sources. It includes a Customer model, DAOFactory abstract class, concrete factories (H2DataSourceFactory, MongoDataSourceFactory, FlatFileDataSourceFactory), CustomerDAO interface, and concrete DAO implementations. Comprehensive tests and documentation are also included.

Changes

File	Summary
`dao-factory/README.md`	This file provides a comprehensive guide to the DAO Factory pattern, including its intent, real-world examples, a class diagram, a programmatic example in Java, usage scenarios, benefits, trade-offs, and related design patterns. It also includes references and credits.
`dao-factory/etc/dao-factory.png`	New file: Class diagram for the DAO Factory pattern.
`dao-factory/etc/dao-factory.puml`	New file: PlantUML class diagram for the DAO Factory pattern.
`dao-factory/pom.xml`	New file: Maven project configuration file for the DAO Factory pattern implementation.
`dao-factory/src/main/java/com/iluwatar/daofactory/App.java`	This Java class demonstrates the usage of the DAO Factory pattern by performing CRUD operations on a `Customer` object using three different data sources: H2, MongoDB, and a JSON flat file.
`dao-factory/src/main/java/com/iluwatar/daofactory/CustomException.java`	New file: Custom exception class for handling errors in the DAO Factory pattern implementation.
`dao-factory/src/main/java/com/iluwatar/daofactory/Customer.java`	New file: Represents a customer object with a generic ID and name, designed for persistence in various data sources.
`dao-factory/src/main/java/com/iluwatar/daofactory/CustomerDAO.java`	New file: Defines the interface for Data Access Objects (DAOs) that handle CRUD operations for `Customer` objects.
`dao-factory/src/main/java/com/iluwatar/daofactory/DAOFactory.java`	New file: Abstract class defining the interface for creating concrete DAO factories for different data sources.
`dao-factory/src/main/java/com/iluwatar/daofactory/DAOFactoryProvider.java`	New file: Provides concrete DAOFactory implementations based on the specified data source type.
`dao-factory/src/main/java/com/iluwatar/daofactory/DataSourceType.java`	New file: Enumerates the supported data source types (H2, Mongo, FlatFile).
`dao-factory/src/main/java/com/iluwatar/daofactory/FlatFileCustomerDAO.java`	New file: Implements CustomerDAO using a JSON flat file for data persistence.
`dao-factory/src/main/java/com/iluwatar/daofactory/FlatFileDataSourceFactory.java`	New file: Creates a FlatFileCustomerDAO instance.
`dao-factory/src/main/java/com/iluwatar/daofactory/H2CustomerDAO.java`	New file: Implements CustomerDAO using an in-memory H2 database.
`dao-factory/src/main/java/com/iluwatar/daofactory/H2DataSourceFactory.java`	New file: Creates an H2CustomerDAO instance.
`dao-factory/src/main/java/com/iluwatar/daofactory/MongoCustomerDAO.java`	New file: Implements CustomerDAO using MongoDB for data persistence.
`dao-factory/src/main/java/com/iluwatar/daofactory/MongoDataSourceFactory.java`	New file: Creates a MongoCustomerDAO instance.
`dao-factory/src/main/resources/logback.xml`	New file: Logback configuration file for logging.
`dao-factory/src/test/java/com/iluwatar/daofactory/AppTest.java`	New file: Unit tests for the App class, verifying CRUD operations.
`dao-factory/src/test/java/com/iluwatar/daofactory/DAOFactoryTest.java`	New file: Unit tests for the DAOFactory, verifying creation of different DAO implementations.
`dao-factory/src/test/java/com/iluwatar/daofactory/FlatFileCustomerDAOTest.java`	New file: Unit tests for FlatFileCustomerDAO, covering various scenarios including file operations and CRUD operations.
`dao-factory/src/test/java/com/iluwatar/daofactory/H2CustomerDAOTest.java`	New file: Unit tests for H2CustomerDAO, covering various scenarios including database operations and CRUD operations.
`dao-factory/src/test/java/com/iluwatar/daofactory/MongoCustomerDAOTest.java`	New file: Unit tests for MongoCustomerDAO, covering various scenarios including database operations and CRUD operations.
`pom.xml`	The `dao-factory` module was added to the project.

autogenerated by presubmit.ai

github-actions

✅ LGTM!

Review Summary

Commits Considered (8)

f9263cc: fix SonarQube
7c83fec: add license
0a24bfd: fix: unit test pipeline
abd7ef8: fix: h2 inmemory database to pass CI
525ad3f: doc: add document for dao-factory
2960794: test: Add unit test dao-factory
fd0f855: feat: done implement dao factory
50fbd10: feat: implement dao factory

Files Processed (24)

dao-factory/README.md (1 hunk)
dao-factory/etc/dao-factory.png (0 hunks)
dao-factory/etc/dao-factory.puml (1 hunk)
dao-factory/pom.xml (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/App.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/CustomException.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/Customer.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/CustomerDAO.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/DAOFactory.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/DAOFactoryProvider.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/DataSourceType.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/FlatFileCustomerDAO.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/FlatFileDataSourceFactory.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/H2CustomerDAO.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/H2DataSourceFactory.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/MongoCustomerDAO.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/MongoDataSourceFactory.java (1 hunk)
dao-factory/src/main/resources/logback.xml (1 hunk)
dao-factory/src/test/java/com/iluwatar/daofactory/AppTest.java (1 hunk)
dao-factory/src/test/java/com/iluwatar/daofactory/DAOFactoryTest.java (1 hunk)
dao-factory/src/test/java/com/iluwatar/daofactory/FlatFileCustomerDAOTest.java (1 hunk)
dao-factory/src/test/java/com/iluwatar/daofactory/H2CustomerDAOTest.java (1 hunk)
dao-factory/src/test/java/com/iluwatar/daofactory/MongoCustomerDAOTest.java (1 hunk)
pom.xml (2 hunks)

Actionable Comments (0)

Skipped Comments (0)

github-actions

✅ LGTM!

Review Summary

Commits Considered (1)

9afad6d: add pom.xml

Files Processed (24)

dao-factory/README.md (1 hunk)
dao-factory/etc/dao-factory.png (0 hunks)
dao-factory/etc/dao-factory.puml (1 hunk)
dao-factory/pom.xml (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/App.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/CustomException.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/Customer.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/CustomerDAO.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/DAOFactory.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/DAOFactoryProvider.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/DataSourceType.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/FlatFileCustomerDAO.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/FlatFileDataSourceFactory.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/H2CustomerDAO.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/H2DataSourceFactory.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/MongoCustomerDAO.java (1 hunk)
dao-factory/src/main/java/com/iluwatar/daofactory/MongoDataSourceFactory.java (1 hunk)
dao-factory/src/main/resources/logback.xml (1 hunk)
dao-factory/src/test/java/com/iluwatar/daofactory/AppTest.java (1 hunk)
dao-factory/src/test/java/com/iluwatar/daofactory/DAOFactoryTest.java (1 hunk)
dao-factory/src/test/java/com/iluwatar/daofactory/FlatFileCustomerDAOTest.java (1 hunk)
dao-factory/src/test/java/com/iluwatar/daofactory/H2CustomerDAOTest.java (1 hunk)
dao-factory/src/test/java/com/iluwatar/daofactory/MongoCustomerDAOTest.java (1 hunk)
pom.xml (1 hunk)

Actionable Comments (0)

Skipped Comments (0)

ronodhirSoumik · 2025-05-25T20:52:18Z

dao-factory/src/main/java/com/iluwatar/daofactory/DAOFactoryProvider.java

+    return switch (dataSourceType) {
+      case H2 -> new H2DataSourceFactory();
+      case MONGO -> new MongoDataSourceFactory();
+      case FLAT_FILE -> new FlatFileDataSourceFactory();


As per the provided documentation -
default -> throw new IllegalArgumentException("Unsupported data source type");

As per the provided documentation - default -> throw new IllegalArgumentException("Unsupported data source type");

Thanks, I fixed it

github-actions

✅ LGTM!

Review Summary

Commits Considered (1)

2a66d97: fix: throw exception + refactor

Files Processed (2)

dao-factory/src/main/java/com/iluwatar/daofactory/DAOFactoryProvider.java (1 hunk)
pom.xml (1 hunk)

Actionable Comments (0)

Skipped Comments (0)

sonarqubecloud · 2025-05-26T17:10:12Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
83.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

letdtcode added 8 commits May 17, 2025 16:06

feat: implement dao factory

50fbd10

feat: done implement dao factory

fd0f855

test: Add unit test dao-factory

2960794

doc: add document for dao-factory

525ad3f

fix: h2 inmemory database to pass CI

abd7ef8

fix: unit test pipeline

0a24bfd

add license

7c83fec

fix SonarQube

f9263cc

github-actions bot reviewed May 17, 2025

View reviewed changes

letdtcode mentioned this pull request May 17, 2025

Implement DAO Factory pattern [Closed] #3275

Closed

add pom.xml

9afad6d

github-actions bot reviewed May 17, 2025

View reviewed changes

ronodhirSoumik reviewed May 25, 2025

View reviewed changes

fix: throw exception + refactor

2a66d97

github-actions bot reviewed May 26, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Implement DAO Factory pattern #3282

Implement DAO Factory pattern #3282

Uh oh!

letdtcode commented May 17, 2025

Uh oh!

github-actions bot commented May 17, 2025 •

edited

Loading

Uh oh!

github-actions bot left a comment

Uh oh!

github-actions bot left a comment

Uh oh!

ronodhirSoumik May 25, 2025

Uh oh!

letdtcode May 27, 2025

Uh oh!

github-actions bot left a comment

Uh oh!

sonarqubecloud bot commented May 26, 2025

Uh oh!

Uh oh!

Uh oh!

Implement DAO Factory pattern #3282

Are you sure you want to change the base?

Implement DAO Factory pattern #3282

Uh oh!

Conversation

letdtcode commented May 17, 2025

Pull Request Template

What does this PR do?

Key features

Related Issue

Uh oh!

github-actions bot commented May 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

Changes

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Review Summary

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Review Summary

Uh oh!

ronodhirSoumik May 25, 2025

Choose a reason for hiding this comment

Uh oh!

letdtcode May 27, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Review Summary

Uh oh!

sonarqubecloud bot commented May 26, 2025

Quality Gate passed

Uh oh!

Uh oh!

github-actions bot commented May 17, 2025 •

edited

Loading