Apache PDFBox 3.0.4 · org.apache.pdfbox.text.TextPositionComparator

public Class TextPositionComparator

This class is a comparator for TextPosition operators. It handles pages with text in different directions by grouping the text based on direction and sorting in that direction. This allows continuous text in a given direction to be more easily grouped together.

Author

Ben Litchfield

Constructor Summary

Access	Constructor and Description
public	TextPositionComparator()

Method Summary

Modifier and Type	Method and Description
public int	compare(TextPosition the first object to be compared. pos1, TextPosition the second object to be compared. pos2) Implements java.util.Comparator.compare. Compares its two arguments for order.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

TextPositionComparator	back to summary
public TextPositionComparator()

Method Detail

compare back to summary

compare	back to summary
public int compare(TextPosition pos1, TextPosition pos2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters pos1:TextPosition the first object to be compared. pos2:TextPosition the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. Annotations @Override

public int compare(TextPosition pos1, TextPosition pos2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that signum(compare(x, y)) == -signum(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

pos1:TextPosition: the first object to be compared.
pos2:TextPosition: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

Annotations

@Override