Liferay7 BPM门户开发之41: Expando API入门
Posted 昕友软件开发
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Liferay7 BPM门户开发之41: Expando API入门相关的知识，希望对你有一定的参考价值。
Expando 是liferay的一种自定义表格扩展的方式,从5.0就已存在 , 可以在运行时新建表格\\字段\\行\\值.
这是一种Service Builder之外的轻量级替代扩展方式,不必像Service Builder那么繁琐,
实现的具体技术实际上是列转行,其中ExpandoValue有点像Activiti的act_ru_variable
主要有4种接口,分别是表\\行\\列\\值
- ExpandoTableLocalServiceUtil
- ExpandoRowLocalServiceUtil
- ExpandoColumnLocalServiceUtil
- ExpandoValueLocalServiceUtil
Demo
long classNameId = ClassNameLocalServiceUtil.getClassNameId(User.class.getName());
//新建表NewTable1
ThemeDisplay themeDisplay = (ThemeDisplay)actionRequest.getAttribute(
WebKeys.THEME_DISPLAY);
ExpandoTableLocalServiceUtil.addTable(themeDisplay.getCompanyId(),classNameId, "NewTable1");
//新建行
User user = themeDisplay.getUser();
ExpandoTable expandoTable = ExpandoTableLocalServiceUtil.getTable(themeDisplay.getCompanyId(), classNameId, "NewTable1");
ExpandoRowLocalServiceUtil.addRow(expandoTable.getTableId(), user.getUserId());
//增加一个字段
ExpandoColumn expandoColumn = ExpandoColumnLocalServiceUtil.addColumn(expandoTable.getTableId(), "MyUserColumn", ExpandoColumnConstants.STRING);
//新建值
ExpandoValueLocalServiceUtil.addValue(classNameId, expandoTable.getTableId(),expandoColumn.getColumnId(), user.getUserId(), "MyUserColumnDataValue123...");
其中的classPK就是控制唯一主键的值( 在程序中是user.getUserId() ).
需要注意的是每次添加值之前必须先添加行
注意在新建行addRow操作时,如果插入重复的键值就会触发异常
ExpandoValueLocalServiceUtil代码:
/** * 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.expando.kernel.service; import aQute.bnd.annotation.ProviderType; import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; import com.liferay.portal.kernel.util.ReferenceRegistry; /** * Provides the local service utility for ExpandoValue. This utility wraps * {@link com.liferay.portlet.expando.service.impl.ExpandoValueLocalServiceImpl} and is the * primary access point for service operations in application layer code running * on the local server. Methods of this service will not have security checks * based on the propagated JAAS credentials because this service can only be * accessed from within the same VM. * * @author Brian Wing Shun Chan * @see ExpandoValueLocalService * @see com.liferay.portlet.expando.service.base.ExpandoValueLocalServiceBaseImpl * @see com.liferay.portlet.expando.service.impl.ExpandoValueLocalServiceImpl * @generated */ @ProviderType public class ExpandoValueLocalServiceUtil { /* * NOTE FOR DEVELOPERS: * * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.expando.service.impl.ExpandoValueLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. */ /** * Adds the expando value to the database. Also notifies the appropriate model listeners. * * @param expandoValue the expando value * @return the expando value that was added */ public static com.liferay.expando.kernel.model.ExpandoValue addExpandoValue( com.liferay.expando.kernel.model.ExpandoValue expandoValue) { return getService().addExpandoValue(expandoValue); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long classNameId, long tableId, long columnId, long classPK, java.lang.String data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(classNameId, tableId, columnId, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, float data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, boolean data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, java.lang.Number data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, java.lang.Object data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, int data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, java.lang.Number[] data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, double[] data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, long data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, short data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, int[] data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, java.util.Date data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, short[] data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, long[] data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, java.util.Date[] data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, float[] data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, double data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, java.lang.String[] data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, java.lang.String data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, boolean[] data) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, data); } public static com.liferay.expando.kernel.model.ExpandoValue addValue( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, java.util.Map<java.util.Locale, ?> dataMap, java.util.Locale defautlLocale) throws com.liferay.portal.kernel.exception.PortalException { return getService() .addValue(companyId, className, tableName, columnName, classPK, dataMap, defautlLocale); } public static void addValues(long classNameId, long tableId, java.util.List<com.liferay.expando.kernel.model.ExpandoColumn> columns, long classPK, java.util.Map<java.lang.String, java.lang.String> data) throws com.liferay.portal.kernel.exception.PortalException { getService().addValues(classNameId, tableId, columns, classPK, data); } public static void addValues(long companyId, java.lang.String className, java.lang.String tableName, long classPK, java.util.Map<java.lang.String, java.io.Serializable> attributes) throws com.liferay.portal.kernel.exception.PortalException { getService() .addValues(companyId, className, tableName, classPK, attributes); } public static void addValues(long companyId, long classNameId, java.lang.String tableName, long classPK, java.util.Map<java.lang.String, java.io.Serializable> attributes) throws com.liferay.portal.kernel.exception.PortalException { getService() .addValues(companyId, classNameId, tableName, classPK, attributes); } /** * Creates a new expando value with the primary key. Does not add the expando value to the database. * * @param valueId the primary key for the new expando value * @return the new expando value */ public static com.liferay.expando.kernel.model.ExpandoValue createExpandoValue( long valueId) { return getService().createExpandoValue(valueId); } public static void deleteColumnValues(long columnId) { getService().deleteColumnValues(columnId); } /** * Deletes the expando value from the database. Also notifies the appropriate model listeners. * * @param expandoValue the expando value * @return the expando value that was removed */ public static com.liferay.expando.kernel.model.ExpandoValue deleteExpandoValue( com.liferay.expando.kernel.model.ExpandoValue expandoValue) { return getService().deleteExpandoValue(expandoValue); } /** * Deletes the expando value with the primary key from the database. Also notifies the appropriate model listeners. * * @param valueId the primary key of the expando value * @return the expando value that was removed * @throws PortalException if a expando value with the primary key could not be found */ public static com.liferay.expando.kernel.model.ExpandoValue deleteExpandoValue( long valueId) throws com.liferay.portal.kernel.exception.PortalException { return getService().deleteExpandoValue(valueId); } /** * @throws PortalException */ public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel( com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException { return getService().deletePersistedModel(persistedModel); } public static void deleteRowValues(long rowId) { getService().deleteRowValues(rowId); } public static void deleteTableValues(long tableId) { getService().deleteTableValues(tableId); } public static void deleteValue(long columnId, long rowId) throws com.liferay.portal.kernel.exception.PortalException { getService().deleteValue(columnId, rowId); } public static void deleteValue(long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK) throws com.liferay.portal.kernel.exception.PortalException { getService() .deleteValue(companyId, className, tableName, columnName, classPK); } public static void deleteValue(long companyId, long classNameId, java.lang.String tableName, java.lang.String columnName, long classPK) throws com.liferay.portal.kernel.exception.PortalException { getService() .deleteValue(companyId, classNameId, tableName, columnName, classPK); } public static void deleteValue( com.liferay.expando.kernel.model.ExpandoValue value) { getService().deleteValue(value); } public static void deleteValue(long valueId) throws com.liferay.portal.kernel.exception.PortalException { getService().deleteValue(valueId); } public static void deleteValues(java.lang.String className, long classPK) { getService().deleteValues(className, classPK); } public static void deleteValues(long classNameId, long classPK) { getService().deleteValues(classNameId, classPK); } public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { return getService().dynamicQuery(); } /** * Performs a dynamic query on the database and returns the matching rows. * * @param dynamicQuery the dynamic query * @return the matching rows */ public static <T> java.util.List<T> dynamicQuery( com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { return getService().dynamicQuery(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.portlet.expando.model.impl.ExpandoValueModelImpl}. 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 */ public static <T> java.util.List<T> dynamicQuery( com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) { return getService().dynamicQuery(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.portlet.expando.model.impl.ExpandoValueModelImpl}. 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 */ public static <T> java.util.List<T> dynamicQuery( com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) { return getService() .dynamicQuery(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 */ public static long dynamicQueryCount( com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { return getService().dynamicQueryCount(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 */ public static long dynamicQueryCount( com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) { return getService().dynamicQueryCount(dynamicQuery, projection); } public static com.liferay.expando.kernel.model.ExpandoValue fetchExpandoValue( long valueId) { return getService().fetchExpandoValue(valueId); } public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() { return getService().getActionableDynamicQuery(); } public static java.util.List<com.liferay.expando.kernel.model.ExpandoValue> getColumnValues( long columnId, int start, int end) { return getService().getColumnValues(columnId, start, end); } public static java.util.List<com.liferay.expando.kernel.model.ExpandoValue> getColumnValues( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, java.lang.String data, int start, int end) { return getService() .getColumnValues(companyId, className, tableName, columnName, data, start, end); } public static java.util.List<com.liferay.expando.kernel.model.ExpandoValue> getColumnValues( long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, int start, int end) { return getService() .getColumnValues(companyId, className, tableName, columnName, start, end); } public static java.util.List<com.liferay.expando.kernel.model.ExpandoValue> getColumnValues( long companyId, long classNameId, java.lang.String tableName, java.lang.String columnName, java.lang.String data, int start, int end) { return getService() .getColumnValues(companyId, classNameId, tableName, columnName, data, start, end); } public static java.util.List<com.liferay.expando.kernel.model.ExpandoValue> getColumnValues( long companyId, long classNameId, java.lang.String tableName, java.lang.String columnName, int start, int end) { return getService() .getColumnValues(companyId, classNameId, tableName, columnName, start, end); } public static int getColumnValuesCount(long columnId) { return getService().getColumnValuesCount(columnId); } public static int getColumnValuesCount(long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName) { return getService() .getColumnValuesCount(companyId, className, tableName, columnName); } public static int getColumnValuesCount(long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, java.lang.String data) { return getService() .getColumnValuesCount(companyId, className, tableName, columnName, data); } public static int getColumnValuesCount(long companyId, long classNameId, java.lang.String tableName, java.lang.String columnName) { return getService() .getColumnValuesCount(companyId, classNameId, tableName, columnName); } public static int getColumnValuesCount(long companyId, long classNameId, java.lang.String tableName, java.lang.String columnName, java.lang.String data) { return getService() .getColumnValuesCount(companyId, classNameId, tableName, columnName, data); } public static java.io.Serializable getData(long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK) throws com.liferay.portal.kernel.exception.PortalException { return getService() .getData(companyId, className, tableName, columnName, classPK); } public static java.lang.String getData(long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, java.lang.String defaultData) throws com.liferay.portal.kernel.exception.PortalException { return getService() .getData(companyId, className, tableName, columnName, classPK, defaultData); } public static boolean getData(long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, boolean defaultData) throws com.liferay.portal.kernel.exception.PortalException { return getService() .getData(companyId, className, tableName, columnName, classPK, defaultData); } public static java.util.Date[] getData(long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, java.util.Date[] defaultData) throws com.liferay.portal.kernel.exception.PortalException { return getService() .getData(companyId, className, tableName, columnName, classPK, defaultData); } public static double[] getData(long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, double[] defaultData) throws com.liferay.portal.kernel.exception.PortalException { return getService() .getData(companyId, className, tableName, columnName, classPK, defaultData); } public static java.lang.Number[] getData(long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, java.lang.Number[] defaultData) throws com.liferay.portal.kernel.exception.PortalException { return getService() .getData(companyId, className, tableName, columnName, classPK, defaultData); } public static short getData(long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, short defaultData) throws com.liferay.portal.kernel.exception.PortalException { return getService() .getData(companyId, className, tableName, columnName, classPK, defaultData); } public static float getData(long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, float defaultData) throws com.liferay.portal.kernel.exception.PortalException { return getService() .getData(companyId, className, tableName, columnName, classPK, defaultData); } public static float[] getData(long companyId, java.lang.String className, java.lang.String tableName, java.lang.String columnName, long classPK, float[] defaultData) throws com.liferay.portal.kernel.exception.PortalException { return getService()以上是关于Liferay7 BPM门户开发之41: Expando API入门的主要内容，如果未能解决你的问题，请参考以下文章
Liferay7 BPM门户开发之17: Portlet 生命周期
Liferay7 BPM门户开发之3: Activiti开发环境搭建
Liferay7 BPM门户开发之14: Liferay开发体系简介
Liferay7 BPM门户开发之34: liferay7对外服务类生成（RestService Get Url）