Java tutorial
/** * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved. * * This library 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. * * This library 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. */ package com.bcnet.portlet.biobank.service.persistence; import com.bcnet.portlet.biobank.NoSuchCountryException; import com.bcnet.portlet.biobank.model.Country; import com.bcnet.portlet.biobank.model.impl.CountryImpl; import com.bcnet.portlet.biobank.model.impl.CountryModelImpl; import com.liferay.portal.kernel.cache.CacheRegistryUtil; import com.liferay.portal.kernel.dao.orm.EntityCacheUtil; import com.liferay.portal.kernel.dao.orm.FinderCacheUtil; import com.liferay.portal.kernel.dao.orm.FinderPath; import com.liferay.portal.kernel.dao.orm.Query; import com.liferay.portal.kernel.dao.orm.QueryUtil; import com.liferay.portal.kernel.dao.orm.Session; import com.liferay.portal.kernel.exception.SystemException; import com.liferay.portal.kernel.log.Log; import com.liferay.portal.kernel.log.LogFactoryUtil; import com.liferay.portal.kernel.util.GetterUtil; import com.liferay.portal.kernel.util.InstanceFactory; import com.liferay.portal.kernel.util.OrderByComparator; import com.liferay.portal.kernel.util.PropsKeys; import com.liferay.portal.kernel.util.PropsUtil; import com.liferay.portal.kernel.util.StringBundler; import com.liferay.portal.kernel.util.StringUtil; import com.liferay.portal.kernel.util.UnmodifiableList; import com.liferay.portal.model.CacheModel; import com.liferay.portal.model.ModelListener; import com.liferay.portal.service.persistence.impl.BasePersistenceImpl; import java.io.Serializable; import java.util.ArrayList; import java.util.Collections; import java.util.List; /** * The persistence implementation for the country service. * * <p> * Caching information and settings can be found in <code>portal.properties</code> * </p> * * @author suyama * @see CountryPersistence * @see CountryUtil * @generated */ public class CountryPersistenceImpl extends BasePersistenceImpl<Country> implements CountryPersistence { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link CountryUtil} to access the country persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this class. */ public static final String FINDER_CLASS_NAME_ENTITY = CountryImpl.class.getName(); public static final String FINDER_CLASS_NAME_LIST_WITH_PAGINATION = FINDER_CLASS_NAME_ENTITY + ".List1"; public static final String FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION = FINDER_CLASS_NAME_ENTITY + ".List2"; public static final FinderPath FINDER_PATH_WITH_PAGINATION_FIND_ALL = new FinderPath( CountryModelImpl.ENTITY_CACHE_ENABLED, CountryModelImpl.FINDER_CACHE_ENABLED, CountryImpl.class, FINDER_CLASS_NAME_LIST_WITH_PAGINATION, "findAll", new String[0]); public static final FinderPath FINDER_PATH_WITHOUT_PAGINATION_FIND_ALL = new FinderPath( CountryModelImpl.ENTITY_CACHE_ENABLED, CountryModelImpl.FINDER_CACHE_ENABLED, CountryImpl.class, FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION, "findAll", new String[0]); public static final FinderPath FINDER_PATH_COUNT_ALL = new FinderPath(CountryModelImpl.ENTITY_CACHE_ENABLED, CountryModelImpl.FINDER_CACHE_ENABLED, Long.class, FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION, "countAll", new String[0]); public CountryPersistenceImpl() { setModelClass(Country.class); } /** * Caches the country in the entity cache if it is enabled. * * @param country the country */ @Override public void cacheResult(Country country) { EntityCacheUtil.putResult(CountryModelImpl.ENTITY_CACHE_ENABLED, CountryImpl.class, country.getPrimaryKey(), country); country.resetOriginalValues(); } /** * Caches the countries in the entity cache if it is enabled. * * @param countries the countries */ @Override public void cacheResult(List<Country> countries) { for (Country country : countries) { if (EntityCacheUtil.getResult(CountryModelImpl.ENTITY_CACHE_ENABLED, CountryImpl.class, country.getPrimaryKey()) == null) { cacheResult(country); } else { country.resetOriginalValues(); } } } /** * Clears the cache for all countries. * * <p> * The {@link com.liferay.portal.kernel.dao.orm.EntityCache} and {@link com.liferay.portal.kernel.dao.orm.FinderCache} are both cleared by this method. * </p> */ @Override public void clearCache() { if (_HIBERNATE_CACHE_USE_SECOND_LEVEL_CACHE) { CacheRegistryUtil.clear(CountryImpl.class.getName()); } EntityCacheUtil.clearCache(CountryImpl.class.getName()); FinderCacheUtil.clearCache(FINDER_CLASS_NAME_ENTITY); FinderCacheUtil.clearCache(FINDER_CLASS_NAME_LIST_WITH_PAGINATION); FinderCacheUtil.clearCache(FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION); } /** * Clears the cache for the country. * * <p> * The {@link com.liferay.portal.kernel.dao.orm.EntityCache} and {@link com.liferay.portal.kernel.dao.orm.FinderCache} are both cleared by this method. * </p> */ @Override public void clearCache(Country country) { EntityCacheUtil.removeResult(CountryModelImpl.ENTITY_CACHE_ENABLED, CountryImpl.class, country.getPrimaryKey()); FinderCacheUtil.clearCache(FINDER_CLASS_NAME_LIST_WITH_PAGINATION); FinderCacheUtil.clearCache(FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION); } @Override public void clearCache(List<Country> countries) { FinderCacheUtil.clearCache(FINDER_CLASS_NAME_LIST_WITH_PAGINATION); FinderCacheUtil.clearCache(FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION); for (Country country : countries) { EntityCacheUtil.removeResult(CountryModelImpl.ENTITY_CACHE_ENABLED, CountryImpl.class, country.getPrimaryKey()); } } /** * Creates a new country with the primary key. Does not add the country to the database. * * @param countryCode the primary key for the new country * @return the new country */ @Override public Country create(String countryCode) { Country country = new CountryImpl(); country.setNew(true); country.setPrimaryKey(countryCode); return country; } /** * Removes the country with the primary key from the database. Also notifies the appropriate model listeners. * * @param countryCode the primary key of the country * @return the country that was removed * @throws com.bcnet.portlet.biobank.NoSuchCountryException if a country with the primary key could not be found * @throws SystemException if a system exception occurred */ @Override public Country remove(String countryCode) throws NoSuchCountryException, SystemException { return remove((Serializable) countryCode); } /** * Removes the country with the primary key from the database. Also notifies the appropriate model listeners. * * @param primaryKey the primary key of the country * @return the country that was removed * @throws com.bcnet.portlet.biobank.NoSuchCountryException if a country with the primary key could not be found * @throws SystemException if a system exception occurred */ @Override public Country remove(Serializable primaryKey) throws NoSuchCountryException, SystemException { Session session = null; try { session = openSession(); Country country = (Country) session.get(CountryImpl.class, primaryKey); if (country == null) { if (_log.isWarnEnabled()) { _log.warn(_NO_SUCH_ENTITY_WITH_PRIMARY_KEY + primaryKey); } throw new NoSuchCountryException(_NO_SUCH_ENTITY_WITH_PRIMARY_KEY + primaryKey); } return remove(country); } catch (NoSuchCountryException nsee) { throw nsee; } catch (Exception e) { throw processException(e); } finally { closeSession(session); } } @Override protected Country removeImpl(Country country) throws SystemException { country = toUnwrappedModel(country); Session session = null; try { session = openSession(); if (!session.contains(country)) { country = (Country) session.get(CountryImpl.class, country.getPrimaryKeyObj()); } if (country != null) { session.delete(country); } } catch (Exception e) { throw processException(e); } finally { closeSession(session); } if (country != null) { clearCache(country); } return country; } @Override public Country updateImpl(com.bcnet.portlet.biobank.model.Country country) throws SystemException { country = toUnwrappedModel(country); boolean isNew = country.isNew(); Session session = null; try { session = openSession(); if (country.isNew()) { session.save(country); country.setNew(false); } else { session.merge(country); } } catch (Exception e) { throw processException(e); } finally { closeSession(session); } FinderCacheUtil.clearCache(FINDER_CLASS_NAME_LIST_WITH_PAGINATION); if (isNew) { FinderCacheUtil.clearCache(FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION); } EntityCacheUtil.putResult(CountryModelImpl.ENTITY_CACHE_ENABLED, CountryImpl.class, country.getPrimaryKey(), country); return country; } protected Country toUnwrappedModel(Country country) { if (country instanceof CountryImpl) { return country; } CountryImpl countryImpl = new CountryImpl(); countryImpl.setNew(country.isNew()); countryImpl.setPrimaryKey(country.getPrimaryKey()); countryImpl.setCountryCode(country.getCountryCode()); countryImpl.setName(country.getName()); return countryImpl; } /** * Returns the country with the primary key or throws a {@link com.liferay.portal.NoSuchModelException} if it could not be found. * * @param primaryKey the primary key of the country * @return the country * @throws com.bcnet.portlet.biobank.NoSuchCountryException if a country with the primary key could not be found * @throws SystemException if a system exception occurred */ @Override public Country findByPrimaryKey(Serializable primaryKey) throws NoSuchCountryException, SystemException { Country country = fetchByPrimaryKey(primaryKey); if (country == null) { if (_log.isWarnEnabled()) { _log.warn(_NO_SUCH_ENTITY_WITH_PRIMARY_KEY + primaryKey); } throw new NoSuchCountryException(_NO_SUCH_ENTITY_WITH_PRIMARY_KEY + primaryKey); } return country; } /** * Returns the country with the primary key or throws a {@link com.bcnet.portlet.biobank.NoSuchCountryException} if it could not be found. * * @param countryCode the primary key of the country * @return the country * @throws com.bcnet.portlet.biobank.NoSuchCountryException if a country with the primary key could not be found * @throws SystemException if a system exception occurred */ @Override public Country findByPrimaryKey(String countryCode) throws NoSuchCountryException, SystemException { return findByPrimaryKey((Serializable) countryCode); } /** * Returns the country with the primary key or returns <code>null</code> if it could not be found. * * @param primaryKey the primary key of the country * @return the country, or <code>null</code> if a country with the primary key could not be found * @throws SystemException if a system exception occurred */ @Override public Country fetchByPrimaryKey(Serializable primaryKey) throws SystemException { Country country = (Country) EntityCacheUtil.getResult(CountryModelImpl.ENTITY_CACHE_ENABLED, CountryImpl.class, primaryKey); if (country == _nullCountry) { return null; } if (country == null) { Session session = null; try { session = openSession(); country = (Country) session.get(CountryImpl.class, primaryKey); if (country != null) { cacheResult(country); } else { EntityCacheUtil.putResult(CountryModelImpl.ENTITY_CACHE_ENABLED, CountryImpl.class, primaryKey, _nullCountry); } } catch (Exception e) { EntityCacheUtil.removeResult(CountryModelImpl.ENTITY_CACHE_ENABLED, CountryImpl.class, primaryKey); throw processException(e); } finally { closeSession(session); } } return country; } /** * Returns the country with the primary key or returns <code>null</code> if it could not be found. * * @param countryCode the primary key of the country * @return the country, or <code>null</code> if a country with the primary key could not be found * @throws SystemException if a system exception occurred */ @Override public Country fetchByPrimaryKey(String countryCode) throws SystemException { return fetchByPrimaryKey((Serializable) countryCode); } /** * Returns all the countries. * * @return the countries * @throws SystemException if a system exception occurred */ @Override public List<Country> findAll() throws SystemException { return findAll(QueryUtil.ALL_POS, QueryUtil.ALL_POS, null); } /** * Returns a range of all the countries. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.bcnet.portlet.biobank.model.impl.CountryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. * </p> * * @param start the lower bound of the range of countries * @param end the upper bound of the range of countries (not inclusive) * @return the range of countries * @throws SystemException if a system exception occurred */ @Override public List<Country> findAll(int start, int end) throws SystemException { return findAll(start, end, null); } /** * Returns an ordered range of all the countries. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.bcnet.portlet.biobank.model.impl.CountryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. * </p> * * @param start the lower bound of the range of countries * @param end the upper bound of the range of countries (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the ordered range of countries * @throws SystemException if a system exception occurred */ @Override public List<Country> findAll(int start, int end, OrderByComparator orderByComparator) throws SystemException { boolean pagination = true; FinderPath finderPath = null; Object[] finderArgs = null; if ((start == QueryUtil.ALL_POS) && (end == QueryUtil.ALL_POS) && (orderByComparator == null)) { pagination = false; finderPath = FINDER_PATH_WITHOUT_PAGINATION_FIND_ALL; finderArgs = FINDER_ARGS_EMPTY; } else { finderPath = FINDER_PATH_WITH_PAGINATION_FIND_ALL; finderArgs = new Object[] { start, end, orderByComparator }; } List<Country> list = (List<Country>) FinderCacheUtil.getResult(finderPath, finderArgs, this); if (list == null) { StringBundler query = null; String sql = null; if (orderByComparator != null) { query = new StringBundler(2 + (orderByComparator.getOrderByFields().length * 3)); query.append(_SQL_SELECT_COUNTRY); appendOrderByComparator(query, _ORDER_BY_ENTITY_ALIAS, orderByComparator); sql = query.toString(); } else { sql = _SQL_SELECT_COUNTRY; if (pagination) { sql = sql.concat(CountryModelImpl.ORDER_BY_JPQL); } } Session session = null; try { session = openSession(); Query q = session.createQuery(sql); if (!pagination) { list = (List<Country>) QueryUtil.list(q, getDialect(), start, end, false); Collections.sort(list); list = new UnmodifiableList<Country>(list); } else { list = (List<Country>) QueryUtil.list(q, getDialect(), start, end); } cacheResult(list); FinderCacheUtil.putResult(finderPath, finderArgs, list); } catch (Exception e) { FinderCacheUtil.removeResult(finderPath, finderArgs); throw processException(e); } finally { closeSession(session); } } return list; } /** * Removes all the countries from the database. * * @throws SystemException if a system exception occurred */ @Override public void removeAll() throws SystemException { for (Country country : findAll()) { remove(country); } } /** * Returns the number of countries. * * @return the number of countries * @throws SystemException if a system exception occurred */ @Override public int countAll() throws SystemException { Long count = (Long) FinderCacheUtil.getResult(FINDER_PATH_COUNT_ALL, FINDER_ARGS_EMPTY, this); if (count == null) { Session session = null; try { session = openSession(); Query q = session.createQuery(_SQL_COUNT_COUNTRY); count = (Long) q.uniqueResult(); FinderCacheUtil.putResult(FINDER_PATH_COUNT_ALL, FINDER_ARGS_EMPTY, count); } catch (Exception e) { FinderCacheUtil.removeResult(FINDER_PATH_COUNT_ALL, FINDER_ARGS_EMPTY); throw processException(e); } finally { closeSession(session); } } return count.intValue(); } /** * Initializes the country persistence. */ public void afterPropertiesSet() { String[] listenerClassNames = StringUtil.split(GetterUtil.getString(com.liferay.util.service.ServiceProps .get("value.object.listener.com.bcnet.portlet.biobank.model.Country"))); if (listenerClassNames.length > 0) { try { List<ModelListener<Country>> listenersList = new ArrayList<ModelListener<Country>>(); for (String listenerClassName : listenerClassNames) { listenersList.add((ModelListener<Country>) InstanceFactory.newInstance(getClassLoader(), listenerClassName)); } listeners = listenersList.toArray(new ModelListener[listenersList.size()]); } catch (Exception e) { _log.error(e); } } } public void destroy() { EntityCacheUtil.removeCache(CountryImpl.class.getName()); FinderCacheUtil.removeCache(FINDER_CLASS_NAME_ENTITY); FinderCacheUtil.removeCache(FINDER_CLASS_NAME_LIST_WITH_PAGINATION); FinderCacheUtil.removeCache(FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION); } private static final String _SQL_SELECT_COUNTRY = "SELECT country FROM Country country"; private static final String _SQL_COUNT_COUNTRY = "SELECT COUNT(country) FROM Country country"; private static final String _ORDER_BY_ENTITY_ALIAS = "country."; private static final String _NO_SUCH_ENTITY_WITH_PRIMARY_KEY = "No Country exists with the primary key "; private static final boolean _HIBERNATE_CACHE_USE_SECOND_LEVEL_CACHE = GetterUtil .getBoolean(PropsUtil.get(PropsKeys.HIBERNATE_CACHE_USE_SECOND_LEVEL_CACHE)); private static Log _log = LogFactoryUtil.getLog(CountryPersistenceImpl.class); private static Country _nullCountry = new CountryImpl() { @Override public Object clone() { return this; } @Override public CacheModel<Country> toCacheModel() { return _nullCountryCacheModel; } }; private static CacheModel<Country> _nullCountryCacheModel = new CacheModel<Country>() { @Override public Country toEntityModel() { return _nullCountry; } }; }