# gregwhitaker/catnap architecture

> Architecture diagram of the GitHub repository gregwhitaker/catnap, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gregwhitaker/catnap
- Repository: https://github.com/gregwhitaker/catnap

## Overview

##### Main Components

a) Core Components (catnap-core):
- Query Processing System
- Parser
- Processor
- Model Builder
- View Rendering System
- JSON View
- JSONP View
- Context Management

b) Framework Integration Modules:
- Spring Integration (catnap-spring)
- Spring Boot Integration (catnap-springboot)
- JAX-RS Integration (catnap-jaxrs)

**┌─────────────────────────────────────────────────────────┐**
- Client Applications                     │
- ┘
- ↓
**┌─────────────────────────────────────────────────────────┐**
- Framework Integration Layer                │
- ┬──────────────┬────────────┬──────────────┤
- SpringMVC  │ Spring Boot  │  RESTEasy  │    Jersey    │
- ┴──────────────┴────────────┴──────────────┘
- ↓
**┌─────────────────────────────────────────────────────────┐**
- Catnap Core                         │
- ┬──────────────┬───────────────────────────┤
- Query     │    Model     │         View              │
- Processing │   Building   │       Rendering           │
- ┴──────────────┴───────────────────────────┘

##### Component Relationships

- Request flow from client through framework adapters to core
- Data transformation flow through query processing
- Response flow back through view rendering

##### Detailed Elements

a) Query Processing:
**┌─────────────────────┐**
- Query Processing  │
- ┤
- Query Parser      │
- Expression Parser │
- Query Processor   │
- Query Builder     │
- ┘

b) View Rendering:
**┌─────────────────────┐**
- View Rendering    │
- ┤
- JSON View         │
- JSONP View        │
- View Resolvers    │
- ┘

##### Important Notes

- Clear separation between framework-specific code and core functionality
- Query processing pipeline
- Where partial response filtering occurs
- Integration points with supported frameworks

##### The request/response transformation pipeline

This system design should help developers understand both the high-level architecture and the specific components that enable Catnap's partial response functionality.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    subgraph CL[Client Layer]
        Client[Client Applications]:::client
    end

    %% Framework Integration Layer
    subgraph FL[Framework Integration Layer]
        Spring["Spring MVC"]:::framework
        SpringBoot["Spring Boot"]:::framework
        RESTEasy["RESTEasy"]:::framework
        Jersey["Jersey"]:::framework
    end

    %% Core Layer
    subgraph Core[Catnap Core]
        %% Query Processing
        subgraph QP[Query Processing]
            Parser["Query Parser"]:::core
            ExprParser["Expression Parser"]:::core
            Processor["Query Processor"]:::core
            QueryBuilder["Query Builder"]:::core
        end

        %% Model Building
        subgraph MB[Model Building]
            ModelBuilder["Model Builder"]:::core
            ModelImpl["Model Implementation"]:::core
        end

        %% View Rendering
        subgraph VR[View Rendering]
            BaseView["Base View"]:::core
            JsonView["JSON View"]:::core
            JsonpView["JSONP View"]:::core
        end

        %% Context Management
        Context["Context Management"]:::core
    end

    %% Relationships
    Client --> Spring & SpringBoot & RESTEasy & Jersey
    Spring & SpringBoot & RESTEasy & Jersey --> Parser
    Parser --> ExprParser
    ExprParser --> Processor
    Processor --> QueryBuilder
    QueryBuilder --> ModelBuilder
    ModelBuilder --> ModelImpl
    ModelImpl --> BaseView
    BaseView --> JsonView & JsonpView
    Context --> Parser
    Context --> ModelBuilder
    Context --> BaseView

    %% Styles
    classDef client fill:#FFE5CC,stroke:#FF9933
    classDef framework fill:#CCE5FF,stroke:#3399FF
    classDef core fill:#E5FFCC,stroke:#66CC00

    %% Click Events
    click Parser "https://github.com/gregwhitaker/catnap/tree/master/catnap-core/src/main/java/com/github/gregwhitaker/catnap/core/query/parser/"
    click Processor "https://github.com/gregwhitaker/catnap/tree/master/catnap-core/src/main/java/com/github/gregwhitaker/catnap/core/query/processor/"
    click QueryBuilder "https://github.com/gregwhitaker/catnap/tree/master/catnap-core/src/main/java/com/github/gregwhitaker/catnap/core/query/builder/"
    click JsonView "https://github.com/gregwhitaker/catnap/blob/master/catnap-core/src/main/java/com/github/gregwhitaker/catnap/core/view/JsonCatnapView.java"
    click JsonpView "https://github.com/gregwhitaker/catnap/blob/master/catnap-core/src/main/java/com/github/gregwhitaker/catnap/core/view/JsonpCatnapView.java"
    click BaseView "https://github.com/gregwhitaker/catnap/blob/master/catnap-core/src/main/java/com/github/gregwhitaker/catnap/core/view/CatnapView.java"
    click ModelBuilder "https://github.com/gregwhitaker/catnap/tree/master/catnap-core/src/main/java/com/github/gregwhitaker/catnap/core/model/builder/"
    click ModelImpl "https://github.com/gregwhitaker/catnap/tree/master/catnap-core/src/main/java/com/github/gregwhitaker/catnap/core/model/"
    click Context "https://github.com/gregwhitaker/catnap/blob/master/catnap-core/src/main/java/com/github/gregwhitaker/catnap/core/context/CatnapContext.java"
    click Spring "https://github.com/gregwhitaker/catnap/tree/master/catnap-spring/src/main/java/com/github/gregwhitaker/catnap/springmvc/"
    click SpringBoot "https://github.com/gregwhitaker/catnap/tree/master/catnap-springboot/src/main/java/com/github/gregwhitaker/catnap/springboot/"
    click RESTEasy "https://github.com/gregwhitaker/catnap/tree/master/catnap-jaxrs/src/main/java/com/github/gregwhitaker/catnap/jaxrs/"
```
