com.ibm.es.ama.zing.common.model.converter

Interface ConverterBase

All Known Subinterfaces:

CustomConverterPlugin

public interface ConverterBase

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConverterBase.ConverterStatus Representing the status of conversion.

Method Summary

Modifier and Type	Method and Description
default boolean	canProcess(CrawlData data) The implementation of this method tests whether or not the given crawl-data can be processed by this converter, typically by examining the value of content-type and url of the crawl-data.
default boolean	canReadMetadataFrom(CrawlData data) The implementation of this method tests whether or not the given crawl-data can be used as metadata during the conversion.
default boolean	forcesDeletion() The implementation of this method defines a flag as to whether or not the deletion is issued for any old document with url that matches by prefix to url of crawl-data that is processed by this converter, before the results of this converter are added to the dataset.
ConverterConfiguration	getConfiguration()
default ConverterConfiguration.GeneralSettings	getGeneralSettings()
default java.util.logging.Logger	logger()
default void	postProcess(CrawlData crawlData, CrawlData.Builder builder) The implementation of this method modifies crawl-data after the conversion.
default boolean	removesMetadata() The implementation of this method defines a flag as to whether or not after the conversion, this converter removes metadata, i.e., crawl-data for which canReadMetadataFrom is true, from the output.

Method Detail

logger

default java.util.logging.Logger logger()

Returns:

logger for this converter object.

getConfiguration

ConverterConfiguration getConfiguration()

Returns:

ConverterConfiguration of this converter, which is set by the converter pipeline framework.

getGeneralSettings

default ConverterConfiguration.GeneralSettings getGeneralSettings()

Returns:

ConverterConfiguration.GeneralSettings section of the converter configuration, which includes information about typeIn, conditional, typeOut, and typeOut.

canProcess

default boolean canProcess(CrawlData data)

The implementation of this method tests whether or not the given crawl-data can be processed by this converter, typically by examining the value of content-type and url of the crawl-data. If getGeneralSettings returns non-null value, the default implementation judges it from typeIn and conditional parameters of given converter configuration. Otherwise it returns false.

Parameters:

data - crawl-data

Returns:

true, if crawl-data should be processed for conversion.

canReadMetadataFrom

default boolean canReadMetadataFrom(CrawlData data)

The implementation of this method tests whether or not the given crawl-data can be used as metadata during the conversion. If getGeneralSettings returns non-null value, the default implementation of this method examines whether or not url of the crawl-data matches typeMeta parameter of given converter configuration. Otherwise it returns null. *

Parameters:

data - crawl-data

Returns:

true, if crawl-data can be used as metadata.

postProcess

default void postProcess(CrawlData crawlData,
                         CrawlData.Builder builder)

The implementation of this method modifies crawl-data after the conversion. If getGeneralSettings returns non-null value, the default implementation sets the value of typeOut of given converter configuration.

Parameters:

crawlData - input crawl-data before conversion

builder - builder for new crawl-data after conversion

removesMetadata

default boolean removesMetadata()

The implementation of this method defines a flag as to whether or not after the conversion, this converter removes metadata, i.e., crawl-data for which canReadMetadataFrom is true, from the output.

Returns:

true, if metadata needs to be removed.

forcesDeletion

default boolean forcesDeletion()

The implementation of this method defines a flag as to whether or not the deletion is issued for any old document with url that matches by prefix to url of crawl-data that is processed by this converter, before the results of this converter are added to the dataset. *

Returns:

true, if the deletion of old documents with matching url should be issued.