DocumentSimilarityActionBuilderModuleFactory.java

package eu.dnetlib.iis.wf.export.actionmanager.module;

import static eu.dnetlib.iis.wf.export.actionmanager.ExportWorkflowRuntimeParameters.EXPORT_DOCUMENTSSIMILARITY_THRESHOLD;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.apache.hadoop.conf.Configuration;
import org.apache.log4j.Logger;

import eu.dnetlib.actionmanager.actions.AtomicAction;
import eu.dnetlib.actionmanager.common.Agent;
import eu.dnetlib.data.mapreduce.util.OafDecoder;
import eu.dnetlib.data.proto.KindProtos.Kind;
import eu.dnetlib.data.proto.OafProtos.Oaf;
import eu.dnetlib.data.proto.OafProtos.OafRel;
import eu.dnetlib.data.proto.RelTypeProtos.RelType;
import eu.dnetlib.data.proto.RelTypeProtos.SubRelType;
import eu.dnetlib.data.proto.ResultResultProtos.ResultResult;
import eu.dnetlib.data.proto.ResultResultProtos.ResultResult.Similarity;
import eu.dnetlib.data.proto.ResultResultProtos.ResultResult.Similarity.Type;
import eu.dnetlib.iis.common.InfoSpaceConstants;
import eu.dnetlib.iis.common.WorkflowRuntimeParameters;
import eu.dnetlib.iis.documentssimilarity.schemas.DocumentSimilarity;
import eu.dnetlib.iis.wf.export.actionmanager.cfg.StaticConfigurationProvider;

/**
 * {@link DocumentSimilarity} based action builder module.
 * 
 * @author mhorst
 *
 */
public class DocumentSimilarityActionBuilderModuleFactory extends AbstractActionBuilderFactory<DocumentSimilarity> {

    private static final Logger log = Logger.getLogger(DocumentSimilarityActionBuilderModuleFactory.class);

    // ------------------------ CONSTRUCTORS --------------------------

    public DocumentSimilarityActionBuilderModuleFactory() {
        super(AlgorithmName.document_similarities_standard);
    }

    // ------------------------ LOGIC ---------------------------------
    
    @Override
    public ActionBuilderModule<DocumentSimilarity> instantiate(Configuration config, Agent agent, String actionSetId) {
        Float similarityThreshold = null;
        String thresholdStr = WorkflowRuntimeParameters.getParamValue(EXPORT_DOCUMENTSSIMILARITY_THRESHOLD, config);
        if (thresholdStr != null) {
            similarityThreshold = Float.valueOf(thresholdStr);
            log.info("setting documents similarity exporter threshold to: " + similarityThreshold);
        }
        return new DocumentSimilarityActionBuilderModule(provideTrustLevelThreshold(config), similarityThreshold, agent,
                actionSetId);
    }
    
    // ------------------------ INNER CLASS --------------------------

    class DocumentSimilarityActionBuilderModule extends AbstractBuilderModule<DocumentSimilarity> {

        private final Float similarityThreshold;

        // ------------------------ CONSTRUCTORS --------------------------

        /**
         * @param trustLevelThreshold trust level threshold or null when all records should be exported
         * @param similarityThreshold similarity threshold, skipped when null
         * @param agent action manager agent details
         * @param actionSetId action set identifier
         */
        public DocumentSimilarityActionBuilderModule(Float trustLevelThreshold, Float similarityThreshold, Agent agent,
                String actionSetId) {
            super(trustLevelThreshold, buildInferenceProvenance(), agent, actionSetId);
            this.similarityThreshold = similarityThreshold;
        }

        // ------------------------ LOGIC --------------------------

        @Override
        public List<AtomicAction> build(DocumentSimilarity object) {
            // checking similarity threshold if set
            if (similarityThreshold != null && object.getSimilarity() != null
                    && object.getSimilarity() < similarityThreshold) {
                return Collections.emptyList();
            }
            // setting relations in both source and target objects
            List<AtomicAction> simActions = createActions(object, getActionSetId(), getAgent(), false);
            List<AtomicAction> reverseSimActions = createActions(object, getActionSetId(), getAgent(), true);
            List<AtomicAction> results = new ArrayList<AtomicAction>();
            if (simActions != null && !simActions.isEmpty()) {
                results.addAll(simActions);
            }
            if (reverseSimActions != null && !reverseSimActions.isEmpty()) {
                results.addAll(reverseSimActions);
            }
            return results;
        }

        // ------------------------ PRIVATE --------------------------

        /**
         * Creates similarity related actions.
         * 
         * @param object source object
         * @param actionSet action set identifier
         * @param agent action manager agent details
         * @param backwardMode flag indicating relation should be created in backward mode
         * @return similarity related actions
         */
        private List<AtomicAction> createActions(DocumentSimilarity object, String actionSet, Agent agent,
                boolean backwardMode) {
            Oaf oafObjectRel = buildOaf(object.getDocumentId().toString(), object.getOtherDocumentId().toString(),
                    object.getSimilarity(), backwardMode);
            List<AtomicAction> actionList = new ArrayList<AtomicAction>();
            AtomicAction currentAction = getActionFactory().createAtomicAction(actionSet, agent,
                    backwardMode ? object.getOtherDocumentId().toString() : object.getDocumentId().toString(),
                    OafDecoder.decode(oafObjectRel).getCFQ(),
                    backwardMode ? object.getDocumentId().toString() : object.getOtherDocumentId().toString(),
                    oafObjectRel.toByteArray());
            actionList.add(currentAction);
            return actionList;
        }

        /**
         * Builds {@link Oaf} object encapsulating relation details fom {@link OafRel}.
         */
        private Oaf buildOaf(String sourceId, String targetDocId, float score, boolean invert) {
            Oaf.Builder oafBuilder = Oaf.newBuilder();
            oafBuilder.setKind(Kind.relation);
            oafBuilder.setRel(buildOafRel(sourceId, targetDocId, score, invert));
            oafBuilder.setDataInfo(buildInferenceForTrustLevel(StaticConfigurationProvider.ACTION_TRUST_0_9));
            oafBuilder.setLastupdatetimestamp(System.currentTimeMillis());
            return oafBuilder.build();
        }
        
        /**
         * Builds {@link OafRel} object with similarity details.
         */
        private OafRel buildOafRel(String sourceId, String targetDocId, float score, boolean invert) {
            OafRel.Builder relBuilder = OafRel.newBuilder();
            relBuilder.setSource(invert?targetDocId:sourceId);
            relBuilder.setTarget(invert?sourceId:targetDocId);
            String relClass = invert ? Similarity.RelName.isAmongTopNSimilarDocuments.toString()
                    : Similarity.RelName.hasAmongTopNSimilarDocuments.toString();
            relBuilder.setChild(false);
            relBuilder.setRelType(RelType.resultResult);
            relBuilder.setSubRelType(SubRelType.similarity);
            relBuilder.setRelClass(relClass);
            ResultResult.Builder resultResultBuilder = ResultResult.newBuilder();
            Similarity.Builder similarityBuilder = Similarity.newBuilder();
            similarityBuilder.setRelMetadata(
                    buildRelMetadata(InfoSpaceConstants.SEMANTIC_SCHEME_DNET_RELATIONS_RESULT_RESULT, relClass));
            similarityBuilder.setSimilarity(score);
            similarityBuilder.setType(Type.STANDARD);
            resultResultBuilder.setSimilarity(similarityBuilder.build());
            relBuilder.setResultResult(resultResultBuilder.build());
            return relBuilder.build();
        }
    }

}