com.norconex.importer.handler.transformer.impl

Class NoContentTransformer

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.transformer.AbstractDocumentTransformer

com.norconex.importer.handler.transformer.impl.NoContentTransformer

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTransformer

public class NoContentTransformer
extends AbstractDocumentTransformer
implements IXMLConfigurable

Get rid of the content stream and optionally store it as text into a metadata field instead.

Storing content in an existing field

If a toField with the same name already exists for a document, the value will be added to the end of the existing value list.

This class can be used both as a pre-parsing or post-parsing handler. To store the content in a field, make sure pre-parsing is of a text content-types.

XML configuration usage:

  <transformer class="com.norconex.importer.handler.transformer.impl.NoContentTransformer"
      toField="(Optionally store content into a field.)">

      <restrictTo caseSensitive="[false|true]"
              field="(name of header/metadata field name to match)">
          (regular expression of value to match)
      </restrictTo>
      <!-- multiple "restrictTo" tags allowed (only one needs to match) -->
  </transformer>
 

Usage example:

  <transformer class="com.norconex.importer.handler.transformer.impl.NoContentTransformer"/>
 

The above example removes the content of all documents (leaving you with metadata only).

Since:

2.11.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
NoContentTransformer()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getToField()
int	hashCode()
protected void	loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
protected void	saveHandlerToXML(EnhancedXMLStreamWriter writer) Saves configuration settings specific to the implementing class.
void	setToField(String toField)
String	toString()
protected void	transformApplicableDocument(String reference, InputStream input, OutputStream output, ImporterMetadata metadata, boolean parsed)

Methods inherited from class com.norconex.importer.handler.transformer.AbstractDocumentTransformer

transformDocument

Methods inherited from class com.norconex.importer.handler.AbstractImporterHandler

addRestriction, addRestriction, addRestrictions, clearRestrictions, detectCharsetIfBlank, getRestrictions, isApplicable, loadFromXML, removeRestriction, removeRestriction, saveToXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.norconex.commons.lang.config.IXMLConfigurable

loadFromXML, saveToXML

Constructor Detail

NoContentTransformer

public NoContentTransformer()

Method Detail

getToField

public String getToField()

setToField

public void setToField(String toField)

transformApplicableDocument

protected void transformApplicableDocument(String reference,
                                           InputStream input,
                                           OutputStream output,
                                           ImporterMetadata metadata,
                                           boolean parsed)
                                    throws ImporterHandlerException

Specified by:

transformApplicableDocument in class AbstractDocumentTransformer

Throws:

ImporterHandlerException

loadHandlerFromXML

protected void loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration xml)
                           throws IOException

Description copied from class: AbstractImporterHandler

Loads configuration settings specific to the implementing class.

Specified by:

loadHandlerFromXML in class AbstractImporterHandler

Parameters:

xml - xml configuration

Throws:

IOException - could not load from XML

saveHandlerToXML

protected void saveHandlerToXML(EnhancedXMLStreamWriter writer)
                         throws XMLStreamException

Description copied from class: AbstractImporterHandler

Saves configuration settings specific to the implementing class. The parent tag along with the "class" attribute are already written. Implementors must not close the writer.

Specified by:

saveHandlerToXML in class AbstractImporterHandler

Parameters:

writer - the xml writer

Throws:

XMLStreamException - could not save to XML

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractImporterHandler

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractImporterHandler

toString

public String toString()

Overrides:

toString in class AbstractImporterHandler