chore: refactor module fj-doc-val-imageio

Author: fugerit79

CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- TIFF validtor based on TwelveMonkeys ImageIO <https://github.com/fugerit-org/fj-doc/issues/551>
+- Image validator based on TwelveMonkeys ImageIO (currently supporting TIFF) <https://github.com/fugerit-org/fj-doc/issues/551>
 
 ### Changed
 

fj-doc-val-imageio-tiff/pom.xml renamed to fj-doc-val-imageio/pom.xml

@@ -2,16 +2,16 @@
 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 
-	<artifactId>fj-doc-val-imageio-tiff</artifactId>
+	<artifactId>fj-doc-val-imageio</artifactId>
 
 	<parent>
 		<groupId>org.fugerit.java</groupId>
 		<artifactId>fj-doc</artifactId>
 		<version>8.17.1-SNAPSHOT</version>
 	</parent>
 
-	<name>fj-doc-val-imageio-tiff</name>
-	<description>Module for validating TIFF TwelveMonkeys ImageIO</description>
+	<name>fj-doc-val-imageio</name>
+	<description>Module for validating Images based TwelveMonkeys ImageIO</description>
 
 	<licenses>
 		<license>
@@ -22,7 +22,7 @@
 	</licenses>
 
 	<properties>
-		<imageio-tiff-version>3.12.0</imageio-tiff-version>
+		<imageio-version>3.12.0</imageio-version>
 	</properties>
 
 	<build>
@@ -44,9 +44,15 @@
 		<dependency>
 			<groupId>com.twelvemonkeys.imageio</groupId>
 			<artifactId>imageio-tiff</artifactId>
-			<version>${imageio-tiff-version}</version>
+			<version>${imageio-version}</version>
 		</dependency>
 
+        <dependency>
+            <groupId>com.twelvemonkeys.imageio</groupId>
+            <artifactId>imageio-jpeg</artifactId>
+            <version>${imageio-version}</version>
+        </dependency>
+
 		<dependency>
 			<groupId>org.junit.jupiter</groupId>
 			<artifactId>junit-jupiter-api</artifactId>

fj-doc-val-imageio-tiff/src/main/java/org/fugerit/java/doc/val/imageio/tiff/ImageIOTiffUtils.java renamed to fj-doc-val-imageio/src/main/java/org/fugerit/java/doc/val/imageio/core/ImageIOCoreUtils.java

@@ -1,7 +1,5 @@
-package org.fugerit.java.doc.val.imageio.tiff;
+package org.fugerit.java.doc.val.imageio.core;
 
-import com.twelvemonkeys.imageio.metadata.tiff.TIFFEntry;
-import com.twelvemonkeys.imageio.plugins.tiff.TIFFImageMetadata;
 import lombok.extern.slf4j.Slf4j;
 import org.fugerit.java.doc.val.core.DocTypeValidationResult;
 import org.w3c.dom.NamedNodeMap;
@@ -15,13 +13,14 @@
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
+import java.util.function.BiFunction;
 
 @Slf4j
-public class ImageIOTiffUtils {
+public class ImageIOCoreUtils {
 
-    private ImageIOTiffUtils() {}
+    private ImageIOCoreUtils() {}
 
-    public static DocTypeValidationResult validateTiffAndMetadata(InputStream is, Integer[] idTags) {
+    public static DocTypeValidationResult validateMetadata(InputStream is, String imageFormat, BiFunction<IIOMetadata, List<String>, Boolean> tagFunction) {
         ImageReader reader = null;
         try (ImageInputStream iis = ImageIO.createImageInputStream(is)) {
             Iterator<ImageReader> readers = ImageIO.getImageReaders(iis);
@@ -35,7 +34,6 @@ public static DocTypeValidationResult validateTiffAndMetadata(InputStream is, In
 
             IIOMetadata meta = reader.getImageMetadata(0);
 
-            // TIFF plugin metadata format name
             String[] formatNames = meta.getMetadataFormatNames();
             for (String format : formatNames) {
                 log.debug("Metadata format: {}", format);
@@ -45,16 +43,8 @@ public static DocTypeValidationResult validateTiffAndMetadata(InputStream is, In
 
             List<String> missingTags = new ArrayList<>();
 
-            if (meta instanceof TIFFImageMetadata) {
-                for ( int idTag : idTags ) {
-                    TIFFImageMetadata tiffMeta = (TIFFImageMetadata) meta;
-                    TIFFEntry entry = (TIFFEntry) tiffMeta.getTIFFField(idTag);
-                    if (entry == null) {
-                        missingTags.add( ImageIOTiffTags.tagDescription(idTag) );
-                    }
-                }
-            } else {
-                return DocTypeValidationResult.newFail().withValidationMessage( "No TIFF metadata available" );
+            if ( !tagFunction.apply( meta, missingTags ) ) {
+                return DocTypeValidationResult.newFail().withValidationMessage( String.format( "No %s metadata available", imageFormat ) );
             }
 
             if (missingTags.isEmpty()) {
@@ -64,7 +54,7 @@ public static DocTypeValidationResult validateTiffAndMetadata(InputStream is, In
             }
 
         } catch (Exception e) {
-            String message = String.format( "Error reading TIFF metadata from stream %s", e );
+            String message = String.format( "Error reading %s metadata from stream %s", imageFormat, e );
             log.error( message, e );
             return DocTypeValidationResult.newFail().withMainException( e );
         } finally {

fj-doc-val-imageio-tiff/src/main/java/org/fugerit/java/doc/val/imageio/tiff/ImageIOTiffTags.java renamed to fj-doc-val-imageio/src/main/java/org/fugerit/java/doc/val/imageio/tiff/ImageIOTiffTags.java

@@ -1,9 +1,12 @@
 package org.fugerit.java.doc.val.imageio.tiff;
 
 import com.twelvemonkeys.imageio.metadata.tiff.TIFF;
+import com.twelvemonkeys.imageio.metadata.tiff.TIFFEntry;
+import com.twelvemonkeys.imageio.plugins.tiff.TIFFImageMetadata;
 import org.fugerit.java.doc.val.core.DocTypeValidationResult;
 import org.fugerit.java.doc.val.core.basic.AbstractDocTypeValidator;
 import org.fugerit.java.doc.val.core.basic.ImageValidator;
+import org.fugerit.java.doc.val.imageio.core.ImageIOCoreUtils;
 
 import java.io.InputStream;
 import java.util.Arrays;
@@ -34,7 +37,20 @@ public ImageIOTiffValidator() {
 
     @Override
     public DocTypeValidationResult validate(InputStream is) {
-        return ImageIOTiffUtils.validateTiffAndMetadata( is, this.idTags );
+        return ImageIOCoreUtils.validateMetadata( is, "TIFF", (meta, missingTags ) -> {
+            if (meta instanceof TIFFImageMetadata) {
+                for ( int idTag : idTags ) {
+                    TIFFImageMetadata tiffMeta = (TIFFImageMetadata) meta;
+                    TIFFEntry entry = (TIFFEntry) tiffMeta.getTIFFField(idTag);
+                    if (entry == null) {
+                        missingTags.add( ImageIOTiffTags.tagDescription(idTag) );
+                    }
+                }
+                return Boolean.TRUE;
+            } else {
+                return Boolean.FALSE;
+            }
+        } );
     }
 
 }

fj-doc-val-imageio-tiff/src/main/java/org/fugerit/java/doc/val/imageio/tiff/ImageIOTiffValidator.java renamed to fj-doc-val-imageio/src/main/java/org/fugerit/java/doc/val/imageio/tiff/ImageIOTiffValidator.java

@@ -1,4 +1,4 @@
-package org.fugerit.java.doc.val.imageio.tiff;
+package org.fugerit.java.doc.val.imageio.core;
 
 import org.fugerit.java.core.xml.dom.DOMIO;
 import org.junit.jupiter.api.Assertions;
@@ -8,13 +8,13 @@
 import java.io.ByteArrayInputStream;
 import java.io.InputStream;
 
-class TestImageIOTiffUtils {
+class TestImageIOCoreUtils {
 
     @Test
     void testNodeWithoutAttributes() throws Exception {
         try (InputStream stream = new ByteArrayInputStream( "<test/>".getBytes() )) {
             Document doc = DOMIO.newSafeDocumentBuilderFactory().newDocumentBuilder().parse( stream );
-            ImageIOTiffUtils.dumpNode( doc, 1 );
+            ImageIOCoreUtils.dumpNode( doc, 1 );
             Assertions.assertNotNull( doc );
         }