AbstractBuilderModule.java

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

import java.text.DecimalFormat;
import java.text.NumberFormat;
import java.util.Locale;

import com.google.common.base.Preconditions;

import eu.dnetlib.actionmanager.actions.ActionFactory;
import eu.dnetlib.actionmanager.common.Agent;
import eu.dnetlib.data.proto.FieldTypeProtos.DataInfo;
import eu.dnetlib.data.proto.FieldTypeProtos.Qualifier;
import eu.dnetlib.data.proto.KindProtos.Kind;
import eu.dnetlib.data.proto.OafProtos.Oaf;
import eu.dnetlib.data.proto.OafProtos.OafEntity;
import eu.dnetlib.data.proto.OafProtos.OafRel;
import eu.dnetlib.data.proto.RelMetadataProtos.RelMetadata;
import eu.dnetlib.iis.common.InfoSpaceConstants;

/**
 * Abstract builder module.
 * 
 * @author mhorst
 *
 */
public abstract class AbstractBuilderModule<T> implements ActionBuilderModule<T>{

    /**
     * Trust level threshold, null when not specified.
     */
    private final Float trustLevelThreshold;

    /**
     * Inference provenance.
     */
    private final String inferenceProvenance;

    /**
     * Action manager agent.
     */
    private final Agent agent;
    
    /**
     * Action set identifier.
     */
    private final String actionSetId;
    
    /**
     * Action factory to be used for building actions.
     */
    private final ActionFactory actionFactory = new ActionFactory();

    /**
     * Trust level format.
     */
    private final DecimalFormat decimalFormat;

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

    public AbstractBuilderModule(Float trustLevelThreshold, String inferenceProvenance,
            Agent agent, String actionSetId) {
        this.decimalFormat = (DecimalFormat) NumberFormat.getInstance(Locale.ENGLISH);
        this.decimalFormat.applyPattern("#.####");
        this.trustLevelThreshold = trustLevelThreshold;
        this.inferenceProvenance = Preconditions.checkNotNull(inferenceProvenance);
        this.agent = Preconditions.checkNotNull(agent);
        this.actionSetId = Preconditions.checkNotNull(actionSetId);
    }

    // ------------------------ GETTERS -------------------------------


    public String getInferenceProvenance() {
        return inferenceProvenance;
    }
    
    public Agent getAgent() {
        return agent;
    }
    
    public String getActionSetId() {
        return actionSetId;
    }

    public ActionFactory getActionFactory() {
        return actionFactory;
    }
    
    
    // ------------------------ LOGIC ---------------------------------

    /**
     * Builds {@link Oaf} object for given entity.
     * 
     */
    protected Oaf buildOaf(OafEntity oafEntity) {
        return buildOaf(oafEntity, null);
    }

    /**
     * Builds {@link Oaf} object for given entity and data description.
     * 
     */
    protected Oaf buildOaf(OafEntity oafEntity, DataInfo dataInfo) {
        eu.dnetlib.data.proto.OafProtos.Oaf.Builder oafBuilder = Oaf.newBuilder();
        oafBuilder.setKind(Kind.entity);
        oafBuilder.setEntity(oafEntity);
        if (dataInfo != null) {
            oafBuilder.setDataInfo(dataInfo);
        }
        oafBuilder.setLastupdatetimestamp(System.currentTimeMillis());
        return oafBuilder.build();
    }

    /**
     * Returns {@link DataInfo} with inference details. Confidence level will be normalized to trust level.
     * 
     * @param confidenceLevel confidence level which will be normalized to trust level
     * @throws TrustLevelThresholdExceededException thrown when trust level threshold was exceeded
     */
    protected DataInfo buildInference(float confidenceLevel) throws TrustLevelThresholdExceededException {
        float currentTrustLevel = confidenceLevel * InfoSpaceConstants.CONFIDENCE_TO_TRUST_LEVEL_FACTOR;
        if (trustLevelThreshold == null || currentTrustLevel >= trustLevelThreshold) {
            return buildInferenceForTrustLevel(this.decimalFormat.format(currentTrustLevel));
        } else {
            throw new TrustLevelThresholdExceededException();
        }
    }
    
    /**
     * Returns {@link DataInfo} with inference details.
     * 
     */
    protected DataInfo buildInferenceForTrustLevel(String trustLevel) {
        DataInfo.Builder builder = DataInfo.newBuilder();
        builder.setInferred(true);
        builder.setTrust(trustLevel);
        Qualifier.Builder provenanceBuilder = Qualifier.newBuilder();
        provenanceBuilder.setClassid(InfoSpaceConstants.SEMANTIC_CLASS_IIS);
        provenanceBuilder.setClassname(InfoSpaceConstants.SEMANTIC_CLASS_IIS);
        provenanceBuilder.setSchemeid(InfoSpaceConstants.SEMANTIC_SCHEME_DNET_PROVENANCE_ACTIONS);
        provenanceBuilder.setSchemename(InfoSpaceConstants.SEMANTIC_SCHEME_DNET_PROVENANCE_ACTIONS);
        builder.setProvenanceaction(provenanceBuilder.build());
        builder.setInferenceprovenance(inferenceProvenance);
        return builder.build();
    }
    
    /**
     * Builds relation metadata.
     * 
     */
    protected RelMetadata buildRelMetadata(String schemaId, String classId) {
        RelMetadata.Builder relBuilder = RelMetadata.newBuilder();
        Qualifier.Builder qBuilder = Qualifier.newBuilder();
        qBuilder.setSchemeid(schemaId);
        qBuilder.setSchemename(schemaId);
        qBuilder.setClassid(classId);
        qBuilder.setClassname(classId);
        relBuilder.setSemantics(qBuilder.build());
        return relBuilder.build();
    }

    /**
     * Clones builder provided as parameter, inverts relations and builds new Oaf object. 
     * Relation direction is not iverted as it is bidirectional.
     * 
     * @param existingBuilder {@link Oaf.Builder} to be cloned
     * @return Oaf object containing relation with inverted source and target fields.
     */
    protected Oaf invertBidirectionalRelationAndBuild(Oaf.Builder existingBuilder) {
        // works on builder clone to prevent changes in existing builder
        if (existingBuilder.getRel() != null) {
            if (existingBuilder.getRel().getSource() != null && existingBuilder.getRel().getTarget() != null) {
                Oaf.Builder builder = existingBuilder.clone();
                OafRel.Builder relBuilder = builder.getRelBuilder();
                String source = relBuilder.getSource();
                String target = relBuilder.getTarget();
                relBuilder.setSource(target);
                relBuilder.setTarget(source);
                builder.setRel(relBuilder.build());
                builder.setLastupdatetimestamp(System.currentTimeMillis());
                return builder.build();
            } else {
                throw new RuntimeException("invalid state: " + "either source or target relation was missing!");
            }
        } else {
            throw new RuntimeException("invalid state: " + "no relation object found!");
        }
    }

}