de.l3s.boilerpipe.document

Class TextBlock

java.lang.Object

de.l3s.boilerpipe.document.TextBlock

All Implemented Interfaces:

Cloneable

public class TextBlock
extends Object
implements Cloneable

Describes a block of text. A block can be an "atomic" text element (i.e., a sequence of text that is not interrupted by any HTML markup) or a compound of such atomic elements.

Author:

Christian Kohlschütter

Field Summary

Fields

Modifier and Type	Field and Description
static TextBlock	EMPTY_END
static TextBlock	EMPTY_START

Constructor Summary

Constructors

Constructor and Description
TextBlock(String text)
TextBlock(String text, BitSet containedTextElements, int numWords, int numWordsInAnchorText, int numWordsInWrappedLines, int numWrappedLines, int offsetBlocks)

Method Summary

Methods

Modifier and Type	Method and Description
void	addLabel(String label) Adds an arbitrary String label to this TextBlock.
void	addLabels(Set<String> l) Adds a set of labels to this TextBlock.
void	addLabels(String... l) Adds a set of labels to this TextBlock.
protected TextBlock	clone()
BitSet	getContainedTextElements() Returns the containedTextElements BitSet, or null.
Set<String>	getLabels() Returns the labels associated to this TextBlock, or null if no such labels exist.
float	getLinkDensity()
int	getNumWords()
int	getNumWordsInAnchorText()
int	getOffsetBlocksEnd()
int	getOffsetBlocksStart()
int	getTagLevel()
String	getText()
float	getTextDensity()
boolean	hasLabel(String label) Checks whether this TextBlock has the given label.
boolean	isContent()
void	mergeNext(TextBlock other)
boolean	removeLabel(String label)
boolean	setIsContent(boolean isContent)
void	setTagLevel(int tagLevel)
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_START

public static final TextBlock EMPTY_START

EMPTY_END

public static final TextBlock EMPTY_END

Constructor Detail

TextBlock

public TextBlock(String text)

TextBlock

public TextBlock(String text,
         BitSet containedTextElements,
         int numWords,
         int numWordsInAnchorText,
         int numWordsInWrappedLines,
         int numWrappedLines,
         int offsetBlocks)

Method Detail

isContent

public boolean isContent()

setIsContent

public boolean setIsContent(boolean isContent)

getText

public String getText()

getNumWords

public int getNumWords()

getNumWordsInAnchorText

public int getNumWordsInAnchorText()

getTextDensity

public float getTextDensity()

getLinkDensity

public float getLinkDensity()

mergeNext

public void mergeNext(TextBlock other)

getOffsetBlocksStart

public int getOffsetBlocksStart()

getOffsetBlocksEnd

public int getOffsetBlocksEnd()

toString

public String toString()

Overrides:

toString in class Object

addLabel

public void addLabel(String label)

Adds an arbitrary String label to this TextBlock.

Parameters:

label - The label

See Also:

DefaultLabels

hasLabel

public boolean hasLabel(String label)

Checks whether this TextBlock has the given label.

Parameters:

label - The label

Returns:

true if this block is marked by the given label.

removeLabel

public boolean removeLabel(String label)

getLabels

public Set<String> getLabels()

Returns the labels associated to this TextBlock, or null if no such labels exist. NOTE: The returned instance is the one used directly in TextBlock. You have full access to the data structure. However it is recommended to use the label-specific methods in TextBlock whenever possible.

Returns:

Returns the set of labels, or null if no labels was added yet.

addLabels

public void addLabels(Set<String> l)

Adds a set of labels to this TextBlock. null-references are silently ignored.

Parameters:

l - The labels to be added.

addLabels

public void addLabels(String... l)

Adds a set of labels to this TextBlock. null-references are silently ignored.

Parameters:

l - The labels to be added.

getContainedTextElements

public BitSet getContainedTextElements()

Returns the containedTextElements BitSet, or null.

Returns:

the containedTextElements BitSet, or null.

clone

protected TextBlock clone()

Overrides:

clone in class Object

getTagLevel

public int getTagLevel()

setTagLevel

public void setTagLevel(int tagLevel)