Class BlockProximityFusion

java.lang.Object

com.kohlschutter.boilerpipe.filters.heuristics.BlockProximityFusion

All Implemented Interfaces:

BoilerpipeFilter

public final class BlockProximityFusion
extends Object
implements BoilerpipeFilter

Fuses adjacent blocks if their distance (in blocks) does not exceed a certain limit. This probably makes sense only in cases where an upstream filter already has removed some blocks.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	contentOnly
static final BlockProximityFusion	MAX_DISTANCE_1
static final BlockProximityFusion	MAX_DISTANCE_1_CONTENT_ONLY
static final BlockProximityFusion	MAX_DISTANCE_1_CONTENT_ONLY_SAME_TAGLEVEL
static final BlockProximityFusion	MAX_DISTANCE_1_SAME_TAGLEVEL
private final int	maxBlocksDistance
private final boolean	sameTagLevelOnly

Constructor Summary

Constructors

Constructor	Description
BlockProximityFusion(int maxBlocksDistance, boolean contentOnly, boolean sameTagLevelOnly)	Creates a new BlockProximityFusion instance.

Method Summary

Modifier and Type	Method	Description
boolean	process(TextDocument doc)	Processes the given document doc.

Methods inherited from class Object

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

Field Details

maxBlocksDistance

private final int maxBlocksDistance

MAX_DISTANCE_1

public static final BlockProximityFusion MAX_DISTANCE_1

MAX_DISTANCE_1_SAME_TAGLEVEL

public static final BlockProximityFusion MAX_DISTANCE_1_SAME_TAGLEVEL

MAX_DISTANCE_1_CONTENT_ONLY

public static final BlockProximityFusion MAX_DISTANCE_1_CONTENT_ONLY

MAX_DISTANCE_1_CONTENT_ONLY_SAME_TAGLEVEL

public static final BlockProximityFusion MAX_DISTANCE_1_CONTENT_ONLY_SAME_TAGLEVEL

contentOnly

private final boolean contentOnly

sameTagLevelOnly

private final boolean sameTagLevelOnly

Constructor Details

BlockProximityFusion

public BlockProximityFusion(int maxBlocksDistance,
 boolean contentOnly,
 boolean sameTagLevelOnly)

Creates a new BlockProximityFusion instance.

Parameters:

maxBlocksDistance - The maximum distance in blocks.

contentOnly -

Method Details

process

public boolean process(TextDocument doc)
                throws BoilerpipeProcessingException

Description copied from interface: BoilerpipeFilter

Processes the given document doc.

Specified by:

process in interface BoilerpipeFilter

Parameters:

doc - The TextDocument that is to be processed.

Returns:

true if changes have been made to the TextDocument.

Throws:

BoilerpipeProcessingException