Package com.norconex.importer.handler.transformer.impl

Class HierarchyTransformer

java.lang.Object

com.norconex.importer.handler.transformer.impl.HierarchyTransformer

All Implemented Interfaces:

Configurable<HierarchyTransformerConfig>, ConfigurableDocHandler<HierarchyTransformerConfig>, DocHandler

public class HierarchyTransformer
extends Object
implements ConfigurableDocHandler<HierarchyTransformerConfig>

Given a separator, split a field string into multiple segments representing each node of a hierarchical branch. This is useful when faceting, to find out how many documents fall under each node of a hierarchy. For example, take this hierarchical string:

   /vegetable/potato/sweet
 

We specify a slash (/) separator and it will produce the following entries in the specified document metadata field:

   /vegetable
   /vegetable/potato
   /vegetable/potato/sweet
 

If no target field is specified (toField) the source field (fromField) will be used to store the resulting values. The same applies to the source and target hierarchy separators (fromSeparator and toSeparator).

You can "keepEmptySegments", as well as specify whether the "fromSeparator" is a regular expression. When using regular expression without a "toSeparator", the text matching the expression is kept as is and thus can be different for each segment.

Storing values in an existing field

If a target field with the same name already exists for a document, values will be added to the end of the existing value list. It is possible to change this default behavior by supplying a PropertySetter.

Can be used both as a pre-parse or post-parse handler.

See Also:

• HierarchyTransformer configuration reference

Field Summary

Fields inherited from interface com.norconex.commons.lang.config.Configurable

PROPERTY

Fields inherited from interface com.norconex.importer.handler.DocHandler

NAME

Constructor Summary

Constructors

Constructor	Description
HierarchyTransformer()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
HierarchyTransformerConfig	getConfiguration()
boolean	handle(DocHandlerContext docCtx)	Perform any operations on a document.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.norconex.importer.handler.DocHandler

close, init

Constructor Details

HierarchyTransformer

public HierarchyTransformer()

Method Details

handle

public boolean handle(DocHandlerContext docCtx)
               throws IOException

Description copied from interface: DocHandler

Perform any operations on a document.

Specified by:

handle in interface DocHandler

Parameters:

docCtx - the document handling context

Returns:

false to stop processing and reject a document or true to proceed to the next configured handler.

Throws:

IOException - An I/O exception of some sort has occurred

getConfiguration

public HierarchyTransformerConfig getConfiguration()

Specified by:

getConfiguration in interface Configurable<HierarchyTransformerConfig>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object