-
-
Notifications
You must be signed in to change notification settings - Fork 421
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[rest] Added support for default values containing a list of configur…
…ation options (#1031) * Added support for default values containing a list of configuration options Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
- Loading branch information
1 parent
b337e31
commit d8a0225
Showing
5 changed files
with
230 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
77 changes: 77 additions & 0 deletions
77
...in/java/org/eclipse/smarthome/io/rest/core/config/EnrichedConfigDescriptionDTOMapper.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| /** | ||
| * Copyright (c) 2010-2019 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.eclipse.smarthome.io.rest.core.config; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.smarthome.config.core.ConfigDescription; | ||
| import org.eclipse.smarthome.config.core.ConfigDescriptionParameter; | ||
| import org.eclipse.smarthome.config.core.dto.ConfigDescriptionDTO; | ||
| import org.eclipse.smarthome.config.core.dto.ConfigDescriptionDTOMapper; | ||
| import org.eclipse.smarthome.config.core.dto.ConfigDescriptionParameterDTO; | ||
| import org.eclipse.smarthome.config.core.dto.ConfigDescriptionParameterGroupDTO; | ||
|
|
||
| /** | ||
| * The {@link EnrichedConfigDescriptionDTOMapper} is a utility class to map {@link ConfigDescription}s to config | ||
| * descriptions data transform objects {@link ConfigDescriptionDTO} containing | ||
| * {@link EnrichedConfigDescriptionParameterDTO}. | ||
| * | ||
| * @author Christoph Weitkamp - Initial contribution | ||
| */ | ||
| @NonNullByDefault | ||
| public class EnrichedConfigDescriptionDTOMapper extends ConfigDescriptionDTOMapper { | ||
|
|
||
| /** | ||
| * Maps configuration description into configuration description DTO object. | ||
| * | ||
| * @param configDescription the configuration description (not null) | ||
| * @return enriched configuration description DTO object | ||
| */ | ||
| public static ConfigDescriptionDTO map(ConfigDescription configDescription) { | ||
| List<ConfigDescriptionParameterGroupDTO> parameterGroups = mapParameterGroups( | ||
| configDescription.getParameterGroups()); | ||
| List<ConfigDescriptionParameterDTO> parameters = mapEnrichedParameters(configDescription.getParameters()); | ||
| return new ConfigDescriptionDTO(toDecodedString(configDescription.getUID()), parameters, parameterGroups); | ||
| } | ||
|
|
||
| /** | ||
| * Maps configuration description parameters into enriched DTO objects. | ||
| * | ||
| * @param parameters the configuration description parameters (not null) | ||
| * @return the parameter enriched DTO objects | ||
| */ | ||
| public static List<ConfigDescriptionParameterDTO> mapEnrichedParameters( | ||
| List<ConfigDescriptionParameter> parameters) { | ||
| List<ConfigDescriptionParameterDTO> configDescriptionParameterBeans = new ArrayList<>(parameters.size()); | ||
| for (ConfigDescriptionParameter configDescriptionParameter : parameters) { | ||
| ConfigDescriptionParameterDTO configDescriptionParameterBean = new EnrichedConfigDescriptionParameterDTO( | ||
| configDescriptionParameter.getName(), configDescriptionParameter.getType(), | ||
| configDescriptionParameter.getMinimum(), configDescriptionParameter.getMaximum(), | ||
| configDescriptionParameter.getStepSize(), configDescriptionParameter.getPattern(), | ||
| configDescriptionParameter.isRequired(), configDescriptionParameter.isReadOnly(), | ||
| configDescriptionParameter.isMultiple(), configDescriptionParameter.getContext(), | ||
| configDescriptionParameter.getDefault(), configDescriptionParameter.getLabel(), | ||
| configDescriptionParameter.getDescription(), mapOptions(configDescriptionParameter.getOptions()), | ||
| mapFilterCriteria(configDescriptionParameter.getFilterCriteria()), | ||
| configDescriptionParameter.getGroupName(), configDescriptionParameter.isAdvanced(), | ||
| configDescriptionParameter.getLimitToOptions(), configDescriptionParameter.getMultipleLimit(), | ||
| configDescriptionParameter.getUnit(), configDescriptionParameter.getUnitLabel(), | ||
| configDescriptionParameter.isVerifyable()); | ||
| configDescriptionParameterBeans.add(configDescriptionParameterBean); | ||
| } | ||
| return configDescriptionParameterBeans; | ||
| } | ||
|
|
||
| } |
61 changes: 61 additions & 0 deletions
61
...java/org/eclipse/smarthome/io/rest/core/config/EnrichedConfigDescriptionParameterDTO.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| /** | ||
| * Copyright (c) 2010-2019 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.eclipse.smarthome.io.rest.core.config; | ||
|
|
||
| import java.math.BigDecimal; | ||
| import java.util.Arrays; | ||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
| import org.eclipse.smarthome.config.core.ConfigDescriptionParameter.Type; | ||
| import org.eclipse.smarthome.config.core.dto.ConfigDescriptionParameterDTO; | ||
| import org.eclipse.smarthome.config.core.dto.FilterCriteriaDTO; | ||
| import org.eclipse.smarthome.config.core.dto.ParameterOptionDTO; | ||
|
|
||
| /** | ||
| * This is an enriched data transfer object that is used to serialize config descriptions parameters with a list of | ||
| * default values if a configuration description defines <code>multiple="true"</code>. | ||
| * | ||
| * @author Christoph Weitkamp - Initial contribution | ||
| */ | ||
| @NonNullByDefault | ||
| public class EnrichedConfigDescriptionParameterDTO extends ConfigDescriptionParameterDTO { | ||
|
|
||
| private static final String DEFAULT_LIST_DELIMITER = ","; | ||
|
|
||
| public @Nullable Collection<String> defaultValues; | ||
|
|
||
| public EnrichedConfigDescriptionParameterDTO(String name, Type type, BigDecimal minimum, BigDecimal maximum, | ||
| BigDecimal stepsize, String pattern, Boolean required, Boolean readOnly, Boolean multiple, String context, | ||
| String defaultValue, String label, String description, List<ParameterOptionDTO> options, | ||
| List<FilterCriteriaDTO> filterCriteria, String groupName, Boolean advanced, Boolean limitToOptions, | ||
| Integer multipleLimit, String unit, String unitLabel, Boolean verify) { | ||
| super(name, type, minimum, maximum, stepsize, pattern, required, readOnly, multiple, context, defaultValue, | ||
| label, description, options, filterCriteria, groupName, advanced, limitToOptions, multipleLimit, unit, | ||
| unitLabel, verify); | ||
|
|
||
| if (multiple) { | ||
| if (defaultValue.contains(DEFAULT_LIST_DELIMITER)) { | ||
| defaultValues = Arrays.asList(defaultValue.split(DEFAULT_LIST_DELIMITER)).stream().map(v -> v.trim()) | ||
| .filter(v -> !v.isEmpty()).collect(Collectors.toList()); | ||
| } else { | ||
| defaultValues = Collections.singleton(defaultValue); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
76 changes: 76 additions & 0 deletions
76
...ava/org/eclipse/smarthome/io/rest/core/config/EnrichedConfigDescriptionDTOMapperTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /** | ||
| * Copyright (c) 2010-2019 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.eclipse.smarthome.io.rest.core.config; | ||
|
|
||
| import static org.hamcrest.CoreMatchers.*; | ||
| import static org.junit.Assert.assertThat; | ||
|
|
||
| import java.net.URI; | ||
| import java.util.Arrays; | ||
|
|
||
| import org.eclipse.smarthome.config.core.ConfigDescription; | ||
| import org.eclipse.smarthome.config.core.ConfigDescriptionParameter; | ||
| import org.eclipse.smarthome.config.core.ConfigDescriptionParameter.Type; | ||
| import org.eclipse.smarthome.config.core.ConfigDescriptionParameterBuilder; | ||
| import org.eclipse.smarthome.config.core.dto.ConfigDescriptionDTO; | ||
| import org.eclipse.smarthome.config.core.dto.ConfigDescriptionParameterDTO; | ||
| import org.junit.Test; | ||
|
|
||
| /** | ||
| * @author Christoph Weitkamp - Initial contribution | ||
| */ | ||
| public class EnrichedConfigDescriptionDTOMapperTest { | ||
|
|
||
| private static final URI CONFIG_URI = URI.create("system:ephemeris"); | ||
| private static final String CONFIG_PARAMETER_NAME = "test"; | ||
| private static final String CONFIG_PARAMETER_DEFAULT_VALUE = "first value,second value,third value"; | ||
|
|
||
| @Test | ||
| public void testThatDefaultValueIsNotAList() { | ||
| ConfigDescriptionParameter configDescriptionParameter = ConfigDescriptionParameterBuilder | ||
| .create(CONFIG_PARAMETER_NAME, Type.TEXT).withDefault(CONFIG_PARAMETER_DEFAULT_VALUE).build(); | ||
| ConfigDescription configDescription = new ConfigDescription(CONFIG_URI, | ||
| Arrays.asList(configDescriptionParameter)); | ||
|
|
||
| ConfigDescriptionDTO cddto = EnrichedConfigDescriptionDTOMapper.map(configDescription); | ||
| assertThat(cddto.parameters.size(), is(1)); | ||
|
|
||
| ConfigDescriptionParameterDTO cdpdto = cddto.parameters.get(0); | ||
| assertThat(cdpdto, instanceOf(EnrichedConfigDescriptionParameterDTO.class)); | ||
| assertThat(cdpdto.defaultValue, is(CONFIG_PARAMETER_DEFAULT_VALUE)); | ||
| EnrichedConfigDescriptionParameterDTO ecdpdto = (EnrichedConfigDescriptionParameterDTO) cdpdto; | ||
| assertThat(ecdpdto.defaultValues, is(nullValue())); | ||
| } | ||
|
|
||
| @SuppressWarnings("null") | ||
| @Test | ||
| public void testThatDefaultValuesAreAList() { | ||
| ConfigDescriptionParameter configDescriptionParameter = ConfigDescriptionParameterBuilder | ||
| .create(CONFIG_PARAMETER_NAME, Type.TEXT).withDefault(CONFIG_PARAMETER_DEFAULT_VALUE).withMultiple(true) | ||
| .build(); | ||
| ConfigDescription configDescription = new ConfigDescription(CONFIG_URI, | ||
| Arrays.asList(configDescriptionParameter)); | ||
|
|
||
| ConfigDescriptionDTO cddto = EnrichedConfigDescriptionDTOMapper.map(configDescription); | ||
| assertThat(cddto.parameters.size(), is(1)); | ||
|
|
||
| ConfigDescriptionParameterDTO cdpdto = cddto.parameters.get(0); | ||
| assertThat(cdpdto, instanceOf(EnrichedConfigDescriptionParameterDTO.class)); | ||
| assertThat(cdpdto.defaultValue, is(CONFIG_PARAMETER_DEFAULT_VALUE)); | ||
| EnrichedConfigDescriptionParameterDTO ecdpdto = (EnrichedConfigDescriptionParameterDTO) cdpdto; | ||
| assertThat(ecdpdto.defaultValues, is(notNullValue())); | ||
| assertThat(ecdpdto.defaultValues.size(), is(3)); | ||
| assertThat(ecdpdto.defaultValues, is(equalTo(Arrays.asList("first value", "second value", "third value")))); | ||
| } | ||
|
|
||
| } |