com.endeca.itl.cas.api

Class ManipulatorConfig

java.lang.Object

com.endeca.itl.cas.api.ModuleConfig

com.endeca.itl.cas.api.ManipulatorConfig

public class ManipulatorConfig
extends ModuleConfig

Manipulator config allows a client to specify a custom manipulation step which is performed in a particular crawl run.

Field Summary

Fields inherited from class com.endeca.itl.cas.api.ModuleConfig

mModuleId, mModuleProperties

Constructor Summary

Constructors

Constructor and Description
ManipulatorConfig()
ManipulatorConfig(ModuleId manipulatorModuleId)
ManipulatorConfig(ModuleId manipulatorModuleId, String id)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other) Compares the list of module properties as a set.
String	getId() Unique ID within a crawl/pipeline
int	hashCode()
Boolean	isEnabled() If a manipulator is not enabled, it will not be added to the pipeline
void	setEnabled(Boolean value) If a manipulator is not enabled, it will not be added to the pipeline
void	setId(String value) Unique ID within a crawl/pipeline
String	toString()

Methods inherited from class com.endeca.itl.cas.api.ModuleConfig

addModuleProperty, getModuleId, getModuleProperties, getProperty, getPropertyValues, getSingletonPropertyValue, getSingletonPropertyValue, getSingletonPropertyValueAsBoolean, getSingletonPropertyValueAsBoolean, getSingletonPropertyValueAsInteger, getSingletonPropertyValueAsInteger, hasProperty, hasPropertyValue, setModuleId, setModuleProperties, setModulePropertyValues

Methods inherited from class java.lang.Object

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

Constructor Detail

ManipulatorConfig

public ManipulatorConfig()

ManipulatorConfig

public ManipulatorConfig(ModuleId manipulatorModuleId)

ManipulatorConfig

public ManipulatorConfig(ModuleId manipulatorModuleId,
                 String id)

Method Detail

getId

public String getId()

Unique ID within a crawl/pipeline

Returns:

ID of manipulator within pipeline

setId

public void setId(String value)

Unique ID within a crawl/pipeline

isEnabled

public Boolean isEnabled()

If a manipulator is not enabled, it will not be added to the pipeline

Returns:

true if manipulator is enabled

setEnabled

public void setEnabled(Boolean value)

If a manipulator is not enabled, it will not be added to the pipeline

equals

public boolean equals(Object other)

Description copied from class: ModuleConfig

Compares the list of module properties as a set.

Overrides:

equals in class ModuleConfig

hashCode

public int hashCode()

Overrides:

hashCode in class ModuleConfig

toString

public String toString()

Overrides:

toString in class ModuleConfig