001package jmri.jmrit.logixng.implementation;
002
003import java.util.ArrayList;
004import java.util.List;
005import java.util.Map;
006import java.util.HashMap;
007import java.util.ServiceLoader;
008
009import javax.annotation.Nonnull;
010
011import jmri.*;
012import jmri.jmrit.logixng.*;
013import jmri.util.LoggingUtil;
014import jmri.util.ThreadingUtil;
015
016/**
017 * Class providing the basic logic of the DigitalActionManager interface.
018 *
019 * @author Dave Duchamp       Copyright (C) 2007
020 * @author Daniel Bergqvist   Copyright (C) 2018
021 */
022public class DefaultDigitalActionManager extends AbstractBaseManager<MaleDigitalActionSocket>
023        implements DigitalActionManager {
024
025    private final Map<Category, List<Class<? extends Base>>> actionClassList = new HashMap<>();
026    private MaleSocket _lastRegisteredBean;
027
028
029    public DefaultDigitalActionManager() {
030        InstanceManager.getDefault(LogixNG_Manager.class).registerManager(this);
031
032        for (DigitalActionFactory actionFactory : ServiceLoader.load(DigitalActionFactory.class)) {
033            actionFactory.init();
034        }
035
036        for (Category category : Category.values()) {
037            actionClassList.put(category, new ArrayList<>());
038        }
039
040        for (DigitalActionFactory actionFactory : ServiceLoader.load(DigitalActionFactory.class)) {
041            actionFactory.getActionClasses().forEach((entry) -> {
042//                System.out.format("Add action: %s, %s%n", entry.getKey().name(), entry.getValue().getName());
043                actionClassList.get(entry.getKey()).add(entry.getValue());
044            });
045        }
046
047        for (MaleDigitalActionSocketFactory maleSocketFactory : ServiceLoader.load(MaleDigitalActionSocketFactory.class)) {
048            _maleSocketFactories.add(maleSocketFactory);
049        }
050    }
051
052    /** {@inheritDoc} */
053    @Override
054    public Class<? extends MaleSocket> getMaleSocketClass() {
055        return DefaultMaleDigitalActionSocket.class;
056    }
057
058    protected MaleDigitalActionSocket createMaleActionSocket(DigitalActionBean action) {
059        MaleDigitalActionSocket socket = new DefaultMaleDigitalActionSocket(this, action);
060        action.setParent(socket);
061        return socket;
062    }
063
064    /** {@inheritDoc} */
065    @Override
066    public MaleSocket getLastRegisteredMaleSocket() {
067        return _lastRegisteredBean;
068    }
069
070    /** {@inheritDoc} */
071    @Override
072    public MaleDigitalActionSocket registerBean(MaleDigitalActionSocket maleSocket) {
073        MaleDigitalActionSocket bean = super.registerBean(maleSocket);
074        _lastRegisteredBean = maleSocket;
075        return bean;
076    }
077
078    /**
079     * Remember a NamedBean Object created outside the manager.
080     * This method creates a MaleDigitalActionSocket for the action.
081     *
082     * @param action the bean
083     */
084    @Override
085    public MaleDigitalActionSocket registerAction(@Nonnull DigitalActionBean action)
086            throws IllegalArgumentException {
087
088        if (action instanceof MaleDigitalActionSocket) {
089            throw new IllegalArgumentException("registerAction() cannot register a MaleDigitalActionSocket. Use the method register() instead.");
090        }
091
092        // Check if system name is valid
093        if (this.validSystemNameFormat(action.getSystemName()) != NameValidity.VALID) {
094            log.warn("SystemName {} is not in the correct format", action.getSystemName() );
095            throw new IllegalArgumentException(String.format("System name is invalid: %s", action.getSystemName()));
096        }
097
098        // Keep track of the last created auto system name
099        updateAutoNumber(action.getSystemName());
100
101        // save in the maps
102        MaleDigitalActionSocket maleSocket = createMaleActionSocket(action);
103        return registerBean(maleSocket);
104    }
105
106    @Override
107    public int getXMLOrder() {
108        return LOGIXNG_DIGITAL_ACTIONS;
109    }
110
111    @Override
112    public char typeLetter() {
113        return 'Q';
114    }
115
116    @Override
117    public FemaleDigitalActionSocket createFemaleSocket(
118            Base parent, FemaleSocketListener listener, String socketName) {
119        return new DefaultFemaleDigitalActionSocket(parent, listener, socketName);
120    }
121
122    @Override
123    public Map<Category, List<Class<? extends Base>>> getActionClasses() {
124        return actionClassList;
125    }
126
127    /** {@inheritDoc} */
128    @Override
129    public String getBeanTypeHandled(boolean plural) {
130        return Bundle.getMessage(plural ? "BeanNameDigitalActions" : "BeanNameDigitalAction");
131    }
132
133    /** {@inheritDoc} */
134    @Override
135    public void deleteDigitalAction(MaleDigitalActionSocket x) {
136        // delete the MaleDigitalActionSocket
137        deregister(x);
138        x.dispose();
139    }
140
141    static volatile DefaultDigitalActionManager _instance = null;
142
143    @InvokeOnGuiThread  // this method is not thread safe
144    static public DefaultDigitalActionManager instance() {
145        if (!ThreadingUtil.isGUIThread()) {
146            LoggingUtil.warnOnce(log, "instance() called on wrong thread");
147        }
148
149        if (_instance == null) {
150            _instance = new DefaultDigitalActionManager();
151        }
152        return (_instance);
153    }
154
155    @Override
156    public Class<MaleDigitalActionSocket> getNamedBeanClass() {
157        return MaleDigitalActionSocket.class;
158    }
159
160    @Override
161    protected MaleDigitalActionSocket castBean(MaleSocket maleSocket) {
162        return (MaleDigitalActionSocket)maleSocket;
163    }
164
165
166    private final static org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(DefaultDigitalActionManager.class);
167
168}