com.avaje.ebeaninternal.api.LoadManyRequest Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation
Ebean
The newest version!
/**
 * Copyright (C) 2009 Authors
 * 
 * This file is part of Ebean.
 * 
 * Ebean is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *  
 * Ebean 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Ebean; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA  
 */
package com.avaje.ebeaninternal.api;

import java.util.List;

import com.avaje.ebean.Transaction;
import com.avaje.ebean.bean.BeanCollection;

/**
 * Request for loading Associated One Beans.
 */
public class LoadManyRequest extends LoadRequest {


	private final List> batch;

	private final LoadManyContext loadContext;

	private final boolean onlyIds;
	
	private final boolean loadCache;
	
	public LoadManyRequest(LoadManyContext loadContext,
			List> batch, Transaction transaction,
			int batchSize, boolean lazy, boolean onlyIds, boolean loadCache) {

		super(transaction, batchSize, lazy);
		this.loadContext = loadContext;
		this.batch = batch;
		this.onlyIds = onlyIds;
		this.loadCache = loadCache;
	}

	public String getDescription() {
		String fullPath = loadContext.getFullPath();
		String s = "path:" + fullPath + " batch:" + batchSize + " actual:"
				+ batch.size();
		return s;
	}

	/**
	 * Return the batch of collections to actually load.
	 */
	public List> getBatch() {
		return batch;
	}

	/**
	 * Return the load context.
	 */
	public LoadManyContext getLoadContext() {
		return loadContext;
	}

	/**
	 * Return true if lazy loading should only load the id values.
	 * 
	 * This for use when lazy loading is invoked on methods such
	 * as clear() and removeAll() where it generally makes sense to
	 * only fetch the Id values as the other property information is 
	 * not used.
	 * 
	 */
	public boolean isOnlyIds() {
		return onlyIds;
	}

	/**
	 * Return true if we should load the Collection ids into the cache.
	 */
	public boolean isLoadCache() {
    	return loadCache;
    }
	
}