Document-Comparison-Service

A JEE Application for Measuring Document Similarity.

Overview

Java web application that enables two or more documents to be compared for similarity.

Technologies

• Java Java is a set of computer software and specifications developed by Sun Microsystems, which was later acquired by the Oracle Corporation, that provides a system for developing application software and deploying it in a cross-platform computing environment.
• TomCat The Apache Tomcat® software is an open source implementation of the Java Servlet, JavaServer Pages, Java Expression Language and Java WebSocket technologies.
• Eclipse Eclipse is an integrated development environment (IDE) used in computer programming, and is the most widely used Java IDE.
• JQuery Query is a cross-platform JavaScript library designed to simplify the client-side scripting of HTML.
• db4o db4o was an embeddable open source object database for Java and.NET developers. It was developed, commercially licensed and supported by Actian. In October 2014, Actian declined to continue to actively pursue and promote the commercial db4o product offering for new customers.
• db4o XTEA encryption library XTEA (eXtended Tiny Encryption Algorithm) support for db4o open source object database. XTEA is a block cipher that operates on a 64-bit block size with a 128-bit key. An extremely tiny but very fast encryption algorithm (with cycles less than 32 rounds).

Architecture

• UploadHandler servlet initialize Util class and set Util.Config inner class with parameters from web.xml. Creates a Job object with received file and title and pass it to the inQueue through Util class.
• Util static class implements Fasade design patern. Initilize LogService and ThreadPoolService class.
• LogService Singleton class logs all the messages to the file and console.
• ThreadPoolService class spawns HeavyWorker abstract class type of workers into the fixedThreadPool using Prototype creational patern.
• Worker class implements HeavyWorker abstract class and process the Job object through MinHash Fasade class and output the Results object to outQueue.
• MinHash class implements Fasade design patern. Proces the document through ProcessDocument class. Retrieve and store Document objects through DocumentDao interface.
• DocumentDao interface. This interface defines the standard operations to be performed on a Document object(s).
• Db4oController class implements DAO interface and process request through Db4oService class.
• PollHandler servlet polls outQueue HashMap for results of a job and display them.

UML diagram

Installation for Eclipse

• Clone this repository with Eclipse.
• Click on the project in Eclipse Project Explorer and press Alt+Enter for Project properties.
• Navigate to Java Build Path and Remove broken JRE System Library.
• Click Add Library.. and select JRE System Library and Click Finish to update project with correct path to library
• Edit web.xml located in /WebContent/WEB-INF folder and change paths for logFile and dbFile.
• Run Tomcat server (This web application was developed on Tomcat 9.0)
• Navigate to localhost:8080/Document-Comparison-Service/ to start using the service.
• Please note the port as your Tomcat server can be running on different one.

Usage

• Click on Choose file and select file to be compared.
• Note the text box will be populated with file name, you can adjust the title here.
• Click Compare Document. This button will be enabled once you select document File and Title.
• You be redirected to Pooling site, where server will be polled for comparison results on regular intervals (Refresh rate can be specified inside web.xml)
• After results are available Table with approximate similarity results for every document uploaded will be displayed.
  Note that initial file comparison will display empty table.

Demo