com.googlecode.fascinator.common.IndexAndPayloadComposite 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
/* 
 * Copyright (C) 2013 Queensland Cyber Infrastructure Foundation (http://www.qcif.edu.au/)
 * 
 * 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;

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

import org.apache.commons.lang.StringUtils;
import org.json.simple.JSONArray;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.googlecode.fascinator.common.solr.SolrDoc;

/**
 * Combines indexed and payload data to abstract data access in scripts, etc.
 * 
 * @author Shilo Banihit
 * 
 */
public class IndexAndPayloadComposite {

    private SolrDoc indexedData;
    private JsonSimple payloadData;
    private static Logger log = LoggerFactory
            .getLogger(IndexAndPayloadComposite.class);

    /**
     * Builds an instance using the indexed data, accessing the storage for the
     * appropriate payload specified in
     * 
     * @param indexedData
     * @param services
     */
    public IndexAndPayloadComposite(SolrDoc indexedData, JsonSimple payloadData) {
        this.indexedData = indexedData;
        this.payloadData = payloadData;
    }

    /**
     * Retrieves the object from the composite, prioritizes payload then
     * indexed.
     * 
     * Attempts to replace "_" in field names to ":" to prioritize payload
     * content.
     * 
     * @param field
     * @return
     */
    public Object getPath(String field) {
        Object object = null;
        if (field.indexOf("_") != -1) {
            String convertedFieldName = field.replace("_", ":");
            object = getPath(convertedFieldName);
            if (object != null) {
                return object;
            }
        }
        if (payloadData != null) {
            object = payloadData.getPath(field);
            // log.debug("Using payload: " + field + " with value: " + object);
        }
        if (object == null) {
            object = indexedData.getPath(field);
            // log.debug("Using Indexed: " + field + " with value: " + object);
        }
        return object;
    }

    /**
     * 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 = getPath(field);

        // giving up
        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 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 = 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 = 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;
    }

    public JsonObject getJsonObject() {
        if (payloadData != null) {
            return payloadData.getJsonObject();
        }
        return indexedData.getJsonObject();
    }

    public SolrDoc getIndexedData() {
        return indexedData;
    }

    public JsonSimple getPayloadData() {
        return payloadData;
    }

    public void setPayloadData(JsonSimple payloadData) {
        this.payloadData = payloadData;
    }
}