[patch] patch (generated with git format-patch against trunk)

0001-Bug-57552-sort-order-causes-mismatch-when-finding-im.patch (text/plain), 9.68 KB, created by mark.o on 2015-03-15 16:48:30 UTC

(hide)

Description: patch (generated with git format-patch against trunk)

Filename:

MIME Type:

Creator: mark.o

Created: 2015-03-15 16:48:30 UTC

Size: 9.68 KB

patch

obsolete

>From 9767fc69ff5b0282b4f0efb06e81e4f03d0746e7 Mon Sep 17 00:00:00 2001 >From: Mark Olesen <Mark.Olesen@faurecia.com> >Date: Sun, 15 Mar 2015 17:17:11 +0100 >Subject: [PATCH] Bug 57552: sort-order causes mismatch when finding images > >- introduce and use a natural sort order for PackagePartName. > >- the normal sorting order used from PackagePart is that of its > PackagePartName. > >- sort OPCPackage results by their PackagePartName for overall > consistency >--- > .../org/apache/poi/openxml4j/opc/OPCPackage.java | 20 ++- > .../org/apache/poi/openxml4j/opc/PackagePart.java | 15 ++- > .../apache/poi/openxml4j/opc/PackagePartName.java | 137 ++++++++++++++++++--- > 3 files changed, 152 insertions(+), 20 deletions(-) > >diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java >index 9dbdddd..9a4d303 100644 >--- a/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java >+++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java >@@ -581,6 +581,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { > if (part.getContentType().equals(contentType)) > retArr.add(part); > } >+ java.util.Collections.sort(retArr); > return retArr; > } > >@@ -604,22 +605,31 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { > retArr.add(part); > } > } >+ java.util.Collections.sort(retArr); > return retArr; > } > >+ /** >+ * Retrieve parts by name >+ * >+ * @param namePattern >+ * The pattern for matching the names >+ * @return All parts associated to the specified content type, sorted >+ * in alphanumerically by the part-name >+ */ > public List<PackagePart> getPartsByName(final Pattern namePattern) { > if (namePattern == null) { > throw new IllegalArgumentException("name pattern must not be null"); > } >+ Matcher matcher = namePattern.matcher(""); > ArrayList<PackagePart> result = new ArrayList<PackagePart>(); > for (PackagePart part : partList.values()) { > PackagePartName partName = part.getPartName(); >- String name = partName.getName(); >- Matcher matcher = namePattern.matcher(name); >- if (matcher.matches()) { >+ if (matcher.reset(partName.getName()).matches()) { > result.add(part); > } > } >+ java.util.Collections.sort(result); > return result; > } > >@@ -727,7 +737,9 @@ public abstract class OPCPackage implements RelationshipSource, Closeable { > } > } > } >- return new ArrayList<PackagePart>(partList.values()); >+ ArrayList<PackagePart> result = new ArrayList<PackagePart>(partList.values()); >+ java.util.Collections.sort(result); >+ return result; > } > > /** >diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePart.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePart.java >index 8cfdb0f..15ee41d 100644 >--- a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePart.java >+++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePart.java >@@ -34,7 +34,7 @@ import org.apache.poi.openxml4j.opc.internal.ContentType; > * @author Julien Chable > * @version 0.9 > */ >-public abstract class PackagePart implements RelationshipSource { >+public abstract class PackagePart implements RelationshipSource, Comparable<PackagePart> { > > /** > * This part's container. >@@ -650,6 +650,19 @@ public abstract class PackagePart implements RelationshipSource { > + this._contentType.toString(); > } > >+ /** >+ * Compare based on the package part name, using a natural sort order >+ */ >+ @Override >+ public int compareTo(PackagePart other) >+ { >+ // NOTE could also throw a NullPointerException() if desired >+ if (other == null) >+ return -1; >+ >+ return PackagePartName.compare(this._partName, other._partName); >+ } >+ > /*-------------- Abstract methods ------------- */ > > /** >diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java >index 6f946a2..9ac6941 100644 >--- a/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java >+++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/PackagePartName.java >@@ -17,6 +17,7 @@ > > package org.apache.poi.openxml4j.opc; > >+import java.math.BigInteger; > import java.net.URI; > import java.net.URISyntaxException; > >@@ -428,19 +429,20 @@ public final class PackagePartName implements Comparable<PackagePartName> { > } > > /** >- * Compare two part name following the rule M1.12 : >+ * Compare two part names following the rule M1.12 : > * > * Part name equivalence is determined by comparing part names as > * case-insensitive ASCII strings. Packages shall not contain equivalent > * part names and package implementers shall neither create nor recognize > * packages with equivalent part names. [M1.12] > */ >- public int compareTo(PackagePartName otherPartName) { >- if (otherPartName == null) >- return -1; >- return this.partNameURI.toASCIIString().toLowerCase().compareTo( >- otherPartName.partNameURI.toASCIIString().toLowerCase()); >- } >+ @Override >+ public int compareTo(PackagePartName other) >+ { >+ // compare with natural sort order >+ return compare(this, other); >+ } >+ > > /** > * Retrieves the extension of the part name if any. If there is no extension >@@ -474,14 +476,17 @@ public final class PackagePartName implements Comparable<PackagePartName> { > * packages with equivalent part names. [M1.12] > */ > @Override >- public boolean equals(Object otherPartName) { >- if (otherPartName == null >- || !(otherPartName instanceof PackagePartName)) >- return false; >- return this.partNameURI.toASCIIString().toLowerCase().equals( >- ((PackagePartName) otherPartName).partNameURI.toASCIIString() >- .toLowerCase()); >- } >+ public boolean equals(Object other) { >+ if (other instanceof PackagePartName) { >+ // String.equals() is compatible with our compareTo(), but cheaper >+ return this.partNameURI.toASCIIString().toLowerCase().equals >+ ( >+ ((PackagePartName) other).partNameURI.toASCIIString().toLowerCase() >+ ); >+ } else { >+ return false; >+ } >+ } > > @Override > public int hashCode() { >@@ -503,4 +508,106 @@ public final class PackagePartName implements Comparable<PackagePartName> { > public URI getURI() { > return this.partNameURI; > } >+ >+ >+ /** >+ * A natural sort order for package part names, consistent with the >+ * requirements of {@code java.util.Comparator}, but simply implemented >+ * as a static method. >+ * <p> >+ * For example, this sorts "file10.png" after "file2.png" (comparing the >+ * numerical portion), but sorts "File10.png" before "file2.png" >+ * (lexigraphical sort) >+ * >+ * <p> >+ * When comparing part names, the rule M1.12 is followed: >+ * >+ * Part name equivalence is determined by comparing part names as >+ * case-insensitive ASCII strings. Packages shall not contain equivalent >+ * part names and package implementers shall neither create nor recognize >+ * packages with equivalent part names. [M1.12] >+ */ >+ public static int compare(PackagePartName obj1, PackagePartName obj2) >+ { >+ // NOTE could also throw a NullPointerException() if desired >+ if (obj1 == null) >+ { >+ // (null) == (null), (null) < (non-null) >+ return (obj2 == null ? 0 : -1); >+ } >+ else if (obj2 == null) >+ { >+ // (non-null) > (null) >+ return 1; >+ } >+ >+ return compare >+ ( >+ obj1.getURI().toASCIIString().toLowerCase(), >+ obj2.getURI().toASCIIString().toLowerCase() >+ ); >+ } >+ >+ >+ /** >+ * A natural sort order for strings, consistent with the >+ * requirements of {@code java.util.Comparator}, but simply implemented >+ * as a static method. >+ * <p> >+ * For example, this sorts "file10.png" after "file2.png" (comparing the >+ * numerical portion), but sorts "File10.png" before "file2.png" >+ * (lexigraphical sort) >+ */ >+ public static int compare(String str1, String str2) >+ { >+ if (str1 == null) >+ { >+ // (null) == (null), (null) < (non-null) >+ return (str2 == null ? 0 : -1); >+ } >+ else if (str2 == null) >+ { >+ // (non-null) > (null) >+ return 1; >+ } >+ >+ int len1 = str1.length(); >+ int len2 = str2.length(); >+ for (int idx1 = 0, idx2 = 0; idx1 < len1 && idx2 < len2; /*nil*/) >+ { >+ char c1 = str1.charAt(idx1++); >+ char c2 = str2.charAt(idx2++); >+ >+ if (Character.isDigit(c1) && Character.isDigit(c2)) >+ { >+ int beg1 = idx1 - 1; // undo previous increment >+ while (idx1 < len1 && Character.isDigit(str1.charAt(idx1))) >+ { >+ ++idx1; >+ } >+ >+ int beg2 = idx2 - 1; // undo previous increment >+ while (idx2 < len2 && Character.isDigit(str2.charAt(idx2))) >+ { >+ ++idx2; >+ } >+ >+ // note: BigInteger for extra safety >+ int cmp = new BigInteger(str1.substring(beg1, idx1)).compareTo >+ ( >+ new BigInteger(str2.substring(beg2, idx2)) >+ ); >+ if (cmp != 0) return cmp; >+ } >+ else if (c1 != c2) >+ { >+ return (c1 - c2); >+ } >+ } >+ >+ return (len1 - len2); >+ } >+ > } >+ >+/* ************************************************************************** */ >-- >2.1.4 > View Attachment As Diff View Attachment As Raw

This is ASF Bugzilla: the Apache Software Foundation bug system. In case of problems with the functioning of ASF Bugzilla, please contact bugzilla-admin@apache.org. Please Note: this e-mail address is only for reporting problems with ASF Bugzilla. Mail about any other subject will be silently ignored.

• • Home
  • | New
  • | Browse
  • | Search
  • |
    [?]
  • | Reports
  • | Help
  • | New Account
  • | Log In
    Remember [x]
  • | Forgot Password
    Login: [x]