com.arangodb.BaseCursorProxy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of arangodb-java-driver Show documentation
ArangoDB Java Driver
There is a newer version: 7.15.0
package com.arangodb;

import java.util.Iterator;
import java.util.List;

import com.arangodb.entity.DocumentEntity;

/**
 * @author a-brandt
 */
public class BaseCursorProxy> implements Iterable {

	private DocumentCursorResult baseCursor;

	public BaseCursorProxy(DocumentCursorResult baseCursor) {
		this.baseCursor = baseCursor;
	}

	@Override
	public Iterator iterator() {
		return baseCursor.iterator();
	}

	/**
	 * Returns an iterator over a entity set of elements of type T.
	 * 
	 * @return an Iterator.
	 */
	public Iterator entityIterator() {
		return baseCursor.entityIterator();
	}

	/**
	 * Returns the DocumentEntity objects as a list
	 * 
	 * @return list of DocumentEntity objects
	 */
	public List asList() {
		return baseCursor.asList();
	}

	/**
	 * Returns the entities of DocumentEntity objects as a list
	 * 
	 * @return list of DocumentEntity objects
	 */
	public List asEntityList() {
		return baseCursor.asEntityList();
	}

	/**
	 * Close cursor (removes cursor from database)
	 * 
	 * @throws ArangoException
	 */
	public void close() throws ArangoException {
		baseCursor.close();
	}

	/**
	 * Get total number of results (if requested)
	 * 
	 * @return total number of results
	 */
	public int getCount() {
		return baseCursor.getCount();
	}

	/**
	 * Get total number of results for queries with LIMIT clause
	 * 
	 * @return total number of results
	 */
	public int getFullCount() {
		return baseCursor.getFullCount();
	}

	/**
	 * Return a single instance that matches the query, or null if the query
	 * returns no results.
	 * 
	 * Throws NonUniqueResultException (RuntimeException) if there is more than
	 * one matching result
	 * 
	 * @return the single result or null
	 */
	public S getUniqueResult() {
		return baseCursor.getUniqueResult();
	}

	/**
	 * If the resource has been modified it returns true
	 *
	 * @return boolean
	 */
	public boolean isNotModified() {
		return baseCursor.getEntity().isNotModified();
	}

	public int getCode() {
		return baseCursor.getEntity().getCode();
	}

	public int getStatusCode() {
		return baseCursor.getEntity().getStatusCode();
	}

	public String getRequestId() {
		return baseCursor.getEntity().getRequestId();
	}

	/**
	 * Returns true if the cursor can load more data from the database
	 * 
	 * @return true, if the cursor can load more data from the database
	 */
	public boolean hasMore() {
		return baseCursor.getEntity().hasMore();
	}

	/**
	 * Returns the cursor identifier
	 * 
	 * @return the cursor identifier
	 */
	public Long getCursorId() {
		return baseCursor.getEntity().getCursorId();
	}

	/**
	 * a boolean flag indicating whether the query result was served from the
	 * query cache or not. If the query result is served from the query cache,
	 * the extra return attribute will not contain any stats sub-attribute and
	 * no profile sub-attribute. (since ArangoDB 2.7)
	 * 
	 * @return true, if the result is cached
	 * 
	 */
	public boolean isCached() {
		return baseCursor.getEntity().isCached();
	}

}