br.com.arsmachina.controller.impl.ControllerImpl Maven / Gradle / Ivy

Go to download
// Copyright 2008-2013 Thiago H. de Paula Figueiredo
//
// 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 br.com.arsmachina.controller.impl;

import java.io.Serializable;
import java.util.List;

import br.com.arsmachina.controller.Controller;
import br.com.arsmachina.dao.DAO;
import br.com.arsmachina.dao.SortCriterion;

/**
 * Abstract class that implements the {@link Controller} interface by delegating all method calls to
 * a {@link DAO} passed through its constructor.
 * 
 * @author Thiago H. de Paula Figueiredo
 * @param  the entity class related to this controller.
 * @param  the type of the field that represents the entity class' primary key.
 */
public abstract class ControllerImpl implements Controller {

	private ReadableControllerImpl readableController;

	private WriteableControllerImpl writeableController;

	/**
	 * Single constructor of this class.
	 * 
	 * @param dao a {@link DAO}. It cannot be null.
	 */
	public ControllerImpl(DAO dao) {

		if (dao == null) {
			throw new IllegalArgumentException("Parameter dao cannot be null");
		}

		readableController = new InternalReadableController(dao);
		writeableController = new InternalWriteableController(dao);

	}

	/**
	 * Invokes dao.countAll().
	 * @return
	 * @see br.com.arsmachina.controller.impl.ReadableControllerImpl#countAll()
	 */
	public long countAll() {
		return readableController.countAll();
	}

	/**
	 * Invokes dao.findAll().
	 * @return
	 * @see br.com.arsmachina.controller.impl.ReadableControllerImpl#findAll()
	 */
	public List findAll() {
		return readableController.findAll();
	}

	/**
	 * Invokes dao.findAll().
	 * @param firstResult
	 * @param maxResults
	 * @param sortCriteria
	 * @return
	 * @see br.com.arsmachina.controller.impl.ReadableControllerImpl#findAll(int, int, br.com.arsmachina.dao.SortCriterion[])
	 */
	public List findAll(int firstResult, int maxResults, SortCriterion... sortCriteria) {
		return readableController.findAll(firstResult, maxResults, sortCriteria);
	}

	/**
	 * Invokes dao.findByExample().
	 * @param example
	 * @return
	 * @see br.com.arsmachina.controller.impl.ReadableControllerImpl#findByExample(java.lang.Object)
	 */
	public List findByExample(T example) {
		return readableController.findByExample(example);
	}

	/**
	 * Invokes dao.findById().
	 * @param id
	 * @return
	 * @see br.com.arsmachina.controller.impl.ReadableControllerImpl#findById(java.io.Serializable)
	 */
	public T findById(K id) {
		return readableController.findById(id);
	}

	/**
	 * Invokes dao.findByIds().
	 * @param ids
	 * @return
	 * @see br.com.arsmachina.controller.impl.ReadableControllerImpl#findByIds(K[])
	 */
	public List findByIds(K... ids) {
		return readableController.findByIds(ids);
	}

	/**
	 * Invokes dao.refresh().
	 * @param object
	 * @see br.com.arsmachina.controller.impl.ReadableControllerImpl#refresh(java.lang.Object)
	 */
	public T refresh(T object) {
		return readableController.refresh(object);
	}

	/**
	 * Invokes dao.delete().
	 * @param id
	 * @see br.com.arsmachina.controller.impl.WriteableControllerImpl#delete(java.io.Serializable)
	 */
	public void delete(K id) {
		writeableController.delete(id);
	}

	/**
	 * Invokes dao.delete().
	 * @param object
	 * @see br.com.arsmachina.controller.impl.WriteableControllerImpl#delete(java.lang.Object)
	 */
	public void delete(T object) {
		writeableController.delete(object);
	}

	/**
	 * Invokes dao.evict().
	 * @param object
	 * @see br.com.arsmachina.controller.impl.WriteableControllerImpl#evict(java.lang.Object)
	 */
	public void evict(T object) {
		writeableController.evict(object);
	}

	/**
	 * Invokes dao.isPersistent().
	 * @param object
	 * @return
	 * @see br.com.arsmachina.controller.impl.WriteableControllerImpl#isPersistent(java.lang.Object)
	 */
	public boolean isPersistent(T object) {
		return writeableController.isPersistent(object);
	}

	/**
	 * Invokes dao.save().
	 * @param object
	 * @see br.com.arsmachina.controller.impl.WriteableControllerImpl#save(java.lang.Object)
	 */
	public void save(T object) {
		writeableController.save(object);
	}

	/**
	 * Invokes {@link #save(Object)} if the object is persistent and {@link #update(Object)}
	 * otherwise. The object is considered persistent if {@link #isPersistent(Object)} returns
	 * true.
	 * 
	 * @param object a T.
	 */
	public T saveOrUpdate(T object) {

		if (isPersistent(object)) {
			return update(object);
		}
		else {
			save(object);
			return object;
		}
		
	}

	/**
	 * Invokes dao.update().
	 * @param object
	 * @see br.com.arsmachina.controller.impl.WriteableControllerImpl#update(java.lang.Object)
	 */
	public T update(T object) {
		return writeableController.update(object);
	}
	
	/**
	 * Invokes dao.reattach().
	 * @param object
	 * @return
	 * @see br.com.arsmachina.controller.ReadableController#reattach(java.lang.Object)
	 */
	public T reattach(T object) {
		return readableController.reattach(object);
	}

	/**
	 * Concrete {@link ReadableControllerImpl} subclass.
	 * 
	 * @author Thiago H. de Paula Figueiredo
	 */
	private final class InternalReadableController extends ReadableControllerImpl {

		/**
		 * @param dao
		 */
		public InternalReadableController(DAO dao) {
			super(dao);
		}

	}

	/**
	 * Concrete {@link WriteableControllerImpl} subclass.
	 * 
	 * @author Thiago H. de Paula Figueiredo
	 */
	private final class InternalWriteableController extends WriteableControllerImpl {

		/**
		 * @param dao
		 */
		public InternalWriteableController(DAO dao) {
			super(dao);
		}

	}

}