eu.dnetlib.msro.workflows.nodes.validation

Class ValidatorServiceBlackboardJobNode

java.lang.Object

com.googlecode.sarasvati.mem.MemNode

eu.dnetlib.msro.workflows.nodes.SarasvatiJobNode

eu.dnetlib.msro.workflows.nodes.BlackboardJobNode

eu.dnetlib.msro.workflows.nodes.validation.ValidatorServiceBlackboardJobNode

All Implemented Interfaces:

com.googlecode.sarasvati.adapter.Adaptable, com.googlecode.sarasvati.Node, eu.dnetlib.msro.workflows.nodes.ProgressJobNode, eu.dnetlib.msro.workflows.util.ProgressProvider, Cloneable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class ValidatorServiceBlackboardJobNode
extends eu.dnetlib.msro.workflows.nodes.BlackboardJobNode
implements eu.dnetlib.msro.workflows.nodes.ProgressJobNode, eu.dnetlib.msro.workflows.util.ProgressProvider

This node send the BB message to the ValidatorService to validate records from an mdstore.

See ticket https://issue.openaire.research-infrastructures.eu/issues/538 for specs.

Author:

andrea.mannocci, alessia

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	log
static String	VALIDATE_ACTION
static String	VALIDATION_TYPE
static String	VALIDATOR_EPR_PARAM_NAME

Fields inherited from class com.googlecode.sarasvati.mem.MemNode

definingGraph, external, externalEnv, graph, guard, id, idGenerator, isStart, joinParam, joinType, name, originatingExternalNode, type

Constructor Summary

Constructors

Constructor and Description
ValidatorServiceBlackboardJobNode()

Method Summary

Modifier and Type	Method and Description
protected eu.dnetlib.msro.workflows.nodes.blackboard.BlackboardWorkflowJobListener	generateBlackboardListener(com.googlecode.sarasvati.Engine engine, com.googlecode.sarasvati.NodeToken token) Parameters in the VALIDATE BB job response: //only if isShouldOutputRecords() == true
String	getBlacklistRuleName()
int	getCurrentlyValidated()
String	getCurrentlyValidatedParam()
int	getCurrentValue()
String	getExtra_param()
String	getExtraParams()
String	getGuidelines()
int	getJobStatusUpdateInterval()
String	getMdstoreId()
String	getOutputEprName()
eu.dnetlib.msro.workflows.util.ProgressProvider	getProgressProvider()
String	getRecordsSampleSize()
int	getTotalValue()
int	getWorkers()
String	getxQueryForValidatorServiceId()
boolean	isInaccurate()
boolean	isShouldOutputRecords()
boolean	isShouldUpdateBlacklist()
protected String	obtainServiceId(com.googlecode.sarasvati.NodeToken token)
protected void	prepareJob(eu.dnetlib.enabling.tools.blackboard.BlackboardJob job, com.googlecode.sarasvati.NodeToken token) Parameters to set for the VALIDATE BB job: //values: openaire3.0, openaire2.0, openaire2.0_data, driver //OPTIONAL //enables the feature to keep blacklisted records.
void	setBlacklistRuleName(String blacklistRuleName)
void	setCurrentlyValidated(int currentlyValidated)
void	setCurrentlyValidatedParam(String currentlyValidatedParam)
void	setExtra_param(String extra_param)
void	setExtraParams(String extraParams)
void	setGuidelines(String guidelines)
void	setJobStatusUpdateInterval(int jobStatusUpdateInterval)
void	setMdstoreId(String mdstoreId)
void	setOutputEprName(String outputEprName)
void	setRecordsSampleSize(String recordsSampleSize)
void	setShouldOutputRecords(boolean shouldOutputRecords)
void	setShouldUpdateBlacklist(boolean shouldUpdateBlacklist)
void	setWorkers(int workers)
void	setxQueryForValidatorServiceId(String xQueryForValidatorServiceId)

Methods inherited from class eu.dnetlib.msro.workflows.nodes.BlackboardJobNode

execute, getServiceLocator

Methods inherited from class eu.dnetlib.msro.workflows.nodes.SarasvatiJobNode

getBeanName, getEnvParams, getParams, getPropertyFetcher, getSysParams, parseJsonParameters, setBeanName, setEnvParams, setParams, setSysParams

Methods inherited from class com.googlecode.sarasvati.mem.MemNode

backtrack, clone, getAdaptor, getDefiningGraph, getExternal, getExternalEnv, getGraph, getGuard, getId, getJoinParam, getJoinStrategy, getJoinType, getName, getOriginatingExternalNode, getType, guard, initId, isBacktrackable, isImportedFromExternal, isStart, setDefiningGraph, setExternal, setGraph, setGuard, setJoinParam, setJoinType, setName, setOriginatingExternalNode, setStart, setType

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.commons.logging.Log log

VALIDATE_ACTION

public static final String VALIDATE_ACTION

See Also:

Constant Field Values

VALIDATION_TYPE

public static final String VALIDATION_TYPE

See Also:

Constant Field Values

VALIDATOR_EPR_PARAM_NAME

public static final String VALIDATOR_EPR_PARAM_NAME

See Also:

Constant Field Values

Constructor Detail

ValidatorServiceBlackboardJobNode

public ValidatorServiceBlackboardJobNode()

Method Detail

prepareJob

protected void prepareJob(eu.dnetlib.enabling.tools.blackboard.BlackboardJob job,
                          com.googlecode.sarasvati.NodeToken token)
                   throws Exception

Parameters to set for the VALIDATE BB job:

     
      //values: openaire3.0, openaire2.0, openaire2.0_data, driver
      //OPTIONAL
      //enables the feature to keep blacklisted records. Default is true.
      //optional. values: name of the ruleset (as created from the validator admin panel) to use to generate the blacklist. Default value is the value in "guidelines".
     
      //OPTIONAL
      //OPTIONAL
     
      //OPTIONAL
     
      //TRUE to get the EPR of validated records. Default is false.
      //OPTIONAL
     
 

Specified by:

prepareJob in class eu.dnetlib.msro.workflows.nodes.BlackboardJobNode

Throws:

Exception

See Also:

BlackboardJobNode.prepareJob(eu.dnetlib.enabling.tools.blackboard.BlackboardJob, com.googlecode.sarasvati.NodeToken)

generateBlackboardListener

protected eu.dnetlib.msro.workflows.nodes.blackboard.BlackboardWorkflowJobListener generateBlackboardListener(com.googlecode.sarasvati.Engine engine,
                                                                                                              com.googlecode.sarasvati.NodeToken token)

Parameters in the VALIDATE BB job response:

 
  //only if isShouldOutputRecords() == true
 
 

Overrides:

generateBlackboardListener in class eu.dnetlib.msro.workflows.nodes.BlackboardJobNode

See Also:

BlackboardJobNode.generateBlackboardListener(com.googlecode.sarasvati.Engine, com.googlecode.sarasvati.NodeToken)

obtainServiceId

protected String obtainServiceId(com.googlecode.sarasvati.NodeToken token)

Specified by:

obtainServiceId in class eu.dnetlib.msro.workflows.nodes.BlackboardJobNode

getProgressProvider

public eu.dnetlib.msro.workflows.util.ProgressProvider getProgressProvider()

Specified by:

getProgressProvider in interface eu.dnetlib.msro.workflows.nodes.ProgressJobNode

getTotalValue

public int getTotalValue()

Specified by:

getTotalValue in interface eu.dnetlib.msro.workflows.util.ProgressProvider

getCurrentValue

public int getCurrentValue()

Specified by:

getCurrentValue in interface eu.dnetlib.msro.workflows.util.ProgressProvider

isInaccurate

public boolean isInaccurate()

Specified by:

isInaccurate in interface eu.dnetlib.msro.workflows.util.ProgressProvider

getGuidelines

public String getGuidelines()

setGuidelines

public void setGuidelines(String guidelines)

getRecordsSampleSize

public String getRecordsSampleSize()

setRecordsSampleSize

public void setRecordsSampleSize(String recordsSampleSize)

getMdstoreId

public String getMdstoreId()

setMdstoreId

public void setMdstoreId(String mdstoreId)

getExtra_param

public String getExtra_param()

setExtra_param

public void setExtra_param(String extra_param)

getxQueryForValidatorServiceId

public String getxQueryForValidatorServiceId()

setxQueryForValidatorServiceId

public void setxQueryForValidatorServiceId(String xQueryForValidatorServiceId)

getOutputEprName

public String getOutputEprName()

setOutputEprName

public void setOutputEprName(String outputEprName)

getExtraParams

public String getExtraParams()

setExtraParams

public void setExtraParams(String extraParams)

getCurrentlyValidatedParam

public String getCurrentlyValidatedParam()

setCurrentlyValidatedParam

public void setCurrentlyValidatedParam(String currentlyValidatedParam)

getJobStatusUpdateInterval

public int getJobStatusUpdateInterval()

setJobStatusUpdateInterval

public void setJobStatusUpdateInterval(int jobStatusUpdateInterval)

getCurrentlyValidated

public int getCurrentlyValidated()

setCurrentlyValidated

public void setCurrentlyValidated(int currentlyValidated)

isShouldOutputRecords

public boolean isShouldOutputRecords()

setShouldOutputRecords

public void setShouldOutputRecords(boolean shouldOutputRecords)

isShouldUpdateBlacklist

public boolean isShouldUpdateBlacklist()

setShouldUpdateBlacklist

public void setShouldUpdateBlacklist(boolean shouldUpdateBlacklist)

getBlacklistRuleName

public String getBlacklistRuleName()

setBlacklistRuleName

public void setBlacklistRuleName(String blacklistRuleName)

getWorkers

public int getWorkers()

setWorkers

public void setWorkers(int workers)