com.dkfqs.tools.text

Class SimplePatternAnchorValueExtractor

java.lang.Object

com.dkfqs.tools.text.SimplePatternAnchorValueExtractor

public class SimplePatternAnchorValueExtractor
extends java.lang.Object

Find first an anchor pattern in a content, and then, starting from the anchor pattern, extract all values which are enclosed by a left side pattern and a right pattern.
This algorithm works as follows:

1. Find first an anchor pattern in the content, by searching from the start to the end of the content.
2. Find next the left side pattern by searching form the anchor pattern to the end of the content.
3. Find then the right side pattern by searching form the found left side pattern to the end of the content.
4. Extract the value between the left side pattern and the right side pattern.
5. Repeat the steps 2..5 from the last found right side pattern until the end of the content has reached.

Constructor Summary

Constructors

Constructor and Description
SimplePatternAnchorValueExtractor(java.lang.String content, java.lang.String anchorPattern, java.lang.String leftSidePattern, java.lang.String rightSidePattern) Create a new instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getExtractedValues() Get an array of the extracted values.
void	setSearchPerLine(boolean searchPerLine) Set if the values are searched per line (default: true).
void	setSearchReverse(boolean searchReverse) Set if the extract algorithm works in reverse order (default: false).
void	setTrimExtractedValues(boolean trimExtractedValues) Set if leading and trailing whitespace are removed from the extracted values (default = false).

Methods inherited from class java.lang.Object

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

Constructor Detail

SimplePatternAnchorValueExtractor

public SimplePatternAnchorValueExtractor(java.lang.String content,
                                         java.lang.String anchorPattern,
                                         java.lang.String leftSidePattern,
                                         java.lang.String rightSidePattern)

Create a new instance.

Parameters:

content - the content from which the values are extracted

anchorPattern - the anchor pattern

leftSidePattern - the pattern for the left side

rightSidePattern - the pattern for the right side

Method Detail

setSearchReverse

public void setSearchReverse(boolean searchReverse)

Set if the extract algorithm works in reverse order (default: false). Reverse order means:

1. Find first an anchor pattern in the content, by searching from the end to the start of the content.
2. Find next the right side pattern by searching form the anchor pattern to the start of the content.
3. Find then the left side pattern by searching form the found right side pattern to the start of the content.
4. Extract the value between the left side pattern and the right side pattern.
5. Repeat the steps 2..5 from the last found left side pattern until the start of the content has reached.

Parameters:

searchReverse - true = the extract algorithm works in reverse order

setSearchPerLine

public void setSearchPerLine(boolean searchPerLine)

Set if the values are searched per line (default: true).
Hint: In case you expect that the extracted values contain line break and/or carriage return chars then you should set this option to false.

Parameters:

searchPerLine - true = the values are searched per line, false = the values are searched over multiple lines

setTrimExtractedValues

public void setTrimExtractedValues(boolean trimExtractedValues)

Set if leading and trailing whitespace are removed from the extracted values (default = false).

Parameters:

trimExtractedValues - true = trailing whitespace are removed from the extracted values

getExtractedValues

public java.lang.String[] getExtractedValues()

Get an array of the extracted values.

Returns:

an array of the extracted values, or null if the anchor pattern was not found in the content