Merge pull request #320 from veraPDF/refactoring

Refactoring
veraPDF · Dec 11, 2023 · 49a4c3f · 49a4c3f
2 parents baf8966 + 5aeb03d
commit 49a4c3f
Show file tree

Hide file tree

Showing 52 changed files with 102 additions and 76 deletions.
diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/AnnotationNode.java b/src/main/java/org/verapdf/wcag/algorithms/entities/AnnotationNode.java
@@ -16,14 +16,17 @@ public AnnotationNode(String annotationType, BoundingBox boundingBox, Integer de
 		this.destinationObjectKeyNumber = destinationObjectKeyNumber;
 	}
 
+	@Override
 	public String getAnnotationType() {
 		return this.annotationType;
 	}
 
+	@Override
 	public Integer getDestinationPageNumber() {
 		return this.destinationPageNumber;
 	}
 
+	@Override
 	public Integer getDestinationObjectKeyNumber() {
 		return destinationObjectKeyNumber;
 	}

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/AttributesDictionary.java b/src/main/java/org/verapdf/wcag/algorithms/entities/AttributesDictionary.java
@@ -23,10 +23,12 @@ public void setColSpan(long colSpan) {
 		this.colSpan = colSpan;
 	}
 
+	@Override
 	public long getRowSpan() {
 		return rowSpan;
 	}
 
+	@Override
 	public long getColSpan() {
 		return colSpan;
 	}

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/BaseObject.java b/src/main/java/org/verapdf/wcag/algorithms/entities/BaseObject.java
@@ -100,10 +100,12 @@ public void setRecognizedStructureId(Long id) {
 		recognizedStructureId = id;
 	}
 
+	@Override
 	public double getWidth() {
 		return boundingBox.getWidth();
 	}
 
+	@Override
 	public double getHeight() {
 		return boundingBox.getHeight();
 	}

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/Document.java b/src/main/java/org/verapdf/wcag/algorithms/entities/Document.java
@@ -9,40 +9,46 @@
 
 public class Document implements IDocument {
 
-	private ITree tree;
-	private List<IPage> pages;
+	private final ITree tree;
+	private final List<IPage> pages;
 
 	public Document(ITree tree) {
 		this.tree = tree;
 		pages = new LinkedList<>();
 	}
 
+	@Override
 	public ITree getTree(){
 		return tree;
 	}
 
+	@Override
 	public List<IChunk> getArtifacts(Integer pageNumber) {
 		if (pageNumber < pages.size()) {
 			return pages.get(pageNumber).getArtifacts();
 		}
 		return Collections.emptyList();
 	}
 
+	@Override
 	public List<IPage> getPages() {
 		return pages;
 	}
 
+	@Override
 	public int getNumberOfPages() {
 		return pages.size();
 	}
 
+	@Override
 	public IPage getPage(Integer pageNumber) {
 		if (pageNumber < pages.size()) {
 			return pages.get(pageNumber);
 		}
 		return null;
 	}
 
+	@Override
 	public List<IChunk> getArtifacts() {
 		List<IChunk> artifacts = new ArrayList<>();
 		for (IPage page : pages) {

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/INode.java b/src/main/java/org/verapdf/wcag/algorithms/entities/INode.java
@@ -1,10 +1,8 @@
 package org.verapdf.wcag.algorithms.entities;
 
 import org.verapdf.wcag.algorithms.entities.enums.SemanticType;
-import org.verapdf.wcag.algorithms.entities.geometry.BoundingBox;
 
 import java.util.List;
-import java.util.Set;
 
 public interface INode extends IObject {
 

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/ITree.java b/src/main/java/org/verapdf/wcag/algorithms/entities/ITree.java
@@ -6,6 +6,7 @@ public interface ITree extends Iterable<INode> {
 
 	INode getRoot();
 
+	@Override
 	default Iterator<INode> iterator() {
 		return new DFSTreeNodeIterator(getRoot());
 	}

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/Page.java b/src/main/java/org/verapdf/wcag/algorithms/entities/Page.java
@@ -17,10 +17,12 @@ public Page(int pageNumber, String pageLabel) {
 		artifacts = new LinkedList<>();
 	}
 
+	@Override
 	public List<IChunk> getArtifacts() {
 		return artifacts;
 	}
 
+	@Override
 	public int getPageNumber() {
 		return pageNumber;
 	}

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/RepeatedCharacters.java b/src/main/java/org/verapdf/wcag/algorithms/entities/RepeatedCharacters.java
@@ -4,8 +4,8 @@
 
 public class RepeatedCharacters {
 
-	private boolean nonSpace;
-	private Integer numberOfElements;
+	private final boolean nonSpace;
+	private final Integer numberOfElements;
 	private BoundingBox boundingBox;
 
 	public RepeatedCharacters(boolean nonSpace, Integer numberOfElements, BoundingBox boundingBox) {

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/SemanticNode.java b/src/main/java/org/verapdf/wcag/algorithms/entities/SemanticNode.java
@@ -20,7 +20,7 @@ public class SemanticNode extends BaseObject implements INode {
 	private boolean hasLowestDepthError = false;
 	private IAttributesDictionary attributesDictionary;
 
-	public NodeInfo nodeInfo;
+	public final NodeInfo nodeInfo;
 
 	public SemanticNode() {
 		this((SemanticType)null);
@@ -217,7 +217,7 @@ public boolean equals(Object o) {
 		return Objects.equals(objectKeyNumber, that.objectKeyNumber) &&
 				Objects.equals(index, that.index) &&
 				Objects.equals(parent, that.parent) &&
-				Objects.equals(initialSemanticType, that.initialSemanticType) &&
+				initialSemanticType == that.initialSemanticType &&
 				depth == that.depth;
 	}
 

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/SemanticTextNode.java b/src/main/java/org/verapdf/wcag/algorithms/entities/SemanticTextNode.java
@@ -514,7 +514,7 @@ public int hashCode() {
 
     @Override
     public String toString() {
-        if (columns.size() == 0) {
+        if (columns.isEmpty()) {
             return this.getClass().getName() + "{}";
         }
         StringBuilder result = new StringBuilder(this.getClass().getSimpleName());

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/SemanticTree.java b/src/main/java/org/verapdf/wcag/algorithms/entities/SemanticTree.java
@@ -10,10 +10,12 @@ public SemanticTree(INode root) {
 		this.root = root;
 	}
 
+	@Override
 	public INode getRoot() {
 		return root;
 	}
 
+	@Override
 	public Iterator<INode> iterator() {
 		return new DFSTreeNodeIterator(this.getRoot());
 	}

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/content/InfoChunk.java b/src/main/java/org/verapdf/wcag/algorithms/entities/content/InfoChunk.java
@@ -3,8 +3,6 @@
 import org.verapdf.wcag.algorithms.entities.BaseObject;
 import org.verapdf.wcag.algorithms.entities.geometry.BoundingBox;
 
-import java.util.Objects;
-
 public abstract class InfoChunk extends BaseObject implements IChunk {
 
     public InfoChunk() {
@@ -16,11 +14,6 @@ public InfoChunk(BoundingBox bbox) {
         setBoundingBox(bbox);
     }
 
-    @Override
-    public int hashCode() {
-        return Objects.hashCode(getBoundingBox());
-    }
-
     @Override
     public boolean equals(Object o) {
         if (this == o) {

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/content/LineChunk.java b/src/main/java/org/verapdf/wcag/algorithms/entities/content/LineChunk.java
@@ -9,9 +9,9 @@
 
 public class LineChunk extends InfoChunk {
 
-	public static int BUTT_CAP_STYLE = 0;
-	public static int ROUND_CAP_STYLE = 1;
-	public static int PROJECTING_SQUARE_CAP_STYLE = 2;
+	public static final int BUTT_CAP_STYLE = 0;
+	public static final int ROUND_CAP_STYLE = 1;
+	public static final int PROJECTING_SQUARE_CAP_STYLE = 2;
 
 	private final Vertex start;
 	private final Vertex end;
@@ -74,12 +74,14 @@ public boolean isSquare() {
 		return isSquare;
 	}
 
+	@Override
 	public double getWidth() {
 		return width;
 	}
 
 	public static class HorizontalLineComparator implements Comparator<LineChunk> {
 
+		@Override
 		public int compare(LineChunk line1, LineChunk line2){
 			int res = Double.compare(line2.getCenterY(), line1.getCenterY());
 			if (res != 0) {
@@ -91,6 +93,7 @@ public int compare(LineChunk line1, LineChunk line2){
 
 	public static class VerticalLineComparator implements Comparator<LineChunk> {
 
+		@Override
 		public int compare(LineChunk line1, LineChunk line2){
 			int res = Double.compare(line1.getCenterX(), line2.getCenterX());
 			if (res != 0) {

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/content/TextChunk.java b/src/main/java/org/verapdf/wcag/algorithms/entities/content/TextChunk.java
@@ -58,6 +58,7 @@ public TextChunk(TextChunk chunk) {
                 chunk.baseLine, chunk.fontColor, chunk.symbolEnds, chunk.slantDegree);
     }
 
+    @Override
     public String getValue() {
         return value;
     }

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/content/TextColumn.java b/src/main/java/org/verapdf/wcag/algorithms/entities/content/TextColumn.java
@@ -153,7 +153,7 @@ public boolean hasOnlyOneBlock() {
 
 	@Override
 	public String toString() {
-		StringBuilder stringBuilder = new StringBuilder("");
+		StringBuilder stringBuilder = new StringBuilder();
 		for (TextBlock textBlock : textBlocks) {
 			stringBuilder.append(textBlock);
 		}

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/content/TextLine.java b/src/main/java/org/verapdf/wcag/algorithms/entities/content/TextLine.java
@@ -46,7 +46,7 @@ public TextChunk getLastTextChunk() {
     public TextChunk getLastNormalTextChunk() {
         for (int i = textChunks.size() - 2; i >= 0; i--) {
             TextChunk textChunk = textChunks.get(i);
-            if (TextFormat.NORMAL.equals(textChunk.getTextFormat())) {
+            if (TextFormat.NORMAL == textChunk.getTextFormat()) {
                 return textChunk;
             }
         }
@@ -69,6 +69,7 @@ public void add(TextLine line) {
         }
     }
 
+    @Override
     public String getValue() {
         if (textChunks.isEmpty()) {
             return "";

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/geometry/BoundingBox.java b/src/main/java/org/verapdf/wcag/algorithms/entities/geometry/BoundingBox.java
@@ -225,9 +225,7 @@ public boolean weaklyContains(BoundingBox fullRectangle) {
             BoundingBox part = cross(fullRectangle);
             return part != null && part.getArea() >= fullRectangle.getArea() * 0.7;
         }
-        else {
-            return contains(fullRectangle);
-        }
+        return contains(fullRectangle);
     }
 
     public static BoundingBox cross(BoundingBox first, BoundingBox second) {

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/geometry/MultiBoundingBox.java b/src/main/java/org/verapdf/wcag/algorithms/entities/geometry/MultiBoundingBox.java
@@ -143,6 +143,7 @@ public List<BoundingBox> getBoundingBoxes() {
         return boundingBoxes;
     }
 
+    @Override
     public BoundingBox getBoundingBox(int pageNumber) {
         if (this.pageNumber > pageNumber || this.lastPageNumber < pageNumber) {
             return null;
@@ -162,6 +163,7 @@ public BoundingBox getBoundingBox(int pageNumber) {
         return boundingBox;
     }
 
+    @Override
     public Double getRightX(int pageNumber) {
         if (this.pageNumber > pageNumber || this.lastPageNumber < pageNumber) {
             return null;
@@ -179,6 +181,7 @@ public Double getRightX(int pageNumber) {
         return maxRight;
     }
 
+    @Override
     public Double getLeftX(int pageNumber) {
         if (this.pageNumber > pageNumber || this.lastPageNumber < pageNumber) {
             return null;

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/geometry/Vertex.java b/src/main/java/org/verapdf/wcag/algorithms/entities/geometry/Vertex.java
@@ -47,12 +47,14 @@ public static boolean areCloseVertexes(Vertex v1, Vertex v2, double epsilon) {
     }
 
     public static class VertexComparatorX implements Comparator<Vertex> {
+        @Override
         public int compare(Vertex vertex1, Vertex vertex2){
             return Double.compare(vertex1.getLeftX(), vertex2.getLeftX());
         }
     }
 
     public static class VertexComparatorY implements Comparator<Vertex> {
+        @Override
         public int compare(Vertex vertex1, Vertex vertex2){
             return -Double.compare(vertex1.getTopY(), vertex2.getTopY());
         }

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/tables/Table.java b/src/main/java/org/verapdf/wcag/algorithms/entities/tables/Table.java
@@ -176,7 +176,7 @@ private List<TableRow> pickCompactRows(List<TableRow> allRows) {
     }
 
     private void extractRestNodes(List<TableRow> restRows) {
-        Set<INode> nodeSet = new HashSet<INode>();
+        Set<INode> nodeSet = new HashSet<>();
         for (TableRow row : restRows) {
             for (TableCell cell : row.getCells()) {
                 for (TableTokenRow tableTokenRow : cell.getContent()) {

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/tables/TableBorderBuilder.java b/src/main/java/org/verapdf/wcag/algorithms/entities/tables/TableBorderBuilder.java
@@ -11,8 +11,8 @@ public class TableBorderBuilder {
 
     private final BoundingBox boundingBox;
     private final Set<Vertex> vertexes;
-    private final TreeSet<LineChunk> horizontalLines;
-    private final TreeSet<LineChunk> verticalLines;
+    private final SortedSet<LineChunk> horizontalLines;
+    private final SortedSet<LineChunk> verticalLines;
 
     public TableBorderBuilder(LineChunk lineChunk) {
         vertexes = new HashSet<>();
@@ -119,6 +119,7 @@ public BoundingBox getBoundingBox() {
     }
 
     public static class TableBorderBuildersComparator implements Comparator<TableBorderBuilder> {
+        @Override
         public int compare(TableBorderBuilder builder1, TableBorderBuilder builder2){
             int res = Double.compare(builder2.getBoundingBox().getTopY(), builder1.getBoundingBox().getTopY());
             if (res != 0) {

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/tables/TableRow.java b/src/main/java/org/verapdf/wcag/algorithms/entities/tables/TableRow.java
@@ -9,7 +9,7 @@
 
 public class TableRow extends TextInfoChunk {
     private Long id;
-    private List<TableCell> cells;
+    private final List<TableCell> cells;
     private SemanticType semanticType = null;
 
     public TableRow() {

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/tables/tableBorders/TableBorder.java b/src/main/java/org/verapdf/wcag/algorithms/entities/tables/tableBorders/TableBorder.java
@@ -420,6 +420,7 @@ public boolean isBadTable() {
     }
 
     public static class TableBordersComparator implements Comparator<TableBorder> {
+        @Override
         public int compare(TableBorder border1, TableBorder border2) {
             int res = Double.compare(border2.getBoundingBox().getTopY(), border1.getBoundingBox().getTopY());
             if (res != 0) {

diff --git a/src/main/java/org/verapdf/wcag/algorithms/entities/tables/tableBorders/TableBorderRow.java b/src/main/java/org/verapdf/wcag/algorithms/entities/tables/tableBorders/TableBorderRow.java
@@ -6,8 +6,8 @@
 import org.verapdf.wcag.algorithms.entities.geometry.BoundingBox;
 
 public class TableBorderRow extends BaseObject {
-    private int rowNumber;
-    protected TableBorderCell[] cells;
+    private final int rowNumber;
+    protected final TableBorderCell[] cells;
     private SemanticType semanticType;
     private INode node;
 

diff --git a/...n/java/org/verapdf/wcag/algorithms/semanticalgorithms/AccumulatedNodeSemanticChecker.java b/...n/java/org/verapdf/wcag/algorithms/semanticalgorithms/AccumulatedNodeSemanticChecker.java
@@ -6,8 +6,6 @@
 import org.verapdf.wcag.algorithms.semanticalgorithms.consumers.*;
 import org.verapdf.wcag.algorithms.semanticalgorithms.containers.StaticContainers;
 
-import java.util.function.Consumer;
-
 public class AccumulatedNodeSemanticChecker implements ISemanticsChecker {
 
 	@Override

diff --git a/src/main/java/org/verapdf/wcag/algorithms/semanticalgorithms/ContrastRatioChecker.java b/src/main/java/org/verapdf/wcag/algorithms/semanticalgorithms/ContrastRatioChecker.java
@@ -2,9 +2,7 @@
 
 import org.verapdf.wcag.algorithms.entities.IDocument;
 import org.verapdf.wcag.algorithms.entities.INode;
-import org.verapdf.wcag.algorithms.entities.IPage;
 import org.verapdf.wcag.algorithms.entities.ITree;
-import org.verapdf.wcag.algorithms.entities.content.TextChunk;
 import org.verapdf.wcag.algorithms.entities.enums.TextType;
 import org.verapdf.wcag.algorithms.semanticalgorithms.consumers.ContrastRatioConsumer;