com.threewks.thundr.gae.objectify.repository.Repository Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thundr-gae Show documentation
A thundr module enabling thundr for use on GAE (Google App Engine)
There is a newer version: 3.0.0
/*
 * This file is a component of thundr, a software library from 3wks.
 * Read more: http://3wks.github.io/thundr/
 * Copyright (C) 2015 3wks, 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.threewks.thundr.gae.objectify.repository;

import java.util.List;

import com.threewks.thundr.search.Search;

/**
 * A base interface for the Repository pattern.
 * 
 * @param  The entity type
 * @param  The key type of the entity
 */
public interface Repository {
	public AsyncResult save(final E entity);

	/**
	 * Save the given entities.
	 * 
	 * @param entities
	 * @return an async result to complete the save operation
	 */
	@SuppressWarnings("unchecked")
	public AsyncResult> save(E... entities);

	/**
	 * Save the given entities.
	 * 
	 * @param entities
	 * @return an async result to complete the save operation
	 */
	public AsyncResult> save(final List entities);

	/**
	 * Load the entity with the given id
	 * 
	 * @param key
	 * @return the entity, or null if no entity exists
	 */
	public E load(K key);

	/**
	 * Load the entities with the given ids
	 * 
	 * @param keys
	 * @return a list containing an entry for each corresponding id, containing the entity or null if none exists
	 */
	@SuppressWarnings("unchecked")
	public List load(K... keys);

	/**
	 * Load the entities with the given ids
	 * 
	 * @param keys
	 * @return a list containing an entry for each corresponding id, containing the entity or null if none exists
	 */
	public List load(Iterable keys);

	/**
	 * List up to count entities.
	 * This will load all entities into memory, so should only be used where the number of entities is constrained.
	 * 
	 * @param count
	 * @return
	 */
	public List list(int count);

	/**
	 * Load all entities whose field has the value of the given object.
	 * Note that the given field must be indexed for anything to be returned.
	 * This will load all entities into memory, so should only be used where the number of entities is constrained.
	 * 
	 * @param field
	 * @param value
	 * @return
	 */
	public List loadByField(String field, Object value);

	/**
	 * Load all entities who field has the values of any of the given objects.
	 * Note that the given field must be indexed for anything to be returned.
	 * This will load all entities into memory, so should only be used where the number of entities is constrained.
	 * 
	 * @param field
	 * @param values
	 * @return
	 */
	public List loadByField(String field, List values);

	/**
	 * @return a builder for a search operation
	 */
	public Search search();

	/**
	 * Delete the entity with the given id
	 * 
	 * @param key
	 * @return an async operation used to complete the delete operation
	 */
	public AsyncResult deleteByKey(K key);

	/**
	 * Delete the entities with the given ids
	 * 
	 * @param keys
	 * @return an async operation used to complete the delete operation
	 */
	@SuppressWarnings("unchecked")
	public AsyncResult deleteByKey(K... keys);

	/**
	 * Delete the entities with the given ids
	 * 
	 * @param ids
	 * @return an async operation used to complete the delete operation
	 */
	public AsyncResult deleteByKey(Iterable ids);

	/**
	 * Delete the given entity
	 * 
	 * @param entity
	 * @return an async operation used to complete the delete operation
	 */
	public AsyncResult delete(E entity);

	/**
	 * Delete the given entities
	 * 
	 * @param entities
	 * @return an async operation used to complete the delete operation
	 */
	@SuppressWarnings("unchecked")
	public AsyncResult delete(E... entities);

	/**
	 * Delete the given entities
	 * 
	 * @param entities
	 * @return an async operation used to complete the delete operation
	 */
	public AsyncResult delete(Iterable entities);

	/**
	 * Reindexes all the entities matching the given search operation. The given {@link ReindexOperation}, if present
	 * will be applied to each batch of entities.
	 * 
	 * Note: this will only update the index of entities that have previously been indexed. If your entities do not
	 * currently exist in the search index use {@link #reindex(List, int, ReindexOperation)}.
	 *
	 * @param search
	 * @param batchSize
	 * @param reindexOperation
	 * @return the overall count of re-indexed entities.
	 */
	public int reindex(Search search, int batchSize, ReindexOperation reindexOperation);

	/**
	 * Reindexes all the entities matching the given list of keys. The given {@link ReindexOperation}, if present will
	 * be applied to each batch of entities.
	 *
	 * @param keys
	 * @param batchSize
	 * @param reindexOperation
	 * @return the overall count of re-indexed entities.
	 */
	public int reindex(List keys, int batchSize, ReindexOperation reindexOperation);
}