gov.nasa.pds.harvest.util.out.XmlDocUtils Maven / Gradle / Ivy

Go to download
package gov.nasa.pds.harvest.util.out;

import java.io.Writer;
import java.util.Collection;
import org.apache.commons.lang.StringEscapeUtils;

import gov.nasa.pds.harvest.meta.FieldMapSet;


/**
 * Utility class to write XML documents in Solr format.
 *  
 * @author karpenko
 */
public class XmlDocUtils
{
    /**
     * Write a field.
     * @param writer Generic writer
     * @param key a key
     * @param values a collection of values
     * @throws Exception Generic exception
     */
    public static void writeField(Writer writer, String key, Collection values) throws Exception
    {
        if(values == null || values.size() == 0) return;
        
        for(String value: values)
        {
            writeField(writer, key, value);
        }
    }
    
    
    /**
     * Write a field.
     * @param writer Generic writer
     * @param key a key
     * @param value a value
     * @throws Exception Generic exception
     */
    public static void writeField(Writer writer, String key, float value) throws Exception
    {
        writeField(writer, key, String.valueOf(value));
    }
    

    /**
     * Write a field.
     * @param writer Generic writer
     * @param key a key
     * @param value a value
     * @throws Exception Generic exception
     */
    public static void writeField(Writer writer, String key, int value) throws Exception
    {
        writeField(writer, key, String.valueOf(value));
    }

    
    /**
     * Write a field.
     * @param writer Generic writer
     * @param key a key
     * @param value a value
     * @throws Exception Generic exception
     */
    public static void writeField(Writer writer, String key, String value) throws Exception
    {
        if(value == null) return;
        
        writer.write("  ");
        
        StringEscapeUtils.escapeXml(writer, value);
        
        writer.write("\n");
    }

    
    /**
     * Write a multivalued field.
     * @param writer Generic writer
     * @param fields collection of fields
     * @throws Exception Generic exception
     */
    public static void writeFieldMap(Writer writer, FieldMapSet fields) throws Exception
    {
        writer.write("\n");
        
        for(String fieldName: fields.getNames())
        {
            Collection values = fields.getValues(fieldName);
            if(values != null && values.size() > 0)
            {
                for(String value: values)
                {
                    XmlDocUtils.writeField(writer, fieldName, value);
                }
            }
        }
        
        writer.write("\n");
    }        

}