src/main/java/de/ids_mannheim/korap/KorapResult.java

package de.ids_mannheim.korap;

import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.fasterxml.jackson.databind.node.ArrayNode;

import de.ids_mannheim.korap.index.PositionsToOffset;
import de.ids_mannheim.korap.index.SearchContext;
import de.ids_mannheim.korap.response.KorapResponse;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.List;

/*
  TODO: Reuse the KorapSearch code for data serialization!
*/
/**
 * Response class for search results.
 *
 * TODO: Synopsis
 *
 * @author diewald
 * @see KorapResponse
 */
@JsonInclude(Include.NON_NULL)
@JsonIgnoreProperties(ignoreUnknown = true)
public class KorapResult extends KorapResponse {
    ObjectMapper mapper = new ObjectMapper();

    @JsonIgnore
    public static final short ITEMS_PER_PAGE     = 25;
    public static final short ITEMS_PER_PAGE_MAX = 100;

    private int startIndex = 0;
    private String query;

    private List<KorapMatch> matches;

    private SearchContext context;

    private short
        itemsPerPage     = ITEMS_PER_PAGE,
        itemsPerResource = 0;

    private JsonNode request;

    // Logger
    // This is KorapMatch instead of KorapResult!
    private final static Logger log = LoggerFactory.getLogger(KorapMatch.class);


    /**
     * Construct a new KorapResult object.
     */
    public KorapResult() {
        mapper.enable(SerializationFeature.INDENT_OUTPUT);
    };


    /**
     * Construct a new KorapResult object.
     *
     * @param query Query representation as a string.
     * @param startIndex Offset position in match array.
     * @param itemsPerPage Number of matches per page.
     * @param context Requested {@link SearchContext}
     */
    public KorapResult(String query,
                       int startIndex,
                       short itemsPerPage,
                       SearchContext context) {

        mapper.enable(SerializationFeature.INDENT_OUTPUT);
        // mapper.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS);
        // mapper.disable(SerializationFeature.WRITE_NULL_MAP_VALUES);

        this.matches = new ArrayList<>(itemsPerPage);
        this.query = query;
        this.startIndex = startIndex;
        this.itemsPerPage =
            (itemsPerPage > ITEMS_PER_PAGE_MAX || itemsPerPage < 1) ?
            ITEMS_PER_PAGE : itemsPerPage;
        this.context = context;
    };


    /**
     * Add a new match to the result set.
     *
     * @param match A {@link KorapMatch} to add.
     */
    public void add (KorapMatch km) {
        this.matches.add(km);
    };


    /**
     * Get the number of items (documents) shown per page.
     *
     * @return Number of items shown per page.
     */
    public short getItemsPerPage () {
        return this.itemsPerPage;
    };


    /**
     * Set the number of items (documents) shown per page.
     *
     * @param count Number of items shown per page.
     * @return {@link KorapResult} object for chaining.
     */
    public KorapResult setItemsPerPage (short count) {
        this.itemsPerPage = count;
        return this;
    };


    /**
     * Get serialized query as a {@link JsonNode}.
     *
     * @return {@link JsonNode} representation of the query object.
     */
    public JsonNode getRequest () {
        return this.request;
    };


    /**
     * Set serialized query as a {@link JsonNode}.
     *
     * @param request {@link JsonNode} representation of the query object.
     * @return {@link KorapResult} object for chaining.
     */    
    public KorapResult setRequest (JsonNode request) {
        this.request = request;
        return this;
    };


    /**
     * Get the number of items shown per resource (document).
     * Defaults to <tt>0</tt>, which is infinite.
     *
     * @return The number of items shown per resource.
     */
    public short getItemsPerResource () {
        return this.itemsPerResource;
    };


    /**
     * Set the number of items (matches) shown per resource (text).
     * Defaults to <tt>0</tt>, which is infinite.
     *
     * @param value The number of items shown per resource.
     * @return {@link KorapResult} object for chaining.
     */
    public KorapResult setItemsPerResource (short value) {
        this.itemsPerResource = value;
        return this;
    };


    /**
     * Set the number of items (matches) shown per resource (document).
     * Defaults to <tt>0</tt>, which is infinite.
     *
     * @param value The number of items shown per resource.
     * @return {@link KorapResult} object for chaining.
     */
    public KorapResult setItemsPerResource (int value) {
        this.itemsPerResource = (short) value;
        return this;
    };


    /**
     * Get the string representation of the search query.
     *
     * @return The string representation of the search query.
     */
    public String getQuery () {
        return this.query;
    };


    /**
     * Get a certain {@link KorapMatch} by index.
     *
     * @param index The numerical index of the match,
     *        starts with <tt>0</tt>.
     * @return The {@link KorapMatch} object.
     */
    @JsonIgnore
    public KorapMatch getMatch (int index) {
        return this.matches.get(index);
    };


    /**
     * Get the list of {@link KorapMatch} matches.
     *
     * @return The list of {@link KorapMatch} objects.
     */
    public List<KorapMatch> getMatches() {
        return this.matches;
    };


    /**
     * Get the number of the first match in the result set
     * (<i>aka</i> the offset). Starts with <tt>0</tt>.
     *
     * @return The index number of the first match in the result set.
     */
    public int getStartIndex () {
        return startIndex;
    };


    /**
     * Get the context parameters of the search by means of a
     * {@link SearchContext} object.
     *
     * @return The {@link SearchContext} object.
     */
    public SearchContext getContext () {
        return this.context;
    };


    /**
     * Set the context parameters of the search by means of a
     * {@link SearchContext} object.
     *
     * @param context The {@link SearchContext} object providing
     *        search context parameters.
     * @return {@link KorapResult} object for chaining.
     */
    public KorapResult setContext (SearchContext context) {
        this.context = context;
        return this;
    };


    /**
     * Serialize the result set as a {@link JsonNode}.
     *
     * @return {@link JsonNode} representation of the search results.
     */
    public JsonNode toJsonNode () {
        ObjectNode json = (ObjectNode) mapper.valueToTree(super.toJsonNode());

        // Relevant context setting
        if (this.context != null)
            json.put("context", this.getContext().toJsonNode());


        // ItemsPerPage
        json.put("itemsPerPage", this.itemsPerPage);

        // Relevant itemsPerResource setting
        if (this.itemsPerResource > 0)
            json.put("itemsPerResource", this.itemsPerResource);

        json.put("startIndex", this.startIndex);

        // Add matches
        if (this.matches != null)
            json.putPOJO("matches", this.getMatches());


        // TODO: <test>
        if (this.request != null)
            json.put("request", this.request);
        if (this.query != null)
            json.put("query", this.query);
        // </test>

        return json;
    };


    // For Collocation Analysis API
    @Deprecated
    public String toTokenListJsonString () {
        ObjectNode json = (ObjectNode) mapper.valueToTree(this);
        
        ArrayNode array = json.putArray("matches");
	
        // Add matches as token lists
        for (KorapMatch km : this.getMatches())
            array.add(km.toTokenList());

        try {
            return mapper.writeValueAsString(json);
        }
        catch (Exception e) {
            log.warn(e.getLocalizedMessage());
        };
        
        return "{}";
    };
};