Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.liferay.object.field.util.ObjectFieldUtil Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.object.field.util;
import com.liferay.dynamic.data.mapping.expression.CreateExpressionRequest;
import com.liferay.dynamic.data.mapping.expression.DDMExpression;
import com.liferay.dynamic.data.mapping.expression.DDMExpressionException;
import com.liferay.dynamic.data.mapping.expression.DDMExpressionFactory;
import com.liferay.object.constants.ObjectFieldConstants;
import com.liferay.object.constants.ObjectFieldSettingConstants;
import com.liferay.object.constants.ObjectRelationshipConstants;
import com.liferay.object.dynamic.data.mapping.expression.ObjectEntryDDMExpressionFieldAccessor;
import com.liferay.object.entry.util.ObjectEntryThreadLocal;
import com.liferay.object.exception.ObjectFieldReadOnlyException;
import com.liferay.object.field.setting.util.ObjectFieldSettingUtil;
import com.liferay.object.model.ObjectField;
import com.liferay.object.model.ObjectFieldSetting;
import com.liferay.object.service.ObjectFieldLocalServiceUtil;
import com.liferay.object.service.ObjectFieldSettingLocalServiceUtil;
import com.liferay.petra.string.StringBundler;
import com.liferay.petra.string.StringPool;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.security.auth.PrincipalThreadLocal;
import com.liferay.portal.kernel.util.DateUtil;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.util.SetUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.vulcan.util.LocalizedMapUtil;
import java.math.BigDecimal;
import java.sql.Timestamp;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Collections;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
/**
* @author Guilherme Camacho
*/
public class ObjectFieldUtil {
public static ObjectField addCustomObjectField(ObjectField objectField)
throws Exception {
return ObjectFieldLocalServiceUtil.addCustomObjectField(
objectField.getExternalReferenceCode(), objectField.getUserId(),
objectField.getListTypeDefinitionId(),
objectField.getObjectDefinitionId(), objectField.getBusinessType(),
objectField.getDBType(), objectField.isIndexed(),
objectField.isIndexedAsKeyword(),
objectField.getIndexedLanguageId(), objectField.getLabelMap(),
objectField.isLocalized(), objectField.getName(),
objectField.getReadOnly(),
objectField.getReadOnlyConditionExpression(),
objectField.isRequired(), objectField.isState(),
objectField.getObjectFieldSettings());
}
public static ObjectField createObjectField(
long listTypeDefinitionId, String businessType, String dbColumnName,
String dbType, boolean indexed, boolean indexedAsKeyword,
String indexedLanguageId, String label, String name, boolean required,
boolean system) {
return createObjectField(
businessType, dbColumnName, dbType, indexed, indexedAsKeyword,
indexedLanguageId, label, listTypeDefinitionId, name,
Collections.emptyList(), ObjectFieldConstants.READ_ONLY_FALSE, null,
required, system);
}
public static ObjectField createObjectField(
String businessType, String dbType, boolean indexed,
boolean indexedAsKeyword, String indexedLanguageId, String label,
String name, boolean required) {
return createObjectField(
0, businessType, null, dbType, indexed, indexedAsKeyword,
indexedLanguageId, label, name, required, false);
}
public static ObjectField createObjectField(
String businessType, String dbType, boolean indexed,
boolean indexedAsKeyword, String indexedLanguageId, String label,
String name, List objectFieldSettings,
boolean required) {
return createObjectField(
businessType, null, dbType, indexed, indexedAsKeyword,
indexedLanguageId, label, 0, name, objectFieldSettings,
ObjectFieldConstants.READ_ONLY_FALSE, null, required, false);
}
public static ObjectField createObjectField(
String businessType, String dbType, String name) {
return createObjectField(businessType, dbType, name, name, false);
}
public static ObjectField createObjectField(
String businessType, String dbColumnName, String dbType,
boolean indexed, boolean indexedAsKeyword, String indexedLanguageId,
String label, long listTypeDefinitionId, String name,
List objectFieldSettings, String readOnly,
String readOnlyConditionExpression, boolean required, boolean system) {
ObjectField objectField = ObjectFieldLocalServiceUtil.createObjectField(
0);
objectField.setListTypeDefinitionId(listTypeDefinitionId);
objectField.setBusinessType(businessType);
objectField.setDBColumnName(dbColumnName);
objectField.setDBType(dbType);
objectField.setIndexed(indexed);
objectField.setIndexedAsKeyword(indexedAsKeyword);
objectField.setIndexedLanguageId(indexedLanguageId);
objectField.setLabelMap(LocalizedMapUtil.getLocalizedMap(label));
objectField.setName(name);
objectField.setReadOnly(readOnly);
objectField.setReadOnlyConditionExpression(readOnlyConditionExpression);
objectField.setRequired(required);
objectField.setSystem(system);
objectField.setObjectFieldSettings(objectFieldSettings);
return objectField;
}
public static ObjectField createObjectField(
String businessType, String dbType, String name,
List objectFieldSettings) {
return createObjectField(
businessType, null, dbType, false, false, null, name, 0, name,
objectFieldSettings, ObjectFieldConstants.READ_ONLY_FALSE, null,
false, false);
}
public static ObjectField createObjectField(
String businessType, String dbType, String label, String name) {
return createObjectField(businessType, dbType, label, name, false);
}
public static ObjectField createObjectField(
String businessType, String dbType, String label, String name,
boolean required) {
return createObjectField(
0, businessType, null, dbType, false, false, null, label, name,
required, false);
}
public static ObjectField createObjectField(
String businessType, String dbType, String label, String name,
List objectFieldSettings) {
return createObjectField(
businessType, null, dbType, false, false, null, label, 0, name,
objectFieldSettings, ObjectFieldConstants.READ_ONLY_FALSE, null,
false, false);
}
public static String getCounterName(ObjectField objectField) {
return StringBundler.concat(
"object.field.auto.increment#", objectField.getCompanyId(),
StringPool.POUND, objectField.getObjectFieldId());
}
public static String getDateTimePattern(String value) {
if (value.length() == 10) {
return "yyyy-MM-dd";
}
else if (value.length() == 16) {
return "yyyy-MM-dd HH:mm";
}
else if (value.length() == 20) {
return "yyyy-MM-dd'T'HH:mm:ss'Z'";
}
else if (value.length() == 21) {
return "yyyy-MM-dd HH:mm:ss.S";
}
else if (value.length() == 23) {
if (value.charAt(10) == 'T') {
return "yyyy-MM-dd'T'HH:mm:ss.SSS";
}
return "yyyy-MM-dd HH:mm:ss.SSS";
}
else if ((value.length() == 24) && (value.charAt(10) == 'T')) {
return "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";
}
else if ((value.length() == 27) && (value.charAt(26) == 'M')) {
return "dd-MMM-yyyy hh:mm:ss.SSS a";
}
else if ((value.length() == 28) && (value.charAt(23) == '+')) {
return "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
}
else if (value.length() == 28) {
return "EEE MMM dd HH:mm:ss zzz yyyy";
}
return DateUtil.ISO_8601_PATTERN;
}
public static boolean isMetadata(String objectFieldName) {
return _metadataObjectFieldNames.contains(objectFieldName);
}
public static Map toObjectFieldsMap(
List objectFields) {
Map objectFieldsMap = new LinkedHashMap<>();
for (ObjectField objectField : objectFields) {
objectFieldsMap.put(objectField.getName(), objectField);
}
return objectFieldsMap;
}
public static void validateReadOnlyObjectFields(
DDMExpressionFactory ddmExpressionFactory,
Map existingValues, List objectFields,
Map values)
throws PortalException {
if (ObjectEntryThreadLocal.isSkipReadOnlyObjectFieldsValidation()) {
return;
}
existingValues.put("currentUserId", PrincipalThreadLocal.getUserId());
Map objectFieldsMap = toObjectFieldsMap(
objectFields);
for (ObjectField objectField : objectFields) {
if (existingValues.get(objectField.getName()) == null) {
existingValues.put(
objectField.getName(),
ObjectFieldSettingUtil.getDefaultValueAsString(
null, objectField,
ObjectFieldSettingLocalServiceUtil.getService(), null));
}
if (objectField.isLocalized()) {
objectFieldsMap.put(
objectField.getI18nObjectFieldName(), objectField);
}
else if (Objects.equals(
objectField.getRelationshipType(),
ObjectRelationshipConstants.TYPE_ONE_TO_MANY)) {
String objectRelationshipERCObjectFieldName =
ObjectFieldSettingUtil.getValue(
ObjectFieldSettingConstants.
NAME_OBJECT_RELATIONSHIP_ERC_OBJECT_FIELD_NAME,
objectField);
objectFieldsMap.put(
objectRelationshipERCObjectFieldName, objectField);
}
}
for (Map.Entry entry : values.entrySet()) {
ObjectField objectField = objectFieldsMap.get(entry.getKey());
if ((objectField == null) || objectField.isMetadata() ||
Objects.equals(
objectField.getReadOnly(),
ObjectFieldConstants.READ_ONLY_FALSE)) {
continue;
}
if (Objects.equals(
objectField.getReadOnly(),
ObjectFieldConstants.READ_ONLY_TRUE)) {
_validateNewValue(
existingValues.get(entry.getKey()), objectField,
entry.getValue());
continue;
}
try {
DDMExpression ddmExpression =
ddmExpressionFactory.createExpression(
CreateExpressionRequest.Builder.newBuilder(
objectField.getReadOnlyConditionExpression()
).withDDMExpressionFieldAccessor(
new ObjectEntryDDMExpressionFieldAccessor(
existingValues)
).build());
ddmExpression.setVariables(existingValues);
if (ddmExpression.evaluate()) {
_validateNewValue(
existingValues.get(entry.getKey()), objectField,
entry.getValue());
}
}
catch (DDMExpressionException ddmExpressionException) {
_log.error(ddmExpressionException);
}
}
}
private static void _validateNewValue(
Object existingValue, ObjectField objectField, Object value)
throws PortalException {
if (Validator.isNull(existingValue) && Validator.isNull(value)) {
return;
}
if (Objects.equals(
objectField.getDBType(),
ObjectFieldConstants.DB_TYPE_BIG_DECIMAL) ||
Objects.equals(
objectField.getDBType(), ObjectFieldConstants.DB_TYPE_DOUBLE) ||
Objects.equals(
objectField.getDBType(),
ObjectFieldConstants.DB_TYPE_INTEGER) ||
Objects.equals(
objectField.getDBType(), ObjectFieldConstants.DB_TYPE_LONG)) {
BigDecimal bigDecimal1 = new BigDecimal(existingValue.toString());
BigDecimal bigDecimal2 = new BigDecimal(value.toString());
if (bigDecimal1.compareTo(bigDecimal2) == 0) {
return;
}
}
else if (Objects.equals(
objectField.getDBType(),
ObjectFieldConstants.DB_TYPE_BLOB) ||
Objects.equals(
objectField.getDBType(),
ObjectFieldConstants.DB_TYPE_CLOB) ||
Objects.equals(
objectField.getDBType(),
ObjectFieldConstants.DB_TYPE_STRING)) {
if (Objects.equals(
GetterUtil.getString(value),
GetterUtil.getString(existingValue))) {
return;
}
}
else if (Objects.equals(
objectField.getDBType(),
ObjectFieldConstants.DB_TYPE_BOOLEAN)) {
if (Objects.equals(
GetterUtil.getBoolean(value),
GetterUtil.getBoolean(existingValue))) {
return;
}
}
else if (Objects.equals(
objectField.getDBType(),
ObjectFieldConstants.DB_TYPE_DATE) ||
Objects.equals(
objectField.getDBType(),
ObjectFieldConstants.DB_TYPE_DATE_TIME)) {
Timestamp timestamp = (Timestamp)existingValue;
Date existingValueDate = new Date(timestamp.getTime());
DateFormat dateFormat = new SimpleDateFormat(
getDateTimePattern((String)value));
try {
Date valueDate = dateFormat.parse((String)value);
if (DateUtil.equals(existingValueDate, valueDate)) {
return;
}
}
catch (ParseException parseException) {
throw new RuntimeException(parseException);
}
}
else {
if (Objects.equals(existingValue, value)) {
return;
}
}
throw new ObjectFieldReadOnlyException(
"Object field " + objectField.getName() + " is read only");
}
private static final Log _log = LogFactoryUtil.getLog(
ObjectFieldUtil.class);
private static final Set _metadataObjectFieldNames =
Collections.unmodifiableSet(
SetUtil.fromArray(
"createDate", "creator", "externalReferenceCode", "id",
"modifiedDate", "status"));
}
