Class TextExtractor
- All Implemented Interfaces:
CharStreamSource
The output is ideal for feeding into a text search engine such as Apache Lucene,
especially when the IncludeAttributes
property has been set to true
.
Use one of the following methods to obtain the output:
The process removes all of the tags and
decodes the result, collapsing all white space.
A space character is included in the output where a normal tag is present in the source,
unless the tag belongs to an inline-level element.
An exception to this is the BR
element, which is also converted to a space despite being an inline-level element.
Text inside SCRIPT
and STYLE
elements contained within this segment
is ignored.
Setting the ExcludeNonHTMLElements
property results in the exclusion of any content within a
non-HTML element.
See the excludeElement(StartTag)
method for details on how to implement a more complex mechanism to determine whether the
content of each Element
is to be excluded from the output.
All tags that are not normal tags, such as server tags, comments etc., are removed from the output without adding white space to the output.
Note that segments on which the Segment.ignoreWhenParsing()
method has been called are treated as text rather than markup,
resulting in their inclusion in the output.
To remove specific segments before extracting the text, create an OutputDocument
and call its remove(Segment)
or
replaceWithSpaces(int begin, int end)
method for each segment to be removed.
Then create a new source document using new Source(outputDocument.toString())
and perform the text extraction on this new source object.
Extracting the text from an entire Source
object performs a full sequential parse automatically.
To perform a simple rendering of HTML markup into text, which is more readable than the output of this class, use the Renderer
class instead.
- Example:
- Using the default settings, the source segment:
"<div><b>O</b>ne</div><div title="Two"><b>Th</b><script>//a script </script>ree</div>
"
produces the text "One Two Three
".
-
Constructor Summary
ConstructorsConstructorDescriptionTextExtractor
(Segment segment) Constructs a newTextExtractor
based on the specifiedSegment
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
appendTo
(Appendable appendable) Appends the output to the specifiedAppendable
object.boolean
excludeElement
(StartTag startTag) Indicates whether the text inside theElement
of the specified start tag should be excluded from the output.boolean
Indicates whether non-breaking space (
) character entity references are converted to spaces.long
Returns the estimated maximum number of characters in the output, or-1
if no estimate is available.boolean
Indicates whether the content of non-HTML elements is excluded from the output.boolean
Indicates whether any attribute values are included in the output.boolean
includeAttribute
(StartTag startTag, Attribute attribute) setConvertNonBreakingSpaces
(boolean convertNonBreakingSpaces) Sets whether non-breaking space (
) character entity references are converted to spaces.setExcludeNonHTMLElements
(boolean excludeNonHTMLElements) Sets whether the content of non-HTML elements is excluded from the output.setIncludeAttributes
(boolean includeAttributes) Sets whether any attribute values are included in the output.toString()
Returns the output as a string.void
Writes the output to the specifiedWriter
.
-
Constructor Details
-
TextExtractor
Constructs a newTextExtractor
based on the specifiedSegment
.- Parameters:
segment
- the segment from which the text will be extracted.- See Also:
-
-
Method Details
-
writeTo
Description copied from interface:CharStreamSource
Writes the output to the specifiedWriter
.- Specified by:
writeTo
in interfaceCharStreamSource
- Parameters:
writer
- the destinationjava.io.Writer
for the output.- Throws:
IOException
- if an I/O exception occurs.
-
appendTo
Description copied from interface:CharStreamSource
Appends the output to the specifiedAppendable
object.- Specified by:
appendTo
in interfaceCharStreamSource
- Parameters:
appendable
- the destinationjava.lang.Appendable
object for the output.- Throws:
IOException
- if an I/O exception occurs.
-
getEstimatedMaximumOutputLength
public long getEstimatedMaximumOutputLength()Description copied from interface:CharStreamSource
Returns the estimated maximum number of characters in the output, or-1
if no estimate is available.The returned value should be used as a guide for efficiency purposes only, for example to set an initial
StringBuilder
capacity. There is no guarantee that the length of the output is indeed less than this value, as classes implementing this method often use assumptions based on typical usage to calculate the estimate.Although implementations of this method should never return a value less than -1, users of this method must not assume that this will always be the case. Standard practice is to interpret any negative value as meaning that no estimate is available.
- Specified by:
getEstimatedMaximumOutputLength
in interfaceCharStreamSource
- Returns:
- the estimated maximum number of characters in the output, or
-1
if no estimate is available.
-
toString
Description copied from interface:CharStreamSource
Returns the output as a string.- Specified by:
toString
in interfaceCharStreamSource
- Overrides:
toString
in classObject
- Returns:
- the output as a string.
-
setConvertNonBreakingSpaces
Sets whether non-breaking space (
) character entity references are converted to spaces.The default value is that of the static
Config.ConvertNonBreakingSpaces
property at the time theTextExtractor
is instantiated.- Parameters:
convertNonBreakingSpaces
- specifies whether non-breaking space (
) character entity references are converted to spaces.- Returns:
- this
TextExtractor
instance, allowing multiple property setting methods to be chained in a single statement. - See Also:
-
getConvertNonBreakingSpaces
public boolean getConvertNonBreakingSpaces()Indicates whether non-breaking space (
) character entity references are converted to spaces.See the
setConvertNonBreakingSpaces(boolean)
method for a full description of this property.- Returns:
true
if non-breaking space (
) character entity references are converted to spaces, otherwisefalse
.
-
setIncludeAttributes
Sets whether any attribute values are included in the output.If the value of this property is
true
, then each attribute still has to match the conditions implemented in theincludeAttribute(StartTag,Attribute)
method in order for its value to be included in the output.The default value is
false
.- Parameters:
includeAttributes
- specifies whether any attribute values are included in the output.- Returns:
- this
TextExtractor
instance, allowing multiple property setting methods to be chained in a single statement. - See Also:
-
getIncludeAttributes
public boolean getIncludeAttributes()Indicates whether any attribute values are included in the output.See the
setIncludeAttributes(boolean)
method for a full description of this property.- Returns:
true
if any attribute values are included in the output, otherwisefalse
.
-
includeAttribute
Indicates whether the value of the specified attribute in the specified start tag is included in the output.This method is ignored if the
IncludeAttributes
property is set tofalse
, in which case no attribute values are included in the output.If the
IncludeAttributes
property is set totrue
, every attribute of every start tag encountered in the segment is checked using this method to determine whether the value of the attribute should be included in the output.The default implementation of this method returns
true
if the name of the specified attribute is one of title, alt, label, summary, content*, or href, but the method can be overridden in a subclass to perform a check of arbitrary complexity on each attribute.* The value of a content attribute is only included if a name attribute is also present in the specified start tag, as the content attribute of a
META
tag only contains human readable text if the name attribute is used as opposed to an http-equiv attribute.- Example:
-
To include only the value of title and
alt attributes:
final Set includeAttributeNames=new HashSet(Arrays.asList(new String[] {"title","alt"}));
TextExtractor textExtractor=new TextExtractor(segment) {
public boolean includeAttribute(StartTag startTag, Attribute attribute) {
return includeAttributeNames.contains(attribute.getKey());
}
};
textExtractor.setIncludeAttributes(true);
String extractedText=textExtractor.toString();
- Parameters:
startTag
- the start tag of the element to check for inclusion.- Returns:
if the text inside the Element
of the specified start tag should be excluded from the output, otherwisefalse
.
-
setExcludeNonHTMLElements
Sets whether the content of non-HTML elements is excluded from the output.The default value is
false
, meaning that content from all elements meeting the other criteria is included.- Parameters:
excludeNonHTMLElements
- specifies whether content non-HTML elements is excluded from the output.- Returns:
- this
TextExtractor
instance, allowing multiple property setting methods to be chained in a single statement. - See Also:
-
getExcludeNonHTMLElements
public boolean getExcludeNonHTMLElements()Indicates whether the content of non-HTML elements is excluded from the output.See the
setExcludeNonHTMLElements(boolean)
method for a full description of this property.- Returns:
true
if the content of non-HTML elements is excluded from the output, otherwisefalse
.
-
excludeElement
Indicates whether the text inside theElement
of the specified start tag should be excluded from the output.During the text extraction process, every start tag encountered in the segment is checked using this method to determine whether the text inside its associated element should be excluded from the output.
The default implementation of this method is to always return
false
, so that every element is included, but the method can be overridden in a subclass to perform a check of arbitrary complexity on each start tag.All elements nested inside an excluded element are also implicitly excluded, as are all
SCRIPT
andSTYLE
elements. Such elements are skipped over without calling this method, so there is no way to include them by overriding the method.- Example:
-
To extract the text from a
segment
, excluding any text inside elements with the attributeclass="NotIndexed"
:
TextExtractor textExtractor=new TextExtractor(segment) {
public boolean excludeElement(StartTag startTag) {
return "NotIndexed".equalsIgnoreCase(startTag.getAttributeValue("class"));
}
};
String extractedText=textExtractor.toString();
- Parameters:
startTag
- the start tag of the element to check for inclusion.- Returns:
if the text inside the Element
of the specified start tag should be excluded from the output, otherwisefalse
.
-