/******************************************************************************* | |
* Licensed to the Apache Software Foundation (ASF) under one | |
* or more contributor license agreements. See the NOTICE file | |
* distributed with this work for additional information | |
* regarding copyright ownership. The ASF licenses this file | |
* to you under the Apache License, Version 2.0 (the | |
* "License"); you may not use this file except in compliance | |
* with the License. You may obtain a copy of the License at | |
* | |
* http://www.apache.org/licenses/LICENSE-2.0 | |
* | |
* Unless required by applicable law or agreed to in writing, | |
* software distributed under the License is distributed on an | |
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
* KIND, either express or implied. See the License for the | |
* specific language governing permissions and limitations | |
* under the License. | |
*******************************************************************************/ | |
package org.ofbiz.widget.renderer; | |
import java.util.Locale; | |
import org.ofbiz.base.util.Debug; | |
import org.ofbiz.base.util.UtilProperties; | |
import org.ofbiz.base.util.UtilValidate; | |
import org.ofbiz.entity.Delegator; | |
import org.ofbiz.entity.GenericEntityException; | |
import org.ofbiz.entity.model.ModelEntity; | |
import org.ofbiz.entity.model.ModelReader; | |
/** | |
* Util for working with Help Text | |
*/ | |
public class UtilHelpText { | |
public static final String module = UtilHelpText.class.getName(); | |
/** | |
* Find the help text associated with an entity field. | |
* | |
* @param entityName the entity name | |
* @param fieldName the field name | |
* @param delegator the delegator | |
* @param locale the locale | |
* @return the help text, or the resource propertyName if no help text exists | |
*/ | |
public static String getEntityFieldDescription(final String entityName, final String fieldName, final Delegator delegator, final Locale locale) { | |
if (UtilValidate.isEmpty(entityName)) { | |
// Debug.logWarning("entityName [" + entityName + "] is empty", module); | |
return ""; | |
} | |
if (UtilValidate.isEmpty(fieldName)) { | |
Debug.logWarning("fieldName [" + fieldName + "] is empty", module); | |
return ""; | |
} | |
ModelReader reader = delegator.getModelReader(); | |
ModelEntity entity = null; | |
try { | |
if (!reader.getEntityNames().contains(entityName)) { | |
Debug.logWarning("couldn't find entityName [" + entityName + "]", module); | |
return ""; | |
} | |
entity = reader.getModelEntity(entityName); | |
} catch (GenericEntityException e) { | |
Debug.logError(e, "Error getting help text for entity=" + entityName + " field " + fieldName, module); | |
return ""; | |
} | |
String entityResourceName = entity.getDefaultResourceName(); | |
String messageId = "FieldDescription." + entityName + "." + fieldName; | |
String fieldDescription = UtilProperties.getMessage(entityResourceName, messageId, locale); | |
if (fieldDescription.equals(messageId)) { | |
messageId = "FieldDescription." + fieldName; | |
if (Debug.verboseOn()) { | |
Debug.logVerbose("No help text found in [" + entityResourceName + "] with key [" + messageId + "], Trying with: " + messageId, module); | |
} | |
fieldDescription = UtilProperties.getMessage(entityResourceName, messageId, locale); | |
if (fieldDescription.equals(messageId)) { | |
if (Debug.verboseOn()) { | |
Debug.logVerbose("No help text found in [" + entityResourceName + "] with key [" + messageId + "]", module); | |
} | |
return ""; | |
} | |
} | |
return fieldDescription; | |
} | |
} |