Package technology.tabula

Class TextChunk

java.lang.Object

java.awt.geom.RectangularShape

java.awt.geom.Rectangle2D

java.awt.geom.Rectangle2D.Float

technology.tabula.Rectangle

technology.tabula.RectangularTextContainer<TextElement>

technology.tabula.TextChunk

All Implemented Interfaces:

Shape, Serializable, Cloneable, HasText

public class TextChunk
extends RectangularTextContainer<TextElement>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.geom.Rectangle2D

Rectangle2D.Double, Rectangle2D.Float

Field Summary

Fields

Modifier and Type	Field	Description
static TextChunk	EMPTY

Fields inherited from class technology.tabula.RectangularTextContainer

textElements

Fields inherited from class technology.tabula.Rectangle

ILL_DEFINED_ORDER, VERTICAL_COMPARISON_THRESHOLD

Fields inherited from class java.awt.geom.Rectangle2D.Float

height, width, x, y

Fields inherited from class java.awt.geom.Rectangle2D

OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP

Constructor Summary

Constructors

Constructor	Description
TextChunk(float top, float left, float width, float height)
TextChunk(List<TextElement> textElements)
TextChunk(TextElement textElement)

Method Summary

Modifier and Type	Method	Description
void	add(List<TextElement> elements)
void	add(TextElement textElement)
static boolean	allSameChar(List<TextChunk> textChunks)
boolean	equals(Object obj)
String	getText()
String	getText(boolean useLineReturns)
TextChunk	groupByDirectionality(Boolean isLtrDominant)	Splits a TextChunk into N TextChunks, where each chunk is of a single directionality, and then reverse the RTL ones.
static List<Line>	groupByLines(List<TextChunk> textChunks)
int	hashCode()
int	isLtrDominant()
boolean	isSameChar(Character c)	Returns true if text contained in this TextChunk is the same repeated character
boolean	isSameChar(Character[] c)
TextChunk	merge(TextChunk other)
TextChunk[]	splitAt(int i)	Splits a TextChunk in two, at the position of the i-th TextElement
List<TextChunk>	squeeze(Character c, int minRunLength)	Removes runs of identical TextElements in this TextChunk For example, if the TextChunk contains this string of characters: "1234xxxxx56xx" and c == 'x' and minRunLength == 4, this method will return a list of TextChunk such that: ["1234", "56xx"]

Methods inherited from class technology.tabula.RectangularTextContainer

getTextElements, merge, setTextElements, toString

Methods inherited from class technology.tabula.Rectangle

boundingBoxOf, compareTo, getArea, getBottom, getLeft, getPoints, getRight, getTop, horizontallyOverlaps, horizontalOverlap, merge, overlapRatio, setBottom, setLeft, setRight, setTop, verticallyOverlaps, verticalOverlap, verticalOverlapRatio

Methods inherited from class java.awt.geom.Rectangle2D.Float

createIntersection, createUnion, getBounds2D, getHeight, getWidth, getX, getY, isEmpty, outcode, setRect, setRect, setRect

Methods inherited from class java.awt.geom.Rectangle2D

add, add, add, contains, contains, getPathIterator, getPathIterator, intersect, intersects, intersectsLine, intersectsLine, outcode, setFrame, union

Methods inherited from class java.awt.geom.RectangularShape

clone, contains, contains, getBounds, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY

public static final TextChunk EMPTY

Constructor Details

TextChunk

public TextChunk(float top, float left, float width, float height)

TextChunk

public TextChunk(TextElement textElement)

TextChunk

public TextChunk(List<TextElement> textElements)

Method Details

groupByDirectionality

public TextChunk groupByDirectionality(Boolean isLtrDominant)

Splits a TextChunk into N TextChunks, where each chunk is of a single directionality, and then reverse the RTL ones. what we're doing here is *reversing* the Unicode bidi algorithm in the language of that algorithm, each chunk is a (maximal) directional run. We attach whitespace to the beginning of non-RTL

isLtrDominant

public int isLtrDominant()

Overrides:

isLtrDominant in class Rectangle

merge

public TextChunk merge(TextChunk other)

add

public void add(TextElement textElement)

add

public void add(List<TextElement> elements)

getText

public String getText()

Specified by:

getText in interface HasText

Overrides:

getText in class RectangularTextContainer<TextElement>

getText

public String getText(boolean useLineReturns)

Specified by:

getText in interface HasText

Overrides:

getText in class RectangularTextContainer<TextElement>

isSameChar

public boolean isSameChar(Character c)

Returns true if text contained in this TextChunk is the same repeated character

isSameChar

public boolean isSameChar(Character[] c)

splitAt

public TextChunk[] splitAt(int i)

Splits a TextChunk in two, at the position of the i-th TextElement

squeeze

public List<TextChunk> squeeze(Character c, int minRunLength)

Removes runs of identical TextElements in this TextChunk For example, if the TextChunk contains this string of characters: "1234xxxxx56xx" and c == 'x' and minRunLength == 4, this method will return a list of TextChunk such that: ["1234", "56xx"]

hashCode

public int hashCode()

Overrides:

hashCode in class Rectangle2D

equals

public boolean equals(Object obj)

Overrides:

equals in class Rectangle2D

allSameChar

public static boolean allSameChar(List<TextChunk> textChunks)

groupByLines

public static List<Line> groupByLines(List<TextChunk> textChunks)