gov.nasa.pds.citool.ri.DataSetRIChecker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of catalog-legacy Show documentation
The Legacy Catalog Tool provides functionality for ingesting PDS3 catalog files into the PDS4 infrastructure including the Registry Service.
There is a newer version: 3.1.0
Show newest version
package gov.nasa.pds.citool.ri;

import gov.nasa.pds.tools.LabelParserException;
import gov.nasa.pds.tools.constants.Constants;
import gov.nasa.pds.tools.label.AttributeStatement;
import gov.nasa.pds.tools.label.Label;

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

/**
 * Class to perform referential integrity on data sets.
 *
 * @author mcayanan
 *
 */
public class DataSetRIChecker extends RIChecker {
    private static String ID = "DATA_SET_ID";
    private static String COLLECTION_ID = "DATA_SET_COLLECTION_ID";
    private static String COLL_OR_DS_ID = "DATA_SET_COLL_OR_DATA_SET_ID";
    private static String PRODUCT_DS_ID = "PRODUCT_DATA_SET_ID";

    public void performCheck(List parentLabels,
            List childLabels) {
        Map> parents =
            new HashMap>();
        List children = new ArrayList();

        //Get the DATA_SET_ID and DATA_SET_COLLECTION_ID values from the parents
        for (Label label : parentLabels) {
            if (!label.getObjects(RIType.DATA_SET.getName().toUpperCase())
                    .isEmpty()) {
                 List statements = parents.get(ID);
                 if (statements == null) {
                     statements = new ArrayList();
                     parents.put(ID, statements);
                 }
                 statements.addAll(StatementFinder.getStatementsRecursively(
                         label, ID));
            }
            else {
                List statements = parents.get(
                        COLLECTION_ID);
                if (statements == null) {
                    statements = new ArrayList();
                    parents.put(COLLECTION_ID, statements);
                }
                statements.addAll(StatementFinder.getStatementsRecursively(
                        label, COLLECTION_ID));
            }
        }
        List identifiers = new ArrayList(parents.keySet());
        for (Label child : childLabels) {
            Map> childStmts =
                StatementFinder.getStatementsRecursively(child, identifiers);
            for (List list : childStmts.values()) {
                children.addAll(list);
            }
            Map results = getUnmatchedValues(
                    parents, childStmts);
            results.putAll(getUnmatchedAssociatedValues(parents, child,
                    PRODUCT_DS_ID));
            results.putAll(getUnmatchedAssociatedValues(parents, child,
                    COLL_OR_DS_ID));
            for(Map.Entry entry
                    : results.entrySet()) {
                AttributeStatement a = entry.getValue();
                String statement = a.getIdentifier().getId() + " = "
                + entry.getKey();
                Object[] arguments = {statement, "dataset.cat"};
                LabelParserException le = new LabelParserException(
                        a.getSourceURI(), null, null,
                        "referentialIntegrity.error.missingIdInParent",
                        Constants.ProblemType.MISSING_ID, arguments);
                addProblem(le);
            }
        }
        List pStmts = new ArrayList();
        for(List list : parents.values()) {
            pStmts.addAll(list);
        }
        ValueMatcher matcher = new ValueMatcher(children);
        Map missingFromChildren =
            matcher.getUnmatched(pStmts);
        if(!missingFromChildren.isEmpty()) {
            for(Map.Entry entry
                    : missingFromChildren.entrySet()) {
                AttributeStatement a = entry.getValue();
                String statement = a.getIdentifier().getId() + " = "
                + entry.getKey();
                Object[] arguments = {statement, "non dataset.cat"};
                LabelParserException le = new LabelParserException(
                        a.getSourceURI(), null, null,
                        "referentialIntegrity.error.missingIdInChildren",
                        Constants.ProblemType.MISSING_ID, arguments);
                addProblem(le);
            }
        }
    }

    private Map getUnmatchedAssociatedValues(
            Map> parents,
            Label child, String identifier) {
        List parentStatements =
            new ArrayList();

        for(List p : parents.values()) {
            parentStatements.addAll(p);
        }
        List childStatements = StatementFinder
        .getStatementsRecursively(child, identifier);
        ValueMatcher matcher = new ValueMatcher(parentStatements);
        return matcher.getUnmatched(childStatements);
    }

    @Override
    public RIType getType() {
        return RIType.DATA_SET;
    }
}