ThingTypeI18nLocalizationService.java

/**
 * Copyright (c) 2014-2017 by the respective copyright holders.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.eclipse.smarthome.core.thing.i18n;

import java.util.ArrayList;
import java.util.List;
import java.util.Locale;

import org.eclipse.smarthome.core.i18n.I18nProvider;
import org.eclipse.smarthome.core.thing.type.BridgeType;
import org.eclipse.smarthome.core.thing.type.ChannelDefinition;
import org.eclipse.smarthome.core.thing.type.ChannelGroupDefinition;
import org.eclipse.smarthome.core.thing.type.ThingType;
import org.osgi.framework.Bundle;

/**
 * This OSGi service could be used to localize a thing type using the I18N mechanism of the Eclipse SmartHome
 * framework.
 *
 * @author Markus Rathgeb - Move code from XML thing type provider to separate service
 */
public class ThingTypeI18nLocalizationService {

    private ThingTypeI18nUtil thingTypeI18nUtil;

    protected void setI18nProvider(I18nProvider i18nProvider) {
        this.thingTypeI18nUtil = new ThingTypeI18nUtil(i18nProvider);
    }

    protected void unsetI18nProvider(I18nProvider i18nProvider) {
        this.thingTypeI18nUtil = null;
    }

    public ThingType createLocalizedThingType(Bundle bundle, ThingType thingType, Locale locale) {
        final String label = this.thingTypeI18nUtil.getLabel(bundle, thingType.getUID(), thingType.getLabel(), locale);
        final String description = this.thingTypeI18nUtil.getDescription(bundle, thingType.getUID(),
                thingType.getDescription(), locale);

        final List<ChannelDefinition> localizedChannelDefinitions = new ArrayList<>(
                thingType.getChannelDefinitions().size());

        for (final ChannelDefinition channelDefinition : thingType.getChannelDefinitions()) {
            final String channelLabel = this.thingTypeI18nUtil.getChannelLabel(bundle,
                    channelDefinition.getChannelTypeUID(), channelDefinition.getLabel(), locale);
            final String channelDescription = this.thingTypeI18nUtil.getChannelDescription(bundle,
                    channelDefinition.getChannelTypeUID(), channelDefinition.getDescription(), locale);
            localizedChannelDefinitions
                    .add(new ChannelDefinition(channelDefinition.getId(), channelDefinition.getChannelTypeUID(),
                            channelDefinition.getProperties(), channelLabel, channelDescription));
        }

        final List<ChannelGroupDefinition> localizedChannelGroupDefinitions = new ArrayList<>(
                thingType.getChannelGroupDefinitions().size());
        for (final ChannelGroupDefinition channelGroupDefinition : thingType.getChannelGroupDefinitions()) {
            final String channelGroupLabel = this.thingTypeI18nUtil.getChannelGroupLabel(bundle,
                    channelGroupDefinition.getTypeUID(), channelGroupDefinition.getLabel(), locale);
            final String channelGroupDescription = this.thingTypeI18nUtil.getChannelGroupDescription(bundle,
                    channelGroupDefinition.getTypeUID(), channelGroupDefinition.getDescription(), locale);
            localizedChannelGroupDefinitions.add(new ChannelGroupDefinition(channelGroupDefinition.getId(),
                    channelGroupDefinition.getTypeUID(), channelGroupLabel, channelGroupDescription));
        }

        if (thingType instanceof BridgeType) {
            final BridgeType bridgeType = (BridgeType) thingType;
            return new BridgeType(bridgeType.getUID(), bridgeType.getSupportedBridgeTypeUIDs(), label, description,
                    thingType.isListed(), localizedChannelDefinitions, localizedChannelGroupDefinitions,
                    thingType.getProperties(), bridgeType.getConfigDescriptionURI());
        } else {
            return new ThingType(thingType.getUID(), thingType.getSupportedBridgeTypeUIDs(), label, description,
                    thingType.isListed(), localizedChannelDefinitions, localizedChannelGroupDefinitions,
                    thingType.getProperties(), thingType.getConfigDescriptionURI());
        }
    }

}