nyla.solutions.global.patterns.iteration.Pagination Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nyla.solutions.global Show documentation
Nyla Solutions Global Java API provides support for basic application utilities (application configuration, data encryption, debugger and text processing).
The newest version!
package nyla.solutions.global.patterns.iteration;

import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.Future;

import nyla.solutions.global.data.Identifier;
import nyla.solutions.global.exception.NoDataFoundException;
import nyla.solutions.global.exception.SetupException;
import nyla.solutions.global.exception.SystemException;
import nyla.solutions.global.operations.ClassPath;
import nyla.solutions.global.patterns.Disposable;
import nyla.solutions.global.patterns.creational.RowObjectCreator;
import nyla.solutions.global.util.Config;



/**
 * The pagination data
 * 
 * @author Gregory Green
 *
 */
public abstract class Pagination implements Identifier, Disposable
{
	/**
	 * Set id and save pagination
	 * @param id
	 */
	protected Pagination(String id)
	{
		this.id = id;
		this.save();
	}
	
	/**
	 * Store the given pagination data
	 * @param storeObject the object to store
	 * @param pageCriteria the page criteria
	 */
	public abstract  void store(ObjectType storeObject, PageCriteria pageCriteria);
	
    /**
     * Create a pagination instance
     * @return
     */
    public static  Pagination createPagination(PageCriteria pageCriteria)
    {
    	String id = pageCriteria.getId();
    	
    	if(id == null || id.length() == 0) 
    	{
    		return null;
    	}
    	Pagination pagination = ClassPath.newInstance(paginationClassName,String.class,pageCriteria.getId());
    	
    	paginationMap.put(id, pagination);
    	
    	return pagination;
		 
    	
    }// --------------------------------------------------------
    
	/**
	 * 
	 * @param dbCursor the results to page
	 */
	public abstract    
	void constructPaging(Iterator resultSet, PageCriteria pageCriteria, 
			RowObjectCreator creator);
	
	/**
	 * 
	 * @return his.getFuture().isDone();
	 */
	public void waitForCompletion()
	{
		try
		{
			Set> futures = this.getFutures();
			
			if(futures  == null)
				return;
			
			for (Future future : futures)
			{
				future.get();
			}
		}
		catch (Exception e)
		{
			throw new SystemException("Error while wating for results "+e.getMessage(),e);
		}
	}// --------------------------------------------------------
	/**
	 * 
	 * @param pageCriteria the page criteria
	 * @param aClass pagination
	 * @return
	 */
	public static Pagination getPaginationById(String id)
	{
		
		if(id == null)
			return null;
		
		return paginationMap.get(id);
		
	}// --------------------------------------------------------
	@Override
	public void dispose()
	{
		this.cancel();
		
		
		removePaginationById(this.getId());	
	}// --------------------------------------------------------
	/**
	 * 
	 * @param pageCriteria the page criteria
	 * @param aClass pagination
	 * @return
	 */
	public static Pagination getPagination(PageCriteria pageCriteria)
	{
	
		if(pageCriteria == null)
			return null;
		
		
		String id = pageCriteria.getId();

		
		Pagination pagination = getPaginationById(id);
		
		if(pagination == null)
		{
			//try to create pagination
			pagination = Pagination.createPagination(pageCriteria);
		}
		
		return pagination;
	}// -------------------------------------------------------

	protected   Pagination removePaginationById(String id)
	{
		return paginationMap.remove(id);
	}// --------------------------------------------------------
	/**
	 * 
	 * @param pageCriteria the page criteria
	 * @param pageClass the page Class
	 * @return the paging object
	 */
	public abstract Paging getPaging(PageCriteria pageCriteria, Class pageClass);
	
	/**
	 * 
	 * @param pageCriteria page criteria
	 * @return the Paging
	 */
	@SuppressWarnings({ "rawtypes", "unchecked" })
	public  Paging getPaging(PageCriteria pageCriteria)
	{
		try
		{	
			String className = pageCriteria.getClassName();
			
			Class classT = Class.forName(className);
			
			return (Paging)getPaging(pageCriteria, classT);
		}
		catch(ClassNotFoundException e)
		{
			throw new SetupException(e.getMessage(),e);
		}
	}// --------------------------------------------------------
	/**
	 * 
	 * @param pageCriteria
	 * @return
	 * @throws NoDataFoundException
	 */
	public abstract long count(PageCriteria pageCriteria);
	
	/**
	 * Clear previous page data
	 */
	public abstract void clear();
	
	
	/**
	 * Total size of pagination
	 * @return total size
	 */
	public abstract long size();
	
	
	/**
	 * Cancel the processing
	 */
	public abstract void cancel();

	/**
	 * 
	 * @return background paging thread state
	 */
	public abstract Set> getFutures();
	
	/**
	 * 
	 */
	private void save()
	{
		
		paginationMap.put(this.getId(), this);
	}// --------------------------------------------------------
	
	/**
	 * @return the id
	 */
	public final String getId()
	{
		return id;
	}

	/**
	 * @param id the id to set
	 */
	public final void setId(String id)
	{
		//Cannot change id
	}

	private static String paginationClassName = Config.getProperty(Pagination.class,"paginationClassName","nyla.solutions.dao.mongodb.MongoPagination");
	
	private final String id;
	private static Map paginationMap = new HashMap();
}