com.microsoft.azure.documentdb.QueryIterable Maven / Gradle / Ivy

Go to download
package com.microsoft.azure.documentdb;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import com.microsoft.azure.documentdb.internal.ResourceType;
import com.microsoft.azure.documentdb.internal.Utils;
import com.microsoft.azure.documentdb.internal.query.QueryExecutionContext;
import com.microsoft.azure.documentdb.internal.query.QueryExecutionContextFactory;

/**
 * This is the template class for iterable resources in the Azure Cosmos DB database service.
 *
 * @param 
 *            the resource type of the query iterable.
 */
public class QueryIterable implements Iterable {
    private final DocumentClient client;
    private final ResourceType resourceType;
    private final Class classT;
    private final SqlQuerySpec querySpec;
    private final FeedOptionsBase options;
    private final String resourceLink;
    private final Object partitionKey;
    private QueryExecutionContext queryExecutionContext;

    protected QueryIterable(DocumentClient client, ResourceType resourceType, Class classT, String resourceLink,
            FeedOptionsBase options) {
        this(client, resourceType, classT, resourceLink, null, options, null);
    }

    protected QueryIterable(DocumentClient client, ResourceType resourceType, Class classT, String resourceLink,
            SqlQuerySpec querySpec, FeedOptionsBase options) {
        this(client, resourceType, classT, resourceLink, querySpec, options, null);
    }
    
    protected QueryIterable(DocumentClient client, ResourceType resourceType, Class classT, String resourceLink,
            FeedOptionsBase options, Object partitionKey) {
        this(client, resourceType, classT, resourceLink, null, options, partitionKey);
                }
        
    protected QueryIterable(DocumentClient client, ResourceType resourceType, Class classT, String resourceLink,
            SqlQuerySpec querySpec, FeedOptionsBase options, Object partitionKey) {
        this.client = client;
        this.resourceType = resourceType;
        this.classT = classT;
        this.querySpec = querySpec;
        if (options == null) {
            options = new FeedOptions();
        }
        
        this.options = options;
        this.resourceLink = resourceLink;
        this.partitionKey = partitionKey;
        this.reset();
    }
    
    @SuppressWarnings("deprecation")
    private QueryExecutionContext createQueryExecutionContext(DocumentClient client, ResourceType resourceType,
            Class classT, String resourceLink, SqlQuerySpec querySpec, FeedOptionsBase options, Object partitionKey) {
        PartitionResolver partitionResolver;
        if (resourceType == ResourceType.Document && Utils.isDatabaseLink(resourceLink)
                && ((partitionResolver = client.getPartitionResolver(resourceLink)) != null)) {
            return QueryExecutionContextFactory.createQueryExecutionContext(new DocumentQueryClientInternal(client),
                    resourceType, classT, querySpec, options, partitionResolver.resolveForRead(partitionKey));
        }
    
        return QueryExecutionContextFactory.createQueryExecutionContext(new DocumentQueryClientInternal(client), resourceType,
                classT, querySpec, options, resourceLink);
            }

    /**
     * Gets the response headers.
     * 
     * @return the response headers.
     */
    public Map getResponseHeaders() {
        return this.queryExecutionContext.getResponseHeaders();
    }

    /**
     * Gets the iterator of the iterable.
     * 
     * @return the iterator.
     */
    @Override
    public Iterator iterator() {
        return this.queryExecutionContext;
    }

    /**
     * Get the list of the iterable resources.
     * 
     * @return the list of the iterable resources.
     */
    public List toList() {
        List list = new ArrayList();
        for (T t : this) {
            if (t == null) {
                continue;
            }

            list.add(t);
        }

        return list;
    }

    /**
     * Resets the iterable.
     */
    public void reset() {
        this.queryExecutionContext = this.createQueryExecutionContext(this.client, this.resourceType, this.classT,
                this.resourceLink, this.querySpec, this.options, this.partitionKey);
    }

    /**
     * Fetch the next block of query results.
     * 
     * @return the list of fetched resources.
     * @throws DocumentClientException
     *             the document client exception.
     */
    public List fetchNextBlock() throws DocumentClientException {
        return this.queryExecutionContext.fetchNextBlock();
    }
  
}