org.dspace.ctask.general.RequiredMetadata Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation
DSpace core data model and service APIs.
There is a newer version: 8.0
/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.dspace.ctask.general;

import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.dspace.app.util.DCInput;
import org.dspace.app.util.DCInputSet;
import org.dspace.app.util.DCInputsReader;
import org.dspace.app.util.DCInputsReaderException;
import org.dspace.content.DSpaceObject;
import org.dspace.content.Item;
import org.dspace.content.MetadataValue;
import org.dspace.core.Constants;
import org.dspace.curate.AbstractCurationTask;
import org.dspace.curate.Curator;
import org.dspace.curate.Suspendable;

/**
 * RequiredMetadata task compares item metadata with fields
 * marked as required in submission-forms.xml. The task succeeds if all
 * required fields are present in the item metadata, otherwise it fails.
 * Primarily a curation task demonstrator.
 *
 * @author richardrodgers
 */
@Suspendable
public class RequiredMetadata extends AbstractCurationTask {
    // map of DCInputSets
    protected DCInputsReader reader = null;
    // map of required fields
    protected Map> reqMap = new HashMap>();

    @Override
    public void init(Curator curator, String taskId) throws IOException {
        super.init(curator, taskId);
        try {
            reader = new DCInputsReader();
        } catch (DCInputsReaderException dcrE) {
            throw new IOException(dcrE.getMessage(), dcrE);
        }
    }

    /**
     * Perform the curation task upon passed DSO
     *
     * @param dso the DSpace object
     * @throws IOException if IO error
     */
    @Override
    public int perform(DSpaceObject dso) throws IOException {
        if (dso.getType() == Constants.ITEM) {
            Item item = (Item) dso;
            int count = 0;
            try {
                StringBuilder sb = new StringBuilder();
                String handle = item.getHandle();
                if (handle == null) {
                    // we are still in workflow - no handle assigned
                    handle = "in workflow";
                }
                sb.append("Item: ").append(handle);
                for (String req : getReqList(item.getOwningCollection().getHandle())) {
                    List vals = itemService.getMetadataByMetadataString(item, req);
                    if (vals.size() == 0) {
                        sb.append(" missing required field: ").append(req);
                        count++;
                    }
                }
                if (count == 0) {
                    sb.append(" has all required fields");
                }
                report(sb.toString());
                setResult(sb.toString());
            } catch (DCInputsReaderException dcrE) {
                throw new IOException(dcrE.getMessage(), dcrE);
            }
            return (count == 0) ? Curator.CURATE_SUCCESS : Curator.CURATE_FAIL;
        } else {
            setResult("Object skipped");
            return Curator.CURATE_SKIP;
        }
    }

    protected List getReqList(String handle) throws DCInputsReaderException {
        List reqList = reqMap.get(handle);
        if (reqList == null) {
            reqList = reqMap.get("default");
        }
        if (reqList == null) {
            reqList = new ArrayList();
            List inputSet = reader.getInputsByCollectionHandle(handle);
            for (DCInputSet inputs : inputSet) {
                for (DCInput[] row : inputs.getFields()) {
                    for (DCInput input : row) {
                        if (input.isRequired()) {
                            StringBuilder sb = new StringBuilder();
                            sb.append(input.getSchema()).append(".");
                            sb.append(input.getElement()).append(".");
                            String qual = input.getQualifier();
                            if (qual == null) {
                                qual = "";
                            }
                            sb.append(qual);
                            reqList.add(sb.toString());
                        }
                    }
                }
                reqMap.put(inputs.getFormName(), reqList);
            }
        }
        return reqList;
    }
}