com.endeca.portal.dataenrichment
Class EndecaEnrichment

java.lang.Object
  com.endeca.portal.dataenrichment.EndecaEnrichment

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TermsExtractionEnrichment, WhitelistEnrichment

public abstract class EndecaEnrichment
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

protected java.lang.String	collection
protected java.lang.String	inputAttribute
protected java.lang.String	inputAttributeDisplayName
protected java.lang.String	lastRun
protected java.lang.String	locale
protected java.lang.String	name
protected java.lang.String	outputAttrCase
protected java.lang.String	outputAttribute
protected java.lang.String	outputAttributeDisplayName
protected boolean	runnable
protected boolean	running
protected boolean	validInput

Constructor Summary

EndecaEnrichment()

Method Summary

static void	addClearAllBlacklist(EnrichmentPipelineUtil util, com.oracle.endeca.pdi.bindings.cxf.enrichment.config._1.types.Pipeline p, java.lang.String attrKey, java.lang.String locale) Deprecated.
protected boolean	attributeExists(javax.portlet.PortletRequest request, EnrichmentPipelineUtil util, java.lang.String viewKey, java.lang.String attrKey, java.lang.String locale)
void	createPDR(EnrichmentPipelineUtil util, javax.portlet.PortletRequest request, DataSource ds, MDEXState state, java.lang.String viewKey)
java.lang.String	getCollection()
java.lang.String	getInputAttribute()
java.lang.String	getInputAttributeDisplayName()
java.lang.String	getLastRun()
protected java.lang.String	getLastRun(EnrichmentPipelineUtil util)
java.lang.String	getLocale()
java.lang.String	getName()
java.lang.String	getOutputAttrCase()
java.lang.String	getOutputAttribute()
java.lang.String	getOutputAttributeDisplayName()
protected java.lang.String	getParameterValue(com.oracle.endeca.pdi.bindings.cxf.enrichment.config._1.types.PipelineComponent pc, java.lang.String paramGroup, java.lang.String paramName)
boolean	getRunnable()
boolean	getRunning()
static boolean	isTermsExtractionEnrichment(java.lang.String pipelineName)
boolean	isValidInput()
protected ComponentBuilder	makeClearAllBlacklistComponent(EnrichmentPipelineUtil util)
protected ComponentBuilder	makeOutputAttributeCaseComponent() Returns component for changing the case of the output.
abstract com.oracle.endeca.pdi.bindings.cxf.enrichment.config._1.types.Pipeline	makePipeline(javax.portlet.PortletRequest request, EnrichmentPipelineUtil util, boolean update)
protected java.lang.String	retrieveAttributeDisplayName(javax.portlet.PortletRequest request, EnrichmentPipelineUtil util, java.lang.String viewKey, java.lang.String attrKey, java.lang.String locale)
void	setCollection(java.lang.String collection)
void	setInputAttribute(java.lang.String inputAttribute)
void	setInputAttributeDisplayName(java.lang.String inputAttributeDisplayName)
void	setLastRun(java.lang.String lastRun)
void	setLocale(java.lang.String locale)
void	setName(java.lang.String name)
void	setOutputAttrCase(java.lang.String outputAttrCase)
void	setOutputAttribute(java.lang.String outputAttribute)
void	setOutputAttributeDisplayName(java.lang.String outputAttributeDisplayName)
void	setRunnable(boolean runnable)
void	setRunning(boolean running)
void	setValidInput(boolean validInput)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

inputAttribute

protected java.lang.String inputAttribute

inputAttributeDisplayName

protected java.lang.String inputAttributeDisplayName

outputAttribute

protected java.lang.String outputAttribute

outputAttributeDisplayName

protected java.lang.String outputAttributeDisplayName

outputAttrCase

protected java.lang.String outputAttrCase

locale

protected java.lang.String locale

collection

protected java.lang.String collection

name

protected java.lang.String name

validInput

protected boolean validInput

runnable

protected boolean runnable

running

protected boolean running

lastRun

protected java.lang.String lastRun

Constructor Detail

EndecaEnrichment

public EndecaEnrichment()

Method Detail

getInputAttributeDisplayName

public java.lang.String getInputAttributeDisplayName()

setInputAttributeDisplayName

public void setInputAttributeDisplayName(java.lang.String inputAttributeDisplayName)

getInputAttribute

public java.lang.String getInputAttribute()

setInputAttribute

public void setInputAttribute(java.lang.String inputAttribute)

getOutputAttributeDisplayName

public java.lang.String getOutputAttributeDisplayName()

setOutputAttributeDisplayName

public void setOutputAttributeDisplayName(java.lang.String outputAttributeDisplayName)

getOutputAttribute

public java.lang.String getOutputAttribute()

setOutputAttribute

public void setOutputAttribute(java.lang.String outputAttribute)

getLocale

public java.lang.String getLocale()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setLocale

public void setLocale(java.lang.String locale)

getCollection

public java.lang.String getCollection()

setCollection

public void setCollection(java.lang.String collection)

getOutputAttrCase

public java.lang.String getOutputAttrCase()

setOutputAttrCase

public void setOutputAttrCase(java.lang.String outputAttrCase)

isValidInput

public boolean isValidInput()

setValidInput

public void setValidInput(boolean validInput)

getRunnable

public boolean getRunnable()

setRunnable

public void setRunnable(boolean runnable)

getRunning

public boolean getRunning()

setRunning

public void setRunning(boolean running)

getLastRun

public java.lang.String getLastRun()

setLastRun

public void setLastRun(java.lang.String lastRun)

makePipeline

public abstract com.oracle.endeca.pdi.bindings.cxf.enrichment.config._1.types.Pipeline makePipeline(javax.portlet.PortletRequest request,
                                                                                                    EnrichmentPipelineUtil util,
                                                                                                    boolean update)
                                                                                             throws com.oracle.endeca.pdi.bindings.cxf.enrichment.task._1.TaskFault_Exception,
                                                                                                    com.oracle.endeca.pdi.bindings.cxf.enrichment.config._1.ConfigurationFault_Exception,
                                                                                                    java.net.MalformedURLException,
                                                                                                    java.io.UnsupportedEncodingException,
                                                                                                    DataSourceException,
                                                                                                    KeyNotFoundException

Throws:

com.oracle.endeca.pdi.bindings.cxf.enrichment.task._1.TaskFault_Exception

com.oracle.endeca.pdi.bindings.cxf.enrichment.config._1.ConfigurationFault_Exception

java.net.MalformedURLException

java.io.UnsupportedEncodingException

DataSourceException

KeyNotFoundException

makeOutputAttributeCaseComponent

protected ComponentBuilder makeOutputAttributeCaseComponent()

Returns component for changing the case of the output. Returns null if no case change requested.

makeClearAllBlacklistComponent

protected ComponentBuilder makeClearAllBlacklistComponent(EnrichmentPipelineUtil util)
                                                   throws com.oracle.endeca.pdi.bindings.cxf.enrichment.config._1.ConfigurationFault_Exception,
                                                          java.net.MalformedURLException,
                                                          java.io.UnsupportedEncodingException

Throws:

com.oracle.endeca.pdi.bindings.cxf.enrichment.config._1.ConfigurationFault_Exception

java.net.MalformedURLException

java.io.UnsupportedEncodingException

isTermsExtractionEnrichment

public static boolean isTermsExtractionEnrichment(java.lang.String pipelineName)

createPDR

public void createPDR(EnrichmentPipelineUtil util,
                      javax.portlet.PortletRequest request,
                      DataSource ds,
                      MDEXState state,
                      java.lang.String viewKey)
               throws DataSourceException,
                      KeyNotFoundException,
                      java.lang.ClassNotFoundException,
                      java.lang.InstantiationException,
                      java.lang.IllegalAccessException

Throws:

DataSourceException

KeyNotFoundException

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

attributeExists

protected boolean attributeExists(javax.portlet.PortletRequest request,
                                  EnrichmentPipelineUtil util,
                                  java.lang.String viewKey,
                                  java.lang.String attrKey,
                                  java.lang.String locale)
                           throws DataSourceException,
                                  KeyNotFoundException

Throws:

DataSourceException

KeyNotFoundException

retrieveAttributeDisplayName

protected java.lang.String retrieveAttributeDisplayName(javax.portlet.PortletRequest request,
                                                        EnrichmentPipelineUtil util,
                                                        java.lang.String viewKey,
                                                        java.lang.String attrKey,
                                                        java.lang.String locale)
                                                 throws DataSourceException,
                                                        KeyNotFoundException

Throws:

DataSourceException

KeyNotFoundException

getParameterValue

protected java.lang.String getParameterValue(com.oracle.endeca.pdi.bindings.cxf.enrichment.config._1.types.PipelineComponent pc,
                                             java.lang.String paramGroup,
                                             java.lang.String paramName)

getLastRun

protected java.lang.String getLastRun(EnrichmentPipelineUtil util)
                               throws com.oracle.endeca.pdi.bindings.cxf.enrichment.task._1.TaskFault_Exception

Throws:

com.oracle.endeca.pdi.bindings.cxf.enrichment.task._1.TaskFault_Exception

addClearAllBlacklist

public static void addClearAllBlacklist(EnrichmentPipelineUtil util,
                                        com.oracle.endeca.pdi.bindings.cxf.enrichment.config._1.types.Pipeline p,
                                        java.lang.String attrKey,
                                        java.lang.String locale)
                                 throws com.oracle.endeca.pdi.bindings.cxf.enrichment.config._1.ConfigurationFault_Exception,
                                        java.net.MalformedURLException,
                                        java.io.UnsupportedEncodingException

Deprecated.

TODO: There was an issue with update that the component wasn't created correctly, thus this method is not used. We'll want to use this method, or some variation of it, in 3.2.

Throws:

com.oracle.endeca.pdi.bindings.cxf.enrichment.config._1.ConfigurationFault_Exception

java.net.MalformedURLException

java.io.UnsupportedEncodingException