public class DOMDeleteTransformer extends AbstractDocumentTransformer
Enables deletion of one or more elements matching a given selector
from a document content. Applies to HTML, XHTML, or XML document.
To deal with DOM elements in metadata fields, use DOMTagger
instead.
This class constructs a DOM tree from the document content. That DOM tree
is loaded entirely into memory. Use this transformer with caution if you know
you'll need to parse huge files. It may be preferable to use
ReplaceTransformer
if this is a concern. Also, to help performance
and avoid re-creating DOM tree before every DOM operations you want to
perform, try to combine multiple extractions in a single instance
of this transformer.
The jsoup parser library is used to load a document content into a DOM tree. Elements are referenced using a CSS or JQuery-like syntax.
Should be used as a pre-parse handler.
By default, this filter is restricted to (applies only to) documents matching
the restrictions returned by
CommonRestrictions.domContentTypes(String)
.
You can specify your own content types if you know they represent a file
with HTML or XML-like markup tags.
When used as a pre-parse handler,
this class attempts to detect the content character
encoding unless the character encoding
was specified using setSourceCharset(String)
.
You can specify which parser to use when reading documents. The default is "html" and will normalize the content as HTML. This is generally a desired behavior, but this can sometimes have your selector fail. If you encounter this problem, try switching to "xml" parser, which does not attempt normalization on the content. The drawback with "xml" is you may not get all HTML-specific selector options to work. If you know you are dealing with XML to begin with, specifying "xml" should be a good option.
<handler
class="com.norconex.importer.handler.transformer.impl.DOMDeleteTransformer"
parser="[html|xml]"
sourceCharset="(character encoding)">
<!-- multiple "restrictTo" tags allowed (only one needs to match) -->
<restrictTo>
<fieldMatcher
method="[basic|csv|wildcard|regex]"
ignoreCase="[false|true]"
ignoreDiacritic="[false|true]"
partial="[false|true]">
(field-matching expression)
</fieldMatcher>
<valueMatcher
method="[basic|csv|wildcard|regex]"
ignoreCase="[false|true]"
ignoreDiacritic="[false|true]"
partial="[false|true]">
(value-matching expression)
</valueMatcher>
</restrictTo>
<!-- multiple "dom" tags allowed -->
<dom
selector="(selector syntax)"/>
</handler>
<handler
class="DOMDeleteTransformer">
<dom
selector="div.firstName"/>
</handler>
Given this HTML snippet...
<div class="firstName">Joe</div> <div class="lastName">Dalton</div>
... the above example will delete "Joe" but keep "Dalton".
DOMTagger
,
DOMPreserveTransformer
Constructor and Description |
---|
DOMDeleteTransformer()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addSelector(String selector) |
boolean |
equals(Object other) |
String |
getParser()
Gets the parser to use when creating the DOM-tree.
|
List<String> |
getSelectors() |
String |
getSourceCharset()
Gets the assumed source character encoding.
|
int |
hashCode() |
protected void |
loadHandlerFromXML(XML xml)
Loads configuration settings specific to the implementing class.
|
protected void |
saveHandlerToXML(XML xml)
Saves configuration settings specific to the implementing class.
|
void |
setParser(String parser)
Sets the parser to use when creating the DOM-tree.
|
void |
setSelectors(List<String> selectors) |
void |
setSourceCharset(String sourceCharset)
Sets the assumed source character encoding.
|
String |
toString() |
protected void |
transformApplicableDocument(HandlerDoc doc,
InputStream document,
OutputStream output,
ParseState parseState) |
transformDocument
addRestriction, addRestriction, addRestrictions, clearRestrictions, detectCharsetIfBlank, getRestrictions, isApplicable, loadFromXML, removeRestriction, removeRestriction, saveToXML
public String getSourceCharset()
public void setSourceCharset(String sourceCharset)
sourceCharset
- character encoding of the source to be transformedpublic String getParser()
html
(default) or xml
.public void setParser(String parser)
parser
- html
or xml
.protected void transformApplicableDocument(HandlerDoc doc, InputStream document, OutputStream output, ParseState parseState) throws ImporterHandlerException
transformApplicableDocument
in class AbstractDocumentTransformer
ImporterHandlerException
public void addSelector(String selector)
protected void loadHandlerFromXML(XML xml)
AbstractImporterHandler
loadHandlerFromXML
in class AbstractImporterHandler
xml
- XML configurationprotected void saveHandlerToXML(XML xml)
AbstractImporterHandler
saveHandlerToXML
in class AbstractImporterHandler
xml
- the XMLpublic boolean equals(Object other)
equals
in class AbstractImporterHandler
public int hashCode()
hashCode
in class AbstractImporterHandler
public String toString()
toString
in class AbstractImporterHandler
Copyright © 2009–2023 Norconex Inc.. All rights reserved.