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.micro.maintainance.analysis.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.micro.maintainance.analysis.model.AnalysisEntry; import com.liferay.micro.maintainance.analysis.service.AnalysisEntryLocalService; import com.liferay.micro.maintainance.analysis.service.persistence.AnalysisEntryPersistence; import com.liferay.micro.maintainance.analysis.service.persistence.AnalysisUserPersistence; 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.ClassNamePersistence; 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 analysis entry 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.micro.maintainance.analysis.service.impl.AnalysisEntryLocalServiceImpl}. * </p> * * @author Brian Wing Shun Chan * @see com.liferay.micro.maintainance.analysis.service.impl.AnalysisEntryLocalServiceImpl * @see com.liferay.micro.maintainance.analysis.service.AnalysisEntryLocalServiceUtil * @generated */ @ProviderType public abstract class AnalysisEntryLocalServiceBaseImpl extends BaseLocalServiceImpl implements AnalysisEntryLocalService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link com.liferay.micro.maintainance.analysis.service.AnalysisEntryLocalServiceUtil} to access the analysis entry local service. */ /** * Adds the analysis entry to the database. Also notifies the appropriate model listeners. * * @param analysisEntry the analysis entry * @return the analysis entry that was added */ @Indexable(type = IndexableType.REINDEX) @Override public AnalysisEntry addAnalysisEntry(AnalysisEntry analysisEntry) { analysisEntry.setNew(true); return analysisEntryPersistence.update(analysisEntry); } /** * Creates a new analysis entry with the primary key. Does not add the analysis entry to the database. * * @param analysisEntryId the primary key for the new analysis entry * @return the new analysis entry */ @Override public AnalysisEntry createAnalysisEntry(long analysisEntryId) { return analysisEntryPersistence.create(analysisEntryId); } /** * Deletes the analysis entry with the primary key from the database. Also notifies the appropriate model listeners. * * @param analysisEntryId the primary key of the analysis entry * @return the analysis entry that was removed * @throws PortalException if a analysis entry with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public AnalysisEntry deleteAnalysisEntry(long analysisEntryId) throws PortalException { return analysisEntryPersistence.remove(analysisEntryId); } /** * Deletes the analysis entry from the database. Also notifies the appropriate model listeners. * * @param analysisEntry the analysis entry * @return the analysis entry that was removed */ @Indexable(type = IndexableType.DELETE) @Override public AnalysisEntry deleteAnalysisEntry(AnalysisEntry analysisEntry) { return analysisEntryPersistence.remove(analysisEntry); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(AnalysisEntry.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 analysisEntryPersistence.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.micro.maintainance.analysis.model.impl.AnalysisEntryModelImpl}. 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 analysisEntryPersistence.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.micro.maintainance.analysis.model.impl.AnalysisEntryModelImpl}. 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 analysisEntryPersistence.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 analysisEntryPersistence.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 analysisEntryPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public AnalysisEntry fetchAnalysisEntry(long analysisEntryId) { return analysisEntryPersistence.fetchByPrimaryKey(analysisEntryId); } /** * Returns the analysis entry with the matching UUID and company. * * @param uuid the analysis entry's UUID * @param companyId the primary key of the company * @return the matching analysis entry, or <code>null</code> if a matching analysis entry could not be found */ @Override public AnalysisEntry fetchAnalysisEntryByUuidAndCompanyId(String uuid, long companyId) { return analysisEntryPersistence.fetchByUuid_C_First(uuid, companyId, null); } /** * Returns the analysis entry with the primary key. * * @param analysisEntryId the primary key of the analysis entry * @return the analysis entry * @throws PortalException if a analysis entry with the primary key could not be found */ @Override public AnalysisEntry getAnalysisEntry(long analysisEntryId) throws PortalException { return analysisEntryPersistence.findByPrimaryKey(analysisEntryId); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(analysisEntryLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(AnalysisEntry.class); actionableDynamicQuery.setPrimaryKeyPropertyName("analysisEntryId"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(analysisEntryLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(AnalysisEntry.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("analysisEntryId"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery(ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(analysisEntryLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(AnalysisEntry.class); actionableDynamicQuery.setPrimaryKeyPropertyName("analysisEntryId"); } @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<AnalysisEntry>() { @Override public void performAction(AnalysisEntry analysisEntry) throws PortalException { StagedModelDataHandlerUtil.exportStagedModel(portletDataContext, analysisEntry); } }); exportActionableDynamicQuery .setStagedModelType(new StagedModelType(PortalUtil.getClassNameId(AnalysisEntry.class.getName()))); return exportActionableDynamicQuery; } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return analysisEntryLocalService.deleteAnalysisEntry((AnalysisEntry) persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return analysisEntryPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns the analysis entry with the matching UUID and company. * * @param uuid the analysis entry's UUID * @param companyId the primary key of the company * @return the matching analysis entry * @throws PortalException if a matching analysis entry could not be found */ @Override public AnalysisEntry getAnalysisEntryByUuidAndCompanyId(String uuid, long companyId) throws PortalException { return analysisEntryPersistence.findByUuid_C_First(uuid, companyId, null); } /** * Returns a range of all the analysis entries. * * <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.micro.maintainance.analysis.model.impl.AnalysisEntryModelImpl}. 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 analysis entries * @param end the upper bound of the range of analysis entries (not inclusive) * @return the range of analysis entries */ @Override public List<AnalysisEntry> getAnalysisEntries(int start, int end) { return analysisEntryPersistence.findAll(start, end); } /** * Returns the number of analysis entries. * * @return the number of analysis entries */ @Override public int getAnalysisEntriesCount() { return analysisEntryPersistence.countAll(); } /** * Updates the analysis entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param analysisEntry the analysis entry * @return the analysis entry that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public AnalysisEntry updateAnalysisEntry(AnalysisEntry analysisEntry) { return analysisEntryPersistence.update(analysisEntry); } /** * Returns the analysis entry local service. * * @return the analysis entry local service */ public AnalysisEntryLocalService getAnalysisEntryLocalService() { return analysisEntryLocalService; } /** * Sets the analysis entry local service. * * @param analysisEntryLocalService the analysis entry local service */ public void setAnalysisEntryLocalService(AnalysisEntryLocalService analysisEntryLocalService) { this.analysisEntryLocalService = analysisEntryLocalService; } /** * Returns the analysis entry persistence. * * @return the analysis entry persistence */ public AnalysisEntryPersistence getAnalysisEntryPersistence() { return analysisEntryPersistence; } /** * Sets the analysis entry persistence. * * @param analysisEntryPersistence the analysis entry persistence */ public void setAnalysisEntryPersistence(AnalysisEntryPersistence analysisEntryPersistence) { this.analysisEntryPersistence = analysisEntryPersistence; } /** * Returns the analysis user local service. * * @return the analysis user local service */ public com.liferay.micro.maintainance.analysis.service.AnalysisUserLocalService getAnalysisUserLocalService() { return analysisUserLocalService; } /** * Sets the analysis user local service. * * @param analysisUserLocalService the analysis user local service */ public void setAnalysisUserLocalService( com.liferay.micro.maintainance.analysis.service.AnalysisUserLocalService analysisUserLocalService) { this.analysisUserLocalService = analysisUserLocalService; } /** * Returns the analysis user persistence. * * @return the analysis user persistence */ public AnalysisUserPersistence getAnalysisUserPersistence() { return analysisUserPersistence; } /** * Sets the analysis user persistence. * * @param analysisUserPersistence the analysis user persistence */ public void setAnalysisUserPersistence(AnalysisUserPersistence analysisUserPersistence) { this.analysisUserPersistence = analysisUserPersistence; } /** * 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 class name local service. * * @return the class name local service */ public com.liferay.portal.kernel.service.ClassNameLocalService getClassNameLocalService() { return classNameLocalService; } /** * Sets the class name local service. * * @param classNameLocalService the class name local service */ public void setClassNameLocalService( com.liferay.portal.kernel.service.ClassNameLocalService classNameLocalService) { this.classNameLocalService = classNameLocalService; } /** * Returns the class name persistence. * * @return the class name persistence */ public ClassNamePersistence getClassNamePersistence() { return classNamePersistence; } /** * Sets the class name persistence. * * @param classNamePersistence the class name persistence */ public void setClassNamePersistence(ClassNamePersistence classNamePersistence) { this.classNamePersistence = classNamePersistence; } /** * Returns the resource local service. * * @return the resource local service */ public com.liferay.portal.kernel.service.ResourceLocalService getResourceLocalService() { return resourceLocalService; } /** * Sets the resource local service. * * @param resourceLocalService the resource local service */ public void setResourceLocalService( com.liferay.portal.kernel.service.ResourceLocalService resourceLocalService) { this.resourceLocalService = resourceLocalService; } /** * 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.micro.maintainance.analysis.model.AnalysisEntry", analysisEntryLocalService); } public void destroy() { persistedModelLocalServiceRegistry .unregister("com.liferay.micro.maintainance.analysis.model.AnalysisEntry"); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return AnalysisEntryLocalService.class.getName(); } protected Class<?> getModelClass() { return AnalysisEntry.class; } protected String getModelClassName() { return AnalysisEntry.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = analysisEntryPersistence.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 = AnalysisEntryLocalService.class) protected AnalysisEntryLocalService analysisEntryLocalService; @BeanReference(type = AnalysisEntryPersistence.class) protected AnalysisEntryPersistence analysisEntryPersistence; @BeanReference(type = com.liferay.micro.maintainance.analysis.service.AnalysisUserLocalService.class) protected com.liferay.micro.maintainance.analysis.service.AnalysisUserLocalService analysisUserLocalService; @BeanReference(type = AnalysisUserPersistence.class) protected AnalysisUserPersistence analysisUserPersistence; @ServiceReference(type = com.liferay.counter.kernel.service.CounterLocalService.class) protected com.liferay.counter.kernel.service.CounterLocalService counterLocalService; @ServiceReference(type = com.liferay.portal.kernel.service.ClassNameLocalService.class) protected com.liferay.portal.kernel.service.ClassNameLocalService classNameLocalService; @ServiceReference(type = ClassNamePersistence.class) protected ClassNamePersistence classNamePersistence; @ServiceReference(type = com.liferay.portal.kernel.service.ResourceLocalService.class) protected com.liferay.portal.kernel.service.ResourceLocalService resourceLocalService; @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; }