com.dottydingo.hyperion.client.builder.QueryRequestBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hyperion-client Show documentation
The newest version!
package com.dottydingo.hyperion.client.builder;

import com.dottydingo.hyperion.api.ApiObject;
import com.dottydingo.hyperion.api.EntityResponse;
import com.dottydingo.hyperion.client.*;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

/**
 * A request builder for queries
 */
public class QueryRequestBuilder,ID extends Serializable> extends RequestBuilder
{
    private List sorts = new ArrayList();

    /**
     * Create the request builder using the specified parameters
     * @param version The entity version
     * @param objectType The API type
     * @param entityName The entity name
     * @param query The query string
     */
    public QueryRequestBuilder(int version, Class objectType, String entityName,String query)
    {
        this(version, objectType, entityName);
        setParameter("query",query);
    }

    /**
     * Create the request builder using the specified parameters
     * @param version The entity version
     * @param objectType The API type
     * @param entityName The entity name
     */
    public QueryRequestBuilder(int version, Class objectType, String entityName)
    {
        super(version, objectType, entityName);
    }

    /**
     * Set the fields to return in the request. The default is all fields.
     * @param fields The fields to return
     * @return The request builder
     */
    public QueryRequestBuilder returnFields(String... fields)
    {
        setParameter("fields",join(fields));
        return this;
    }

    /**
     * Set the start position for the request
     * @param start The start position
     * @return THe request builder
     */
    public QueryRequestBuilder start(long start)
    {
        setParameter("start",Long.toString(start));
        return this;
    }

    /**
     * Set the limit for the request
     * @param limit The limit
     * @return THe request builder
     */
    public QueryRequestBuilder limit(long limit)
    {
        setParameter("limit",Long.toString(limit));
        return this;
    }

    /**
     * Add an ascending sort
     * @param field the field to sort on
     * @return The request builder
     */
    public QueryRequestBuilder addAscendingSort(String field)
    {
        sorts.add(field);
        return this;
    }

    /**
     * Add a descending sort
     * @param field the field to sort on
     * @return The request builder
     */
    public QueryRequestBuilder addDescendingSort(String field)
    {
        sorts.add(field + ":desc");
        return this;
    }

    @Override
    public QueryRequestBuilder addParameter(String name, String value)
    {
        super.addParameter(name, value);
        return this;
    }

    @Override
    public QueryRequestBuilder setParameter(String name, String value)
    {
        super.setParameter(name, value);
        return this;
    }

    @Override
    public QueryRequestBuilder addHeader(String name, String value)
    {
        super.addHeader(name, value);
        return this;
    }

    @Override
    public QueryRequestBuilder setHeader(String name, String value)
    {
        super.setHeader(name, value);
        return this;
    }

    @Override
    public QueryRequestBuilder withHeaderFactory(HeaderFactory headerFactory)
    {
        super.withHeaderFactory(headerFactory);
        return this;
    }

    @Override
    public QueryRequestBuilder withParameterFactory(ParameterFactory parameterFactory)
    {
        super.withParameterFactory(parameterFactory);
        return this;
    }

    @Override
    public Request build()
    {
        setParameter("sort",join(sorts));

        Request request = super.build();
        request.setRequestMethod(RequestMethod.GET);

        return request;
    }

    /**
     * Execute the request using the supplied client
     * @param client the client
     * @return The request
     */
    public EntityResponse execute(HyperionClient client)
    {
        return client.query(build());
    }
}