• Home
• se.l4.silo
• silo-api
• 0.2.3
• source code
• ObjectEntity.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

se.l4.silo.structured.ObjectEntity Maven / Gradle / Ivy

package se.l4.silo.structured;

import java.util.Optional;

import se.l4.silo.Entity;
import se.l4.silo.FetchResult;
import se.l4.silo.query.Query;
import se.l4.silo.query.QueryType;

/**
 * Entity for storing and retrieving objects.
 *
 * @author Andreas Holstenson
 *
 * @param 
 */
public interface ObjectEntity
	extends Entity
{
	/**
	 * Get an object.
	 *
	 * @param id
	 * @return
	 */
	Optional get(Object id);

	/**
	 * Delete the given object.
	 *
	 * @param id
	 */
	void deleteViaId(Object id);

	/**
	 * Delete the given object.
	 *
	 * @param object
	 *   the object to delete
	 */
	void delete(T object);

	/**
	 * Store an object.
	 *
	 * @param data
	 */
	void store(T data);

	/**
	 * Query the the query engine.
	 *
	 * @param index
	 * @return
	 */
	> Q query(String engine, QueryType type);

	/**
	 * Stream all of the objects stored in this entity.
	 *
	 * @return
	 */
	FetchResult stream();
}