de.citec.scie.pdf.structure

Class TextBlock

java.lang.Object

de.citec.scie.pdf.structure.LineSegment

de.citec.scie.pdf.structure.TextBlock

All Implemented Interfaces:

AbstractLineSegment

public class TextBlock
extends LineSegment

This represents a syntatic block of Text, which can be a column on a page, a header or something similar. Formally it is defined as a sequence of paragraphs, where the number of paragraphs might very well be only one.

Author:

Benjamin Paassen - bpaassen(at)techfak.uni-bielefeld.de

Field Summary

Fields

Modifier and Type	Field and Description
ArrayList<Paragraph>	content This is the actual content of the TextBlock.

Fields inherited from class de.citec.scie.pdf.structure.LineSegment

begin, end

Constructor Summary

Constructors

Constructor and Description
TextBlock()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
double	getRelativeFontSize() The font size of this TextBlocks content relative to the page-wide average.
int	hashCode()
String	indexedToString(int currentIdx) Does the same as toString but also inserts the beginning and end index of each objects respective text representation to this objects attributes (which is retrievable by getBegin and getEnd).
void	setRelativeFontSize(double relativeFontSize) The font size of this TextBlocks content relative to the page-wide average.
String	toString() Converts this object to a string by going recursively through the underlying paragraph structure and calling their respective toString methods.
String	toXML() Returns a XML representation of this block by going recursively through the underlying paragraph structure and calling their respective toXML methods.

Methods inherited from class de.citec.scie.pdf.structure.LineSegment

boundariesEqual, boundariesEqual, getBegin, getEnd, intersection, isValid, isValid, length, length, normalize, normalize, normalizedBounds, overlaps, overlaps, setBegin, setEnd, union

Methods inherited from class java.lang.Object

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

Field Detail

content

public final ArrayList<Paragraph> content

This is the actual content of the TextBlock.

Constructor Detail

TextBlock

public TextBlock()

Method Detail

getRelativeFontSize

public double getRelativeFontSize()

The font size of this TextBlocks content relative to the page-wide average.

Returns:

font size of this TextBlocks content relative to the page-wide average.

setRelativeFontSize

public void setRelativeFontSize(double relativeFontSize)

The font size of this TextBlocks content relative to the page-wide average.

Parameters:

relativeFontSize - the font size of this TextBlocks content relative to the page-wide average.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this object to a string by going recursively through the underlying paragraph structure and calling their respective toString methods.

Overrides:

toString in class Object

Returns:

a string showing the plain text content of this TextBlock.

indexedToString

public String indexedToString(int currentIdx)

Does the same as toString but also inserts the beginning and end index of each objects respective text representation to this objects attributes (which is retrievable by getBegin and getEnd).

Parameters:

currentIdx - the current index in the plain text representation. If you are calling this as a user you should insert 0 here.

Returns:

the plainText representation of this TextBlock, same as for the toString method.

toXML

public String toXML()

Returns a XML representation of this block by going recursively through the underlying paragraph structure and calling their respective toXML methods. This also adds the relative font size of this TextBlock as an XML attribute.

Returns:

a string containing a XML representation of this Block.