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.NoSuchContactException; import com.bcnet.portlet.biobank.model.Contact; import com.bcnet.portlet.biobank.model.impl.ContactImpl; import com.bcnet.portlet.biobank.model.impl.ContactModelImpl; 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 contact service. * * <p> * Caching information and settings can be found in <code>portal.properties</code> * </p> * * @author suyama * @see ContactPersistence * @see ContactUtil * @generated */ public class ContactPersistenceImpl extends BasePersistenceImpl<Contact> implements ContactPersistence { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link ContactUtil} to access the contact persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this class. */ public static final String FINDER_CLASS_NAME_ENTITY = ContactImpl.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( ContactModelImpl.ENTITY_CACHE_ENABLED, ContactModelImpl.FINDER_CACHE_ENABLED, ContactImpl.class, FINDER_CLASS_NAME_LIST_WITH_PAGINATION, "findAll", new String[0]); public static final FinderPath FINDER_PATH_WITHOUT_PAGINATION_FIND_ALL = new FinderPath( ContactModelImpl.ENTITY_CACHE_ENABLED, ContactModelImpl.FINDER_CACHE_ENABLED, ContactImpl.class, FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION, "findAll", new String[0]); public static final FinderPath FINDER_PATH_COUNT_ALL = new FinderPath(ContactModelImpl.ENTITY_CACHE_ENABLED, ContactModelImpl.FINDER_CACHE_ENABLED, Long.class, FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION, "countAll", new String[0]); public ContactPersistenceImpl() { setModelClass(Contact.class); } /** * Caches the contact in the entity cache if it is enabled. * * @param contact the contact */ @Override public void cacheResult(Contact contact) { EntityCacheUtil.putResult(ContactModelImpl.ENTITY_CACHE_ENABLED, ContactImpl.class, contact.getPrimaryKey(), contact); contact.resetOriginalValues(); } /** * Caches the contacts in the entity cache if it is enabled. * * @param contacts the contacts */ @Override public void cacheResult(List<Contact> contacts) { for (Contact contact : contacts) { if (EntityCacheUtil.getResult(ContactModelImpl.ENTITY_CACHE_ENABLED, ContactImpl.class, contact.getPrimaryKey()) == null) { cacheResult(contact); } else { contact.resetOriginalValues(); } } } /** * Clears the cache for all contacts. * * <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(ContactImpl.class.getName()); } EntityCacheUtil.clearCache(ContactImpl.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 contact. * * <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(Contact contact) { EntityCacheUtil.removeResult(ContactModelImpl.ENTITY_CACHE_ENABLED, ContactImpl.class, contact.getPrimaryKey()); FinderCacheUtil.clearCache(FINDER_CLASS_NAME_LIST_WITH_PAGINATION); FinderCacheUtil.clearCache(FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION); } @Override public void clearCache(List<Contact> contacts) { FinderCacheUtil.clearCache(FINDER_CLASS_NAME_LIST_WITH_PAGINATION); FinderCacheUtil.clearCache(FINDER_CLASS_NAME_LIST_WITHOUT_PAGINATION); for (Contact contact : contacts) { EntityCacheUtil.removeResult(ContactModelImpl.ENTITY_CACHE_ENABLED, ContactImpl.class, contact.getPrimaryKey()); } } /** * Creates a new contact with the primary key. Does not add the contact to the database. * * @param contactId the primary key for the new contact * @return the new contact */ @Override public Contact create(long contactId) { Contact contact = new ContactImpl(); contact.setNew(true); contact.setPrimaryKey(contactId); return contact; } /** * Removes the contact with the primary key from the database. Also notifies the appropriate model listeners. * * @param contactId the primary key of the contact * @return the contact that was removed * @throws com.bcnet.portlet.biobank.NoSuchContactException if a contact with the primary key could not be found * @throws SystemException if a system exception occurred */ @Override public Contact remove(long contactId) throws NoSuchContactException, SystemException { return remove((Serializable) contactId); } /** * Removes the contact with the primary key from the database. Also notifies the appropriate model listeners. * * @param primaryKey the primary key of the contact * @return the contact that was removed * @throws com.bcnet.portlet.biobank.NoSuchContactException if a contact with the primary key could not be found * @throws SystemException if a system exception occurred */ @Override public Contact remove(Serializable primaryKey) throws NoSuchContactException, SystemException { Session session = null; try { session = openSession(); Contact contact = (Contact) session.get(ContactImpl.class, primaryKey); if (contact == null) { if (_log.isWarnEnabled()) { _log.warn(_NO_SUCH_ENTITY_WITH_PRIMARY_KEY + primaryKey); } throw new NoSuchContactException(_NO_SUCH_ENTITY_WITH_PRIMARY_KEY + primaryKey); } return remove(contact); } catch (NoSuchContactException nsee) { throw nsee; } catch (Exception e) { throw processException(e); } finally { closeSession(session); } } @Override protected Contact removeImpl(Contact contact) throws SystemException { contact = toUnwrappedModel(contact); Session session = null; try { session = openSession(); if (!session.contains(contact)) { contact = (Contact) session.get(ContactImpl.class, contact.getPrimaryKeyObj()); } if (contact != null) { session.delete(contact); } } catch (Exception e) { throw processException(e); } finally { closeSession(session); } if (contact != null) { clearCache(contact); } return contact; } @Override public Contact updateImpl(com.bcnet.portlet.biobank.model.Contact contact) throws SystemException { contact = toUnwrappedModel(contact); boolean isNew = contact.isNew(); Session session = null; try { session = openSession(); if (contact.isNew()) { session.save(contact); contact.setNew(false); } else { session.merge(contact); } } 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(ContactModelImpl.ENTITY_CACHE_ENABLED, ContactImpl.class, contact.getPrimaryKey(), contact); return contact; } protected Contact toUnwrappedModel(Contact contact) { if (contact instanceof ContactImpl) { return contact; } ContactImpl contactImpl = new ContactImpl(); contactImpl.setNew(contact.isNew()); contactImpl.setPrimaryKey(contact.getPrimaryKey()); contactImpl.setContactId(contact.getContactId()); contactImpl.setFirstName(contact.getFirstName()); contactImpl.setLastName(contact.getLastName()); contactImpl.setPhone(contact.getPhone()); contactImpl.setEmail(contact.getEmail()); contactImpl.setAddress(contact.getAddress()); contactImpl.setZip(contact.getZip()); contactImpl.setCity(contact.getCity()); contactImpl.setCountryCode(contact.getCountryCode()); contactImpl.setJuristicPersonId(contact.getJuristicPersonId()); contactImpl.setDepartment(contact.getDepartment()); contactImpl.setOrcId(contact.getOrcId()); return contactImpl; } /** * Returns the contact 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 contact * @return the contact * @throws com.bcnet.portlet.biobank.NoSuchContactException if a contact with the primary key could not be found * @throws SystemException if a system exception occurred */ @Override public Contact findByPrimaryKey(Serializable primaryKey) throws NoSuchContactException, SystemException { Contact contact = fetchByPrimaryKey(primaryKey); if (contact == null) { if (_log.isWarnEnabled()) { _log.warn(_NO_SUCH_ENTITY_WITH_PRIMARY_KEY + primaryKey); } throw new NoSuchContactException(_NO_SUCH_ENTITY_WITH_PRIMARY_KEY + primaryKey); } return contact; } /** * Returns the contact with the primary key or throws a {@link com.bcnet.portlet.biobank.NoSuchContactException} if it could not be found. * * @param contactId the primary key of the contact * @return the contact * @throws com.bcnet.portlet.biobank.NoSuchContactException if a contact with the primary key could not be found * @throws SystemException if a system exception occurred */ @Override public Contact findByPrimaryKey(long contactId) throws NoSuchContactException, SystemException { return findByPrimaryKey((Serializable) contactId); } /** * Returns the contact with the primary key or returns <code>null</code> if it could not be found. * * @param primaryKey the primary key of the contact * @return the contact, or <code>null</code> if a contact with the primary key could not be found * @throws SystemException if a system exception occurred */ @Override public Contact fetchByPrimaryKey(Serializable primaryKey) throws SystemException { Contact contact = (Contact) EntityCacheUtil.getResult(ContactModelImpl.ENTITY_CACHE_ENABLED, ContactImpl.class, primaryKey); if (contact == _nullContact) { return null; } if (contact == null) { Session session = null; try { session = openSession(); contact = (Contact) session.get(ContactImpl.class, primaryKey); if (contact != null) { cacheResult(contact); } else { EntityCacheUtil.putResult(ContactModelImpl.ENTITY_CACHE_ENABLED, ContactImpl.class, primaryKey, _nullContact); } } catch (Exception e) { EntityCacheUtil.removeResult(ContactModelImpl.ENTITY_CACHE_ENABLED, ContactImpl.class, primaryKey); throw processException(e); } finally { closeSession(session); } } return contact; } /** * Returns the contact with the primary key or returns <code>null</code> if it could not be found. * * @param contactId the primary key of the contact * @return the contact, or <code>null</code> if a contact with the primary key could not be found * @throws SystemException if a system exception occurred */ @Override public Contact fetchByPrimaryKey(long contactId) throws SystemException { return fetchByPrimaryKey((Serializable) contactId); } /** * Returns all the contacts. * * @return the contacts * @throws SystemException if a system exception occurred */ @Override public List<Contact> findAll() throws SystemException { return findAll(QueryUtil.ALL_POS, QueryUtil.ALL_POS, null); } /** * Returns a range of all the contacts. * * <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.ContactModelImpl}. 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 contacts * @param end the upper bound of the range of contacts (not inclusive) * @return the range of contacts * @throws SystemException if a system exception occurred */ @Override public List<Contact> findAll(int start, int end) throws SystemException { return findAll(start, end, null); } /** * Returns an ordered range of all the contacts. * * <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.ContactModelImpl}. 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 contacts * @param end the upper bound of the range of contacts (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the ordered range of contacts * @throws SystemException if a system exception occurred */ @Override public List<Contact> 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<Contact> list = (List<Contact>) 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_CONTACT); appendOrderByComparator(query, _ORDER_BY_ENTITY_ALIAS, orderByComparator); sql = query.toString(); } else { sql = _SQL_SELECT_CONTACT; if (pagination) { sql = sql.concat(ContactModelImpl.ORDER_BY_JPQL); } } Session session = null; try { session = openSession(); Query q = session.createQuery(sql); if (!pagination) { list = (List<Contact>) QueryUtil.list(q, getDialect(), start, end, false); Collections.sort(list); list = new UnmodifiableList<Contact>(list); } else { list = (List<Contact>) 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 contacts from the database. * * @throws SystemException if a system exception occurred */ @Override public void removeAll() throws SystemException { for (Contact contact : findAll()) { remove(contact); } } /** * Returns the number of contacts. * * @return the number of contacts * @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_CONTACT); 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 contact persistence. */ public void afterPropertiesSet() { String[] listenerClassNames = StringUtil.split(GetterUtil.getString(com.liferay.util.service.ServiceProps .get("value.object.listener.com.bcnet.portlet.biobank.model.Contact"))); if (listenerClassNames.length > 0) { try { List<ModelListener<Contact>> listenersList = new ArrayList<ModelListener<Contact>>(); for (String listenerClassName : listenerClassNames) { listenersList.add((ModelListener<Contact>) InstanceFactory.newInstance(getClassLoader(), listenerClassName)); } listeners = listenersList.toArray(new ModelListener[listenersList.size()]); } catch (Exception e) { _log.error(e); } } } public void destroy() { EntityCacheUtil.removeCache(ContactImpl.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_CONTACT = "SELECT contact FROM Contact contact"; private static final String _SQL_COUNT_CONTACT = "SELECT COUNT(contact) FROM Contact contact"; private static final String _ORDER_BY_ENTITY_ALIAS = "contact."; private static final String _NO_SUCH_ENTITY_WITH_PRIMARY_KEY = "No Contact 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(ContactPersistenceImpl.class); private static Contact _nullContact = new ContactImpl() { @Override public Object clone() { return this; } @Override public CacheModel<Contact> toCacheModel() { return _nullContactCacheModel; } }; private static CacheModel<Contact> _nullContactCacheModel = new CacheModel<Contact>() { @Override public Contact toEntityModel() { return _nullContact; } }; }