Java tutorial
/** * Copyright (c) 2000-present 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.liferay.pokedex.service.base; import aQute.bnd.annotation.ProviderType; import com.liferay.exportimport.kernel.lar.ExportImportHelperUtil; import com.liferay.exportimport.kernel.lar.ManifestSummary; import com.liferay.exportimport.kernel.lar.PortletDataContext; import com.liferay.exportimport.kernel.lar.StagedModelDataHandlerUtil; import com.liferay.exportimport.kernel.lar.StagedModelType; import com.liferay.pokedex.model.Pokemon; import com.liferay.pokedex.service.PokemonLocalService; import com.liferay.pokedex.service.persistence.PokemonPersistence; import com.liferay.portal.kernel.bean.BeanReference; import com.liferay.portal.kernel.dao.db.DB; import com.liferay.portal.kernel.dao.db.DBManagerUtil; import com.liferay.portal.kernel.dao.jdbc.SqlUpdate; import com.liferay.portal.kernel.dao.jdbc.SqlUpdateFactoryUtil; import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.DefaultActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.DynamicQuery; import com.liferay.portal.kernel.dao.orm.DynamicQueryFactoryUtil; import com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.Projection; import com.liferay.portal.kernel.exception.PortalException; import com.liferay.portal.kernel.exception.SystemException; import com.liferay.portal.kernel.model.PersistedModel; import com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService; import com.liferay.portal.kernel.search.Indexable; import com.liferay.portal.kernel.search.IndexableType; import com.liferay.portal.kernel.service.BaseLocalServiceImpl; import com.liferay.portal.kernel.service.PersistedModelLocalServiceRegistry; import com.liferay.portal.kernel.service.persistence.CompanyPersistence; import com.liferay.portal.kernel.service.persistence.GroupPersistence; import com.liferay.portal.kernel.service.persistence.UserPersistence; import com.liferay.portal.kernel.util.OrderByComparator; import com.liferay.portal.kernel.util.PortalUtil; import com.liferay.portal.spring.extender.service.ServiceReference; import java.io.Serializable; import java.util.List; import javax.sql.DataSource; /** * Provides the base implementation for the pokemon local service. * * <p> * This implementation exists only as a container for the default service methods generated by ServiceBuilder. All custom service methods should be put in {@link com.liferay.pokedex.service.impl.PokemonLocalServiceImpl}. * </p> * * @author Brian Wing Shun Chan * @see com.liferay.pokedex.service.impl.PokemonLocalServiceImpl * @see com.liferay.pokedex.service.PokemonLocalServiceUtil * @generated */ @ProviderType public abstract class PokemonLocalServiceBaseImpl extends BaseLocalServiceImpl implements PokemonLocalService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link com.liferay.pokedex.service.PokemonLocalServiceUtil} to access the pokemon local service. */ /** * Adds the pokemon to the database. Also notifies the appropriate model listeners. * * @param pokemon the pokemon * @return the pokemon that was added */ @Indexable(type = IndexableType.REINDEX) @Override public Pokemon addPokemon(Pokemon pokemon) { pokemon.setNew(true); return pokemonPersistence.update(pokemon); } /** * Creates a new pokemon with the primary key. Does not add the pokemon to the database. * * @param id the primary key for the new pokemon * @return the new pokemon */ @Override public Pokemon createPokemon(long id) { return pokemonPersistence.create(id); } /** * Deletes the pokemon with the primary key from the database. Also notifies the appropriate model listeners. * * @param id the primary key of the pokemon * @return the pokemon that was removed * @throws PortalException if a pokemon with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public Pokemon deletePokemon(long id) throws PortalException { return pokemonPersistence.remove(id); } /** * Deletes the pokemon from the database. Also notifies the appropriate model listeners. * * @param pokemon the pokemon * @return the pokemon that was removed */ @Indexable(type = IndexableType.DELETE) @Override public Pokemon deletePokemon(Pokemon pokemon) { return pokemonPersistence.remove(pokemon); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(Pokemon.class, clazz.getClassLoader()); } /** * Performs a dynamic query on the database and returns the matching rows. * * @param dynamicQuery the dynamic query * @return the matching rows */ @Override public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery) { return pokemonPersistence.findWithDynamicQuery(dynamicQuery); } /** * Performs a dynamic query on the database and returns a range of the matching rows. * * <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.liferay.pokedex.model.impl.PokemonModelImpl}. 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 dynamicQuery the dynamic query * @param start the lower bound of the range of model instances * @param end the upper bound of the range of model instances (not inclusive) * @return the range of matching rows */ @Override public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end) { return pokemonPersistence.findWithDynamicQuery(dynamicQuery, start, end); } /** * Performs a dynamic query on the database and returns an ordered range of the matching rows. * * <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.liferay.pokedex.model.impl.PokemonModelImpl}. 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 dynamicQuery the dynamic query * @param start the lower bound of the range of model instances * @param end the upper bound of the range of model instances (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the ordered range of matching rows */ @Override public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) { return pokemonPersistence.findWithDynamicQuery(dynamicQuery, start, end, orderByComparator); } /** * Returns the number of rows matching the dynamic query. * * @param dynamicQuery the dynamic query * @return the number of rows matching the dynamic query */ @Override public long dynamicQueryCount(DynamicQuery dynamicQuery) { return pokemonPersistence.countWithDynamicQuery(dynamicQuery); } /** * Returns the number of rows matching the dynamic query. * * @param dynamicQuery the dynamic query * @param projection the projection to apply to the query * @return the number of rows matching the dynamic query */ @Override public long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) { return pokemonPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public Pokemon fetchPokemon(long id) { return pokemonPersistence.fetchByPrimaryKey(id); } /** * Returns the pokemon matching the UUID and group. * * @param uuid the pokemon's UUID * @param groupId the primary key of the group * @return the matching pokemon, or <code>null</code> if a matching pokemon could not be found */ @Override public Pokemon fetchPokemonByUuidAndGroupId(String uuid, long groupId) { return pokemonPersistence.fetchByUUID_G(uuid, groupId); } /** * Returns the pokemon with the primary key. * * @param id the primary key of the pokemon * @return the pokemon * @throws PortalException if a pokemon with the primary key could not be found */ @Override public Pokemon getPokemon(long id) throws PortalException { return pokemonPersistence.findByPrimaryKey(id); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(pokemonLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Pokemon.class); actionableDynamicQuery.setPrimaryKeyPropertyName("id"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(pokemonLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(Pokemon.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("id"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery(ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(pokemonLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Pokemon.class); actionableDynamicQuery.setPrimaryKeyPropertyName("id"); } @Override public ExportActionableDynamicQuery getExportActionableDynamicQuery( final PortletDataContext portletDataContext) { final ExportActionableDynamicQuery exportActionableDynamicQuery = new ExportActionableDynamicQuery() { @Override public long performCount() throws PortalException { ManifestSummary manifestSummary = portletDataContext.getManifestSummary(); StagedModelType stagedModelType = getStagedModelType(); long modelAdditionCount = super.performCount(); manifestSummary.addModelAdditionCount(stagedModelType, modelAdditionCount); long modelDeletionCount = ExportImportHelperUtil.getModelDeletionCount(portletDataContext, stagedModelType); manifestSummary.addModelDeletionCount(stagedModelType, modelDeletionCount); return modelAdditionCount; } }; initActionableDynamicQuery(exportActionableDynamicQuery); exportActionableDynamicQuery.setAddCriteriaMethod(new ActionableDynamicQuery.AddCriteriaMethod() { @Override public void addCriteria(DynamicQuery dynamicQuery) { portletDataContext.addDateRangeCriteria(dynamicQuery, "modifiedDate"); } }); exportActionableDynamicQuery.setCompanyId(portletDataContext.getCompanyId()); exportActionableDynamicQuery .setPerformActionMethod(new ActionableDynamicQuery.PerformActionMethod<Pokemon>() { @Override public void performAction(Pokemon pokemon) throws PortalException { StagedModelDataHandlerUtil.exportStagedModel(portletDataContext, pokemon); } }); exportActionableDynamicQuery .setStagedModelType(new StagedModelType(PortalUtil.getClassNameId(Pokemon.class.getName()))); return exportActionableDynamicQuery; } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return pokemonLocalService.deletePokemon((Pokemon) persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return pokemonPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns all the pokemons matching the UUID and company. * * @param uuid the UUID of the pokemons * @param companyId the primary key of the company * @return the matching pokemons, or an empty list if no matches were found */ @Override public List<Pokemon> getPokemonsByUuidAndCompanyId(String uuid, long companyId) { return pokemonPersistence.findByUuid_C(uuid, companyId); } /** * Returns a range of pokemons matching the UUID and company. * * @param uuid the UUID of the pokemons * @param companyId the primary key of the company * @param start the lower bound of the range of pokemons * @param end the upper bound of the range of pokemons (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the range of matching pokemons, or an empty list if no matches were found */ @Override public List<Pokemon> getPokemonsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<Pokemon> orderByComparator) { return pokemonPersistence.findByUuid_C(uuid, companyId, start, end, orderByComparator); } /** * Returns the pokemon matching the UUID and group. * * @param uuid the pokemon's UUID * @param groupId the primary key of the group * @return the matching pokemon * @throws PortalException if a matching pokemon could not be found */ @Override public Pokemon getPokemonByUuidAndGroupId(String uuid, long groupId) throws PortalException { return pokemonPersistence.findByUUID_G(uuid, groupId); } /** * Returns a range of all the pokemons. * * <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.liferay.pokedex.model.impl.PokemonModelImpl}. 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 pokemons * @param end the upper bound of the range of pokemons (not inclusive) * @return the range of pokemons */ @Override public List<Pokemon> getPokemons(int start, int end) { return pokemonPersistence.findAll(start, end); } /** * Returns the number of pokemons. * * @return the number of pokemons */ @Override public int getPokemonsCount() { return pokemonPersistence.countAll(); } /** * Updates the pokemon in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param pokemon the pokemon * @return the pokemon that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public Pokemon updatePokemon(Pokemon pokemon) { return pokemonPersistence.update(pokemon); } /** * Returns the pokemon local service. * * @return the pokemon local service */ public PokemonLocalService getPokemonLocalService() { return pokemonLocalService; } /** * Sets the pokemon local service. * * @param pokemonLocalService the pokemon local service */ public void setPokemonLocalService(PokemonLocalService pokemonLocalService) { this.pokemonLocalService = pokemonLocalService; } /** * Returns the pokemon persistence. * * @return the pokemon persistence */ public PokemonPersistence getPokemonPersistence() { return pokemonPersistence; } /** * Sets the pokemon persistence. * * @param pokemonPersistence the pokemon persistence */ public void setPokemonPersistence(PokemonPersistence pokemonPersistence) { this.pokemonPersistence = pokemonPersistence; } /** * Returns the counter local service. * * @return the counter local service */ public com.liferay.counter.kernel.service.CounterLocalService getCounterLocalService() { return counterLocalService; } /** * Sets the counter local service. * * @param counterLocalService the counter local service */ public void setCounterLocalService(com.liferay.counter.kernel.service.CounterLocalService counterLocalService) { this.counterLocalService = counterLocalService; } /** * Returns the company local service. * * @return the company local service */ public com.liferay.portal.kernel.service.CompanyLocalService getCompanyLocalService() { return companyLocalService; } /** * Sets the company local service. * * @param companyLocalService the company local service */ public void setCompanyLocalService(com.liferay.portal.kernel.service.CompanyLocalService companyLocalService) { this.companyLocalService = companyLocalService; } /** * Returns the company persistence. * * @return the company persistence */ public CompanyPersistence getCompanyPersistence() { return companyPersistence; } /** * Sets the company persistence. * * @param companyPersistence the company persistence */ public void setCompanyPersistence(CompanyPersistence companyPersistence) { this.companyPersistence = companyPersistence; } /** * Returns the group local service. * * @return the group local service */ public com.liferay.portal.kernel.service.GroupLocalService getGroupLocalService() { return groupLocalService; } /** * Sets the group local service. * * @param groupLocalService the group local service */ public void setGroupLocalService(com.liferay.portal.kernel.service.GroupLocalService groupLocalService) { this.groupLocalService = groupLocalService; } /** * Returns the group persistence. * * @return the group persistence */ public GroupPersistence getGroupPersistence() { return groupPersistence; } /** * Sets the group persistence. * * @param groupPersistence the group persistence */ public void setGroupPersistence(GroupPersistence groupPersistence) { this.groupPersistence = groupPersistence; } /** * Returns the user local service. * * @return the user local service */ public com.liferay.portal.kernel.service.UserLocalService getUserLocalService() { return userLocalService; } /** * Sets the user local service. * * @param userLocalService the user local service */ public void setUserLocalService(com.liferay.portal.kernel.service.UserLocalService userLocalService) { this.userLocalService = userLocalService; } /** * Returns the user persistence. * * @return the user persistence */ public UserPersistence getUserPersistence() { return userPersistence; } /** * Sets the user persistence. * * @param userPersistence the user persistence */ public void setUserPersistence(UserPersistence userPersistence) { this.userPersistence = userPersistence; } public void afterPropertiesSet() { persistedModelLocalServiceRegistry.register("com.liferay.pokedex.model.Pokemon", pokemonLocalService); } public void destroy() { persistedModelLocalServiceRegistry.unregister("com.liferay.pokedex.model.Pokemon"); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return PokemonLocalService.class.getName(); } protected Class<?> getModelClass() { return Pokemon.class; } protected String getModelClassName() { return Pokemon.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = pokemonPersistence.getDataSource(); DB db = DBManagerUtil.getDB(); sql = db.buildSQL(sql); sql = PortalUtil.transformSQL(sql); SqlUpdate sqlUpdate = SqlUpdateFactoryUtil.getSqlUpdate(dataSource, sql); sqlUpdate.update(); } catch (Exception e) { throw new SystemException(e); } } @BeanReference(type = PokemonLocalService.class) protected PokemonLocalService pokemonLocalService; @BeanReference(type = PokemonPersistence.class) protected PokemonPersistence pokemonPersistence; @ServiceReference(type = com.liferay.counter.kernel.service.CounterLocalService.class) protected com.liferay.counter.kernel.service.CounterLocalService counterLocalService; @ServiceReference(type = com.liferay.portal.kernel.service.CompanyLocalService.class) protected com.liferay.portal.kernel.service.CompanyLocalService companyLocalService; @ServiceReference(type = CompanyPersistence.class) protected CompanyPersistence companyPersistence; @ServiceReference(type = com.liferay.portal.kernel.service.GroupLocalService.class) protected com.liferay.portal.kernel.service.GroupLocalService groupLocalService; @ServiceReference(type = GroupPersistence.class) protected GroupPersistence groupPersistence; @ServiceReference(type = com.liferay.portal.kernel.service.UserLocalService.class) protected com.liferay.portal.kernel.service.UserLocalService userLocalService; @ServiceReference(type = UserPersistence.class) protected UserPersistence userPersistence; @ServiceReference(type = PersistedModelLocalServiceRegistry.class) protected PersistedModelLocalServiceRegistry persistedModelLocalServiceRegistry; }