gov.nasa.pds.citool.ri.StatementFinder 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 java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import gov.nasa.pds.tools.label.AttributeStatement;
import gov.nasa.pds.tools.label.GroupStatement;
import gov.nasa.pds.tools.label.Label;
import gov.nasa.pds.tools.label.ObjectStatement;
import gov.nasa.pds.tools.label.Statement;

/**
 * Class that finds statements in a PDS label that matches a user supplied
 * list of keywords.
 *
 * @author mcayanan
 *
 */
public class StatementFinder {

    /**
     * Recursively searches down a PDS label to find attributes that matches
     * a user supplied keyword.
     *
     * @param label A PDS label file.
     * @param identifier An identifier to search for in the labels.
     *
     * @return A list of attributes that match the supplied identifier.
     */
    public static List getStatementsRecursively(Label label, String identifier) {
        List identifiers = new ArrayList();
        List statements = new ArrayList();
        identifiers.add(identifier);
        Map> results = getStatementsRecursively(label, identifiers);
        List list = results.get(identifier);
        if(list != null)
            statements.addAll(list);

        return statements;
    }

    /**
     * Recursively searches down a PDS label to find attributes that match
     * a user supplied list of keywords.
     *
     * @param labels A list of PDS label files.
     * @param identifier An identifier to search for in the labels.
     *
     * @return A list of attributes that match the supplied identifier.
     */
    public static List getStatementsRecursively(List labels, String identifier) {
        List identifiers = new ArrayList();
        List statements = new ArrayList();
        identifiers.add(identifier);
        Map> results = getStatementsRecursively(labels, identifiers);
        List list = results.get(identifier);
        if(list != null)
            statements.addAll(list);

        return statements;
    }

    /**
     * Recursively searches down a PDS label to find attributes that match
     * a user supplied list of keywords.
     *
     * @param labels A list of PDS label files.
     * @param identifiers A list of keywords to find in a PDS label.
     *
     * @return A map containing the attribute statements that were found
     * in the PDS label.
     */
    public static Map> getStatementsRecursively(List labels, List identifiers) {
        Map> statements = new LinkedHashMap>();
        for(Label label : labels) {
            Map> results = getStatementsRecursively(label, identifiers);
            for(Map.Entry> entry : results.entrySet()) {
                List list = statements.get(entry.getKey());
                if(list == null) {
                    list = new ArrayList();
                    statements.put(entry.getKey(), list);
                }
                list.addAll(entry.getValue());
            }
        }
        return statements;
    }

    /**
     * Recursively searches down a PDS label to find attributes that match
     * a user supplied list of keywords.
     *
     * @param label An object representation of a PDS label.
     * @param identifiers A list of keywords to find in a PDS label.
     *
     * @return A map containing the attribute statements that were found
     * in the PDS label.
     */
    public static Map< String, List > getStatementsRecursively(Label label, List identifiers) {
          Map< String, List > results = new HashMap< String, List >();

          List unprocessed = new ArrayList(label.getStatements());

          while (unprocessed.size() > 0) {
             Statement statement = unprocessed.remove(0);
             // Check that the statement belongs to the parent label.
             if (statement.getSourceURI().toString().equals(label.getLabelURI().toString())
                 && statement instanceof AttributeStatement
                 && identifiers.contains(statement.getIdentifier().getId())) {
                List statements = (ArrayList) results.get(statement.getIdentifier().getId());
                if (statements == null) {
                    //Create a new entry in the hashmap
                   statements = new ArrayList();
                   results.put(statement.getIdentifier().getId(), statements);
                   statements.add((AttributeStatement) statement);
                }
                else
                    statements.add((AttributeStatement) statement);
             } else if (statement instanceof ObjectStatement) {
                ObjectStatement object = (ObjectStatement) statement;
                unprocessed.addAll(object.getStatements());
             } else if (statement instanceof GroupStatement) {
                GroupStatement group = (GroupStatement) statement;
                unprocessed.addAll(group.getStatements());
             }
         }
         return results;
    }
}