How marudham/wowgen works
Project type & purpose (from tree + README)
This is a small Java application/library (single package com.wowgen) that appears to generate or manipulate “words” using:
• a built-in English dictionary (dictionary.json)
• permutation / combinatorics logic (Permutation.java)
• domain objects (Word.java)
• a main generator/service (WOWGen.java)
• an application entry point (WOWGenApp.java)
What to focus on
• Runtime boundaries (JVM process, classpath/libs, resource file)
• Core functional components (generator, dictionary loader, permutation engine, domain model)
• Data flow (dictionary JSON → in-memory structures → generator → output)
• External dependencies (Jackson jars for JSON parsing)
Don’t overthink distributed concerns (services, queues, DBs). Instead, separate the code into as many internal components as possible.
Main components (map directly to files)
Use the source files as the primary truth for component decomposition:
Application / Entry Point
• WOWGenApp.java: likely contains public static void main(...) and orchestrates the run.
Core Generator / Use-Case Layer
• WOWGen.java: the main “engine” coordinating dictionary usage + permutations to produce results.
Dictionary / Data Access Layer (but local)
• EnglishWordsDictionary.java: loads and queries dictionary words.
• Likely reads dictionary.json and exposes lookup/filter methods.
Algorithm / Utility Layer
• Permutation.java: combinatorics/permutation logic used by WOWGen.
Domain Model
• Word.java: representation of a word, maybe with metadata.
Local Resource
• src/com/wowgen/dictionary.json (and mirrored in bin/...): the embedded dictionary dataset.
Third-Party Libraries
• lib/jackson-annotations-2.20.jar
• lib/jackson-core-2.20.0.jar
• lib/jackson-databind-2.20.0.jar
• Used by EnglishWordsDictionary to parse JSON.
Build Output (optional)
• bin/...: compiled classes and copied resources (Eclipse-style output)
User/Invoker → WOWGenApp
• “Runs program / provides input args” (if any).
WOWGenApp → WOWGen
• “Constructs and calls generator”.
WOWGen → EnglishWordsDictionary
• “Queries dictionary / validates candidates”.
EnglishWordsDictionary → dictionary.json
• “Loads word list from bundled JSON resource”.
EnglishWordsDictionary → Jackson (ObjectMapper)
• “Parses JSON into in-memory structures”.
WOWGen → Permutation
• “Generates permutations / candidate strings”.
WOWGen ↔ Word
• “Creates/returns Word objects” or “operates on Word domain model”.
Architectural pattern(s) to call out
This project likely follows a simple layered separation:
• Bootstrap/UI: WOWGenApp
• Core logic: WOWGen, Permutation
• Data source: EnglishWordsDictionary reading a local resource
• Domain model: Word
• Actor: “User”
• External: “Local filesystem/classpath resource: dictionary.json”
• External: “Jackson libraries”
This clarifies: single JVM, local resource, no server.
Show:
• JVM Process boundary
• Inside: “WOWGenApp”, “WOWGen Engine”, “Dictionary Loader”, “Permutation Engine”, “Domain Model”
• Outside: “dictionary.json resource”, “Jackson JARs”
A more code-faithful view mapping each .java file to a component and drawing:
• WOWGenApp depends on WOWGen
• WOWGen depends on EnglishWordsDictionary, Permutation, Word
• EnglishWordsDictionary depends on dictionary.json and Jackson