org.apache.unomi.rest.LocalizationHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unomi-rest Show documentation
Show all versions of unomi-rest Show documentation
Apache Unomi Context Server REST API
/*
* 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.apache.unomi.rest;
import org.apache.unomi.api.Parameter;
import org.apache.unomi.api.PluginType;
import org.apache.unomi.api.Tag;
import org.apache.unomi.api.ValueType;
import org.apache.unomi.api.actions.ActionType;
import org.apache.unomi.api.conditions.ConditionType;
import org.apache.unomi.api.conditions.initializers.ChoiceListInitializer;
import org.apache.unomi.api.conditions.initializers.ChoiceListValue;
import org.apache.unomi.api.conditions.initializers.I18nSupport;
import org.osgi.framework.BundleContext;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceReference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.ResourceBundle;
/**
* A helper class to provide localized versions of context server entities.
*/
public class LocalizationHelper {
private static final Logger logger = LoggerFactory.getLogger(LocalizationHelper.class.getName());
private BundleContext bundleContext;
private ResourceBundleHelper resourceBundleHelper;
/**
* Creates {@link RESTConditionType}s, localized using the specified language, based on the specified {@link ConditionType}s.
*
* @param conditionTypes the {@link ConditionType}s to be localized
* @param language the language to use to localize {@link ConditionType}s
* @return a collection of {@link RESTConditionType}s based on the specified {@link ConditionType}s and localized using the specified language
*/
public Collection generateConditions(Collection conditionTypes, String language) {
List result = new ArrayList();
if (conditionTypes == null) {
return result;
}
for (ConditionType conditionType : conditionTypes) {
result.add(generateCondition(conditionType, language));
}
return result;
}
/**
* Creates {@link RESTActionType}s, localized using the specified language, based on the specified {@link ActionType}s.
*
* @param actionTypes the {@link ActionType}s to be localized
* @param language the language to use to localize {@link ActionType}s
* @return a collection of {@link RESTActionType}s based on the specified {@link ActionType}s and localized using the specified language
*/
public Collection generateActions(Collection actionTypes, String language) {
List result = new ArrayList();
if (actionTypes == null) {
return result;
}
for (ActionType actionType : actionTypes) {
result.add(generateAction(actionType, language));
}
return result;
}
/**
* Creates a {@link RESTConditionType} based on the specified {@link ConditionType} and localized using the specified language.
*
* @param conditionType the {@link ConditionType} to be localized
* @param language the language to use to localize {@link ConditionType}
* @return a {@link RESTConditionType} based on the specified {@link ConditionType} and localized using the specified language
*/
public RESTConditionType generateCondition(ConditionType conditionType, String language) {
RESTConditionType result = new RESTConditionType();
result.setId(conditionType.getId());
ResourceBundle bundle = resourceBundleHelper.getResourceBundle(conditionType, language);
result.setName(resourceBundleHelper.getResourceBundleValue(bundle, conditionType.getNameKey()));
result.setDescription(resourceBundleHelper.getResourceBundleValue(bundle, conditionType.getDescriptionKey()));
result.setTags(conditionType.getTagIDs());
for (Parameter parameter : conditionType.getParameters()) {
result.getParameters().add(generateParameter(parameter, bundle));
}
return result;
}
/**
* Creates a {@link RESTActionType} based on the specified {@link ActionType} and localized using the specified language.
*
* @param actionType the {@link ActionType} to be localized
* @param language the language to use to localize {@link ActionType}
* @return a {@link RESTActionType} based on the specified {@link ActionType} and localized using the specified language
*/
public RESTActionType generateAction(ActionType actionType, String language) {
RESTActionType result = new RESTActionType();
result.setId(actionType.getId());
ResourceBundle bundle = resourceBundleHelper.getResourceBundle(actionType, language);
result.setName(resourceBundleHelper.getResourceBundleValue(bundle, actionType.getNameKey()));
result.setDescription(resourceBundleHelper.getResourceBundleValue(bundle, actionType.getDescriptionKey()));
result.setTags(actionType.getTagIds());
List parameters = new ArrayList();
for (Parameter parameter : actionType.getParameters()) {
parameters.add(generateParameter(parameter, bundle));
}
result.setParameters(parameters);
return result;
}
/**
* Creates a {@link RESTParameter} based on the specified {@link Parameter} and localized using the specified {@link ResourceBundle}.
*
* @param parameter the {@link Parameter} to be localized
* @param bundle the {@link ResourceBundle} used to localize the {@link Parameter}'s choice list values if needed
* @return a {@link RESTParameter} based on the specified {@link ActionType} and localized using the specified {@link ResourceBundle}
*/
public RESTParameter generateParameter(Parameter parameter, ResourceBundle bundle) {
RESTParameter result = new RESTParameter();
result.setId(parameter.getId());
result.setDefaultValue(parameter.getDefaultValue());
result.setMultivalued(parameter.isMultivalued());
result.setType(parameter.getType());
localizeChoiceListValues(bundle, result.getChoiceListValues(), parameter.getChoiceListInitializerFilter());
return result;
}
public void localizeChoiceListValues(ResourceBundle bundle, List result, String choiceListInitializerFilter) {
if (choiceListInitializerFilter != null && choiceListInitializerFilter.length() > 0) {
try {
Collection> matchingChoiceListInitializerReferences = bundleContext.getServiceReferences(ChoiceListInitializer.class, choiceListInitializerFilter);
for (ServiceReference choiceListInitializerReference : matchingChoiceListInitializerReferences) {
ChoiceListInitializer choiceListInitializer = bundleContext.getService(choiceListInitializerReference);
List options = choiceListInitializer.getValues(bundle.getLocale());
if (choiceListInitializer instanceof I18nSupport) {
for (ChoiceListValue value : options) {
if (value instanceof PluginType) {
result.add(value.localizedCopy(resourceBundleHelper.getResourceBundleValue(resourceBundleHelper.getResourceBundle((PluginType) value, bundle.getLocale().getLanguage()), value.getName())));
} else {
result.add(value.localizedCopy(resourceBundleHelper.getResourceBundleValue(bundle, value.getName())));
}
}
} else {
result.addAll(options);
}
}
} catch (InvalidSyntaxException e) {
logger.error("Invalid filter", e);
}
}
}
/**
* Creates {@link RESTValueType}s, localized using the specified language, based on the specified {@link ValueType}s.
*
* @param valueTypes the {@link ValueType}s to be localized
* @param language the language to use to localize {@link ValueType}s
* @return a collection of {@link RESTValueType}s based on the specified {@link ValueType}s and localized using the specified language
*/
public Collection generateValueTypes(Collection valueTypes, String language) {
List result = new ArrayList();
if (valueTypes == null) {
return result;
}
for (ValueType valueType : valueTypes) {
result.add(generateValueType(valueType, language));
}
return result;
}
/**
* Creates a {@link RESTValueType} based on the specified {@link ValueType} and localized using the specified language.
*
* @param valueType the {@link ValueType} to be localized
* @param language the language to use to localize {@link ValueType}
* @return a {@link RESTValueType} based on the specified {@link ValueType} and localized using the specified language
*/
public RESTValueType generateValueType(ValueType valueType, String language) {
RESTValueType result = new RESTValueType();
result.setId(valueType.getId());
ResourceBundle bundle = resourceBundleHelper.getResourceBundle(valueType, language);
result.setName(resourceBundleHelper.getResourceBundleValue(bundle, valueType.getNameKey()));
result.setDescription(resourceBundleHelper.getResourceBundleValue(bundle, valueType.getDescriptionKey()));
result.setTags(generateTags(valueType.getTags(), language));
return result;
}
/**
* Same as generateTages(tags, language, false).
*/
public Collection generateTags(Collection tags, String language) {
return generateTags(tags, language, false);
}
/**
* Creates {@link RESTTag}s, localized using the specified language, based on the specified {@link Tag}s.
*
* @param tags the {@link Tag}s to be localized
* @param language the language to use to localize {@link Tag}s
* @param filterHidden {@code true} to filter out hidden tags, {@code false} otherwise
* @return a collection of {@link RESTTag}s based on the specified {@link Tag}s and localized using the specified language
*/
public Collection generateTags(Collection tags, String language, boolean filterHidden) {
List result = new ArrayList();
for (Tag tag : tags) {
RESTTag subTag = generateTag(tag, language, filterHidden);
if (subTag != null) {
result.add(subTag);
}
}
return result;
}
/**
* Same as generateTag(tag, language, false).
*/
public RESTTag generateTag(Tag tag, String language) {
return generateTag(tag, language, false);
}
/**
* Creates a {@link RESTTag}, localized using the specified language, based on the specified {@link Tag}.
*
* @param tag the {@link Tag} to be localized
* @param language the language to use to localize the {@link Tag}
* @param filterHidden {@code true} to filter out hidden sub-tags, {@code false} otherwise
* @return a {@link RESTTag} based on the specified {@link Tag} and localized using the specified language
*/
public RESTTag generateTag(Tag tag, String language, boolean filterHidden) {
if (filterHidden && tag.isHidden()) {
return null;
}
RESTTag result = new RESTTag();
result.setId(tag.getId());
ResourceBundle bundle = resourceBundleHelper.getResourceBundle(tag, language);
result.setName(resourceBundleHelper.getResourceBundleValue(bundle, tag.getNameKey()));
result.setDescription(resourceBundleHelper.getResourceBundleValue(bundle, tag.getDescriptionKey()));
result.setParentId(tag.getParentId());
result.setRank(tag.getRank());
result.setSubTags(generateTags(tag.getSubTags(), language, filterHidden));
return result;
}
public void setBundleContext(BundleContext bundleContext) {
this.bundleContext = bundleContext;
}
public void setResourceBundleHelper(ResourceBundleHelper resourceBundleHelper) {
this.resourceBundleHelper = resourceBundleHelper;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy