git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2020 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.transform.map.internal.profiles;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.openhab.core.library.types.StringType;
  17 import org.openhab.core.thing.profiles.ProfileCallback;
  18 import org.openhab.core.thing.profiles.ProfileContext;
  19 import org.openhab.core.thing.profiles.ProfileTypeUID;
  20 import org.openhab.core.thing.profiles.StateProfile;
  21 import org.openhab.core.transform.TransformationException;
  22 import org.openhab.core.transform.TransformationHelper;
  23 import org.openhab.core.transform.TransformationService;
  24 import org.openhab.core.types.Command;
  25 import org.openhab.core.types.State;
  26 import org.openhab.core.types.Type;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 /**
  31  * Profile to offer the MapTransformationservice on a ItemChannelLink
  32  *
  33  * @author Stefan Triller - initial contribution
  34  *
  35  */
  36 @NonNullByDefault
  37 public class MapTransformationProfile implements StateProfile {
  38
  39     public static final ProfileTypeUID PROFILE_TYPE_UID = new ProfileTypeUID(
  40             TransformationService.TRANSFORM_PROFILE_SCOPE, "MAP");
  41
  42     private final Logger logger = LoggerFactory.getLogger(MapTransformationProfile.class);
  43
  44     private final TransformationService service;
  45     private final ProfileCallback callback;
  46
  47     private static final String FUNCTION_PARAM = "function";
  48     private static final String SOURCE_FORMAT_PARAM = "sourceFormat";
  49
  50     @NonNullByDefault({})
  51     private final String function;
  52     @NonNullByDefault({})
  53     private final String sourceFormat;
  54
  55     public MapTransformationProfile(ProfileCallback callback, ProfileContext context, TransformationService service) {
  56         this.service = service;
  57         this.callback = callback;
  58
  59         Object paramFunction = context.getConfiguration().get(FUNCTION_PARAM);
  60         Object paramSource = context.getConfiguration().get(SOURCE_FORMAT_PARAM);
  61
  62         logger.debug("Profile configured with '{}'='{}', '{}'={}", FUNCTION_PARAM, paramFunction, SOURCE_FORMAT_PARAM,
  63                 paramSource);
  64         // SOURCE_FORMAT_PARAM is an advanced parameter and we assume "%s" if it is not set
  65         if (paramSource == null) {
  66             paramSource = "%s";
  67         }
  68         if (paramFunction instanceof String && paramSource instanceof String) {
  69             function = (String) paramFunction;
  70             sourceFormat = (String) paramSource;
  71         } else {
  72             logger.error("Parameter '{}' and '{}' have to be Strings. Profile will be inactive.", FUNCTION_PARAM,
  73                     SOURCE_FORMAT_PARAM);
  74             function = null;
  75             sourceFormat = null;
  76         }
  77     }
  78
  79     @Override
  80     public ProfileTypeUID getProfileTypeUID() {
  81         return PROFILE_TYPE_UID;
  82     }
  83
  84     @Override
  85     public void onStateUpdateFromItem(State state) {
  86         callback.handleUpdate(state);
  87     }
  88
  89     @Override
  90     public void onCommandFromItem(Command command) {
  91         callback.handleCommand(command);
  92     }
  93
  94     @Override
  95     public void onCommandFromHandler(Command command) {
  96         if (function == null || sourceFormat == null) {
  97             logger.warn(
  98                     "Please specify a function and a source format for this Profile in the '{}', and '{}' parameters, e.g \"translation.map\"  and \"%s\". Returning the original command now.",
  99                     FUNCTION_PARAM, SOURCE_FORMAT_PARAM);
 100             callback.sendCommand(command);
 101             return;
 102         }
 103         callback.sendCommand((Command) transformState(command));
 104     }
 105
 106     @Override
 107     public void onStateUpdateFromHandler(State state) {
 108         if (function == null || sourceFormat == null) {
 109             logger.warn(
 110                     "Please specify a function and a source format for this Profile in the '{}' and '{}' parameters, e.g \"translation.map\" and \"%s\". Returning the original state now.",
 111                     FUNCTION_PARAM, SOURCE_FORMAT_PARAM);
 112             callback.sendUpdate(state);
 113             return;
 114         }
 115         callback.sendUpdate((State) transformState(state));
 116     }
 117
 118     private Type transformState(Type state) {
 119         String result = state.toFullString();
 120         try {
 121             result = TransformationHelper.transform(service, function, sourceFormat, state.toFullString());
 122             if (result != null && result.isEmpty()) {
 123                 // map transformation service returns an empty string if the entry is not found in the map, we will use
 124                 // the original value
 125                 result = state.toFullString();
 126             }
 127         } catch (TransformationException e) {
 128             logger.warn("Could not transform state '{}' with function '{}' and format '{}'", state, function,
 129                     sourceFormat);
 130         }
 131         StringType resultType = new StringType(result);
 132         logger.debug("Transformed '{}' into '{}'", state, resultType);
 133         return resultType;
 134     }
 135 }