com.googlecode.fascinator.common.solr.SolrDoc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fascinator-common Show documentation
There is a newer version: 1.6
/*
 * The Fascinator - Solr Document object
 * Copyright (C) 2011 University of Southern Queensland
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package com.googlecode.fascinator.common.solr;

import com.googlecode.fascinator.common.JsonObject;
import com.googlecode.fascinator.common.JsonSimple;

import java.util.LinkedList;
import java.util.List;

import org.apache.commons.lang.StringUtils;
import org.json.simple.JSONArray;

/**
 * 
 * An extension of the JsonSimple class specifically to address Solr result
 * documents and shortcut common access.
 * 
 *
 * @author Greg Pendlebury
 */
public class SolrDoc extends JsonSimple {
    /**
     * Wrap a JsonObject in this class
     *
     * @param newJsonObject : The JsonObject to wrap
     */
    public SolrDoc(JsonObject newJsonObject) {
        super(newJsonObject);
    }

    /**
     * Gets the String value of the specified field.
     *
     * 
     *   Fields that are not found will always return null.
     *   Single valued fields will return the value found.
     *   Multi valued fields return all concatenated values (bracketed
     * and quoted) if more then one entry is found, otherwise it will be
     * simply the first entry.
     * 
     *
     * @param field : The field name to query
     * @return String : The value found, possibly null
     */
    public String get(String field) {
        Object object = this.getPath(field);

        // Doesn't exist
        if (object == null) return null;

        // This node is an array
        if (object instanceof JSONArray) {
            List array = JsonSimple.getStringList((JSONArray) object);
            if (array.size() == 1) {
                return (String) array.get(0);
            } else {
                return "[\"" + StringUtils.join(array, "\", \"") + "\"]";
            }
        }

        // Much simpler
        if (object instanceof String) {
            return (String) object;
        }

        // Some fields can be float/double such as "score"
        if (object instanceof Double) {
            return Double.toString((Double) object);
        }

        // Shouldn't occur in a valid Solr response
        return null;
    }

    /**
     * Gets the first String value of the specified field.
     *
     * 
     *   Fields that are not found will always return null.
     *   Single valued fields will return the value found.
     *   Multi valued fields return the String value of the first entry.
     * 
     *
     * @param field : The field name to query
     * @return String : The value found, possibly null
     */
    public String getFirst(String field) {
        Object object = this.getPath(field);

        // Doesn't exist
        if (object == null) return null;

        // This node is an array
        if (object instanceof JSONArray) {
            List array = JsonSimple.getStringList((JSONArray) object);
            Object first = array.get(0);
            if (first instanceof String) {
                return (String) first;
            }
        }

        // Much simpler
        if (object instanceof String) {
            return (String) object;
        }

        // Shouldn't occur in a valid Solr response
        return null;
    }

    /**
     * Gets the list of String values of the specified field.
     *
     * 
     *   Single valued fields will be added to a new List.
     *   Multi valued fields will all be returned in a List.
     *   Fields that are not found will return an empty list.
     * 
     *
     * @param field : The field name to query
     * @return List : The List of values found, possibly null
     */
    public List getList(String field) {
        Object object = this.getPath(field);

        // Doesn't exist
        if (object == null) return new LinkedList();

        // An array = easy
        if (object instanceof JSONArray) {
            return JsonSimple.getStringList((JSONArray) object);
        }

        // String, create a new list
        if (object instanceof String) {
            List response = new LinkedList();
            response.add((String) object);
            return response;
        }

        // Shouldn't occur in a valid Solr response
        return null;
    }
}