Rework caching.

[dfuchss]

Now it shall be ensured that CacheParameters are used correctly.

[Copilot]

Pull request overview

This PR refactors the caching architecture to use a type-safe CacheParameter interface pattern instead of string arrays. The changes ensure that cache parameters are used correctly and consistently across the codebase through new ArchUnit tests that enforce architectural constraints.

Key Changes

• Introduced CacheParameter interface with concrete implementations (ClassifierCacheParameter, EmbeddingCacheParameter) to replace string array parameters
• Moved ClassifierCacheKey and EmbeddingCacheKey to dedicated subpackages (classifier and embedding)
• Added comprehensive ArchUnit tests to enforce that CacheKey implementations use CacheParameter correctly and that CacheParameter implementations include all fields

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/CacheParameter.java	New interface defining the contract for cache parameters with a parameters() method
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/classifier/ClassifierCacheParameter.java	New record implementing CacheParameter for classifier caching, with backward compatibility for temperature
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/embedding/EmbeddingCacheParameter.java	New record implementing CacheParameter for embedding caching
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/classifier/ClassifierCacheKey.java	Moved to classifier subpackage and updated to use ClassifierCacheParameter in static factory method
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/embedding/EmbeddingCacheKey.java	Moved to embedding subpackage and updated to use EmbeddingCacheParameter in static factory method
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/CacheKey.java	Updated imports to reflect moved cache key classes
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/CacheManager.java	Simplified API to accept CacheParameter instead of string arrays; removed unused getCache(Path, boolean) method
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/classifier/ChatLanguageModelProvider.java	Changed getCacheParameters() to return ClassifierCacheParameter instead of string array
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/classifier/SimpleClassifier.java	Updated to use new cacheParameters() method and ClassifierCacheKey.of() with CacheParameter
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/classifier/ReasoningClassifier.java	Updated to use new cacheParameters() method and ClassifierCacheKey.of() with CacheParameter
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/preprocessor/SummarizePreprocessor.java	Updated to use new cacheParameters() method and ClassifierCacheKey.of() with CacheParameter
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/embeddingcreator/CachedEmbeddingCreator.java	Updated to use EmbeddingCacheParameter throughout and in EmbeddingCacheKey.of() calls
src/test/java/edu/kit/kastel/sdq/lissa/ratlr/ArchitectureTest.java	Added two new ArchUnit rules to enforce CacheKey and CacheParameter implementation contracts

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
1 Accepted issue

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

See analysis details on SonarQube Cloud

[Copilot]

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 6 comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The EmbeddingCacheParameter record lacks a class-level javadoc comment explaining its purpose and usage. Other CacheParameter implementations should follow similar documentation standards. Consider adding javadoc that explains what this parameter represents and how it's used in the caching system.

Suggested change

	/**
	* Represents a cache parameter for embedding operations, encapsulating the model name.
	* <p>
	* This parameter is used as a key in the caching system to uniquely identify
	* cache entries related to embeddings for a specific model. Other {@link CacheParameter}
	* implementations should follow similar documentation standards.
	*/

[Copilot]

The comment explaining why the parameters() method is filtered out is split across multiple lines in an inconsistent way. The comment starts on line 170 but is part of the filter statement on line 169. This should be reformatted to have the complete comment on a single line or moved to a separate line above the filter statement for better readability.

Suggested change

	.filter(m -> !m.getName()
	.equals("parameters")) // parameters() is for cache naming, not
	// for key construction
	// parameters() is for cache naming, not for key construction
	.filter(m -> !m.getName().equals("parameters"))

[Copilot]

The parameters() method only includes temperature in the output when it's not 0.0, but the method always accesses the temperature field (via the condition check). This satisfies the architectural rule that requires all fields to be accessed. However, consider whether this conditional inclusion could lead to cache collisions when temperature is explicitly set to 0.0 versus when it's the default value. The current implementation appears intentional for backward compatibility, but it's worth documenting this behavior more explicitly in the class javadoc.