DbExporter

Table of Contents

• Features
• Prerequisites
• Getting Started
• Usage
• Plugin Architecture
• Configurationless Operation
• Contributing
• License

Features

• Export data from MySQL database tables.
• Supports multiple export formats (e.g., HTML, XML, etc.).
• Extensible architecture for adding new export formats without modifying existing code.
• Graphical user interface using Swing.
• Virtually configurationless operation.
  

Variants

• v0     :(uses an XML config file for adding new export formats) \
• v1     :(Configurationless addition of new export formats)\
• Base App : v1 + new export format name annotations (@ExportType)

Prerequisites

• Java 8 or higher
• MySQL database

Getting Started

*Note: if you want to use the mave-wrapper, append w to the mvn commands, ex: mvvnw clean

1. Clone the repository:

   2 lines
   Copy
   1git clone https://github.com/aamitn/DbExporter.git
   2cd DbExporter
   

2. Compile the code:

   1 lines
   Copy
   1mvn clean install
   

3. Run using jar:

   1 lines
   Copy
   1java -jar target/DbExporter.jar
   

OR

4. Run using java mainClass:

   1 lines
   Copy
   1mvn compile exec:java
   

Usage

Launch the application using the steps mentioned in the Getting Started section.
Connect to your MySQL database by entering the database name, username, and password.
Click "Show Tables" to display the available tables.
Select a table from the list.
Choose an export format from the dropdown menu.
Click "Export Table" to export the selected table to the chosen format.

Example Factory Class Usage:

3 lines
Copy
1ExporterFactory exportFactory = new ExporterFactory(connection);
2Exportable exporter = exportFactory.getExporter("xml"); 
3exporter.export("your_table_name", "output.xml");

Plugin Architecture

The application employs a plugin architecture, allowing you to add new export formats without modifying existing code or addintional config. To add a new export format, simply create a new class implementing the Exportable interface and place it in the org.nmpl.exporters package.

Example for creating a new export format:

7 lines
Copy
1package org.nmpl.exporters;
2
3import org.nmpl.Exportable;
4
5public class NewFormatExporter implements Exportable {
6// Implement the export method as per your requirements
7}

You can give the name of the export format using annotaions like this:

9 lines
Copy
1package org.nmpl.exporters;
2
3import org.nmpl.ExportType;
4import org.nmpl.Exportable;
5
6@ExportType("Export_Type_Name")
7public class NewFormatExporter implements Exportable {
8// Implement the export method as per your requirements
9}

No changes to the existing code are needed. The new class is automatically recognized and integrated into the application at runtime.

Configurationless Operation

The application is designed for configurationless operation due to its internal usage of Reflection and class loader libraries.

Note : You may choose to use the version of the program that does not uses an XML configuration file to load the new export types Go to the V0 directory and run the App.java inside it

The config.xml file, located in the resources directory, maps export formats to their corresponding Java class names. This enables the application to dynamically recognize and utilize new exporters without explicit configuration.

Example config.xml:

15 lines
Copy
1<exporters>
2	<exporter> 
3 		<type>html</type> 
4		<class>org.nmpl.exporters.HTMLExporter</class> 
5	</exporter> 
6	<exporter>
7		<type>xml</type>
8 		<class>org.nmpl.exporters.XMLExporter</class> 
9	</exporter>
10 	<exporter> 
11		<type>newformat</type> 
12		<class>org.nmpl.exporters.NewFormatExporter</class>
13 	</exporter>
14 <!-- Add more exporter configurations as needed --> 
15</exporters>

Fork the repository

Create a new branch (git checkout -b feature/new-feature)
Make your changes and commit them (git commit -am 'Add new feature')
Push to the branch (git push origin feature/new-feature)
Open a pull request

License

This project is licensed under the MIT License - see the LICENSE file for details.