Package jmri.jmrit.logixng.implementation

Class DefaultModuleManager

    • Method Detail

      • getXMLOrder

        public int getXMLOrder()
        Determine the order that types should be written when storing panel files. Uses one of the constants defined in this class.

        Yes, that's an overly-centralized methodology, but it works for now.

        Specified by:
        getXMLOrder in interface Manager<Module>
        Returns:
        write order for this Manager; larger is later.

      • createModule

        public Module createModule​(java.lang.String systemName,
                           java.lang.String userName,
                           FemaleSocketManager.SocketType socketType)
                    throws java.lang.IllegalArgumentException
        Create a new Module if the Module does not exist.
        Specified by:
        createModule in interface ModuleManager
        Parameters:
        systemName - the system name
        userName - the user name
        socketType - the socket type
        Returns:
        a new Module or null if unable to create
        Throws:
        java.lang.IllegalArgumentException - when needed

      • createModule

        public Module createModule​(java.lang.String userName,
                           FemaleSocketManager.SocketType socketType)
                    throws java.lang.IllegalArgumentException
        For use with User GUI, to allow the auto generation of systemNames, where the user can optionally supply a username.
        Specified by:
        createModule in interface ModuleManager
        Parameters:
        userName - the user name
        socketType - the socket type
        Returns:
        a new Module or null if unable to create
        Throws:
        java.lang.IllegalArgumentException - when needed

      • getModule

        public Module getModule​(java.lang.String name)
        Locate via user name, then system name if needed. Does not create a new one if nothing found
        Specified by:
        getModule in interface ModuleManager
        Parameters:
        name - User name or system name to match
        Returns:
        null if no match found

      • getBeanTypeHandled

        public java.lang.String getBeanTypeHandled​(boolean plural)
        Get the user-readable name of the type of NamedBean handled by this manager.

        For instance, in the code where we are dealing with just a bean and a message that needs to be passed to the user or in a log.

        Specified by:
        getBeanTypeHandled in interface Manager<Module>
        Parameters:
        plural - true to return plural form of the type; false to return singular form
        Returns:
        a string of the bean type that the manager handles, eg Turnout, Sensor etc

      • resolveAllTrees

        public boolean resolveAllTrees​(java.util.List<java.lang.String> errors)
        Resolve all the Module trees.

        This method ensures that everything in the Module tree has a pointer to its parent.

        Specified by:
        resolveAllTrees in interface ModuleManager
        Parameters:
        errors - a list of potential errors
        Returns:
        true if success, false otherwise

      • deleteModule

        public void deleteModule​(Module x)
        Delete Module by removing it from the manager. The Module must first be deactivated so it stops processing.
        Specified by:
        deleteModule in interface ModuleManager
        Parameters:
        x - the Module to delete

      • printTree

        public void printTree​(Base.PrintTreeSettings settings,
                      java.io.PrintWriter writer,
                      java.lang.String indent,
                      MutableInt lineNumber)
        Print the tree to a stream.
        Specified by:
        printTree in interface ModuleManager
        Parameters:
        settings - settings for what to print
        writer - the stream to print the tree to
        indent - the indentation of each level
        lineNumber - the line number

      • printTree

        public void printTree​(Base.PrintTreeSettings settings,
                      java.util.Locale locale,
                      java.io.PrintWriter writer,
                      java.lang.String indent,
                      MutableInt lineNumber)
        Print the tree to a stream.
        Specified by:
        printTree in interface ModuleManager
        Parameters:
        settings - settings for what to print
        locale - The locale to be used
        writer - the stream to print the tree to
        indent - the indentation of each level
        lineNumber - the line number

      • getNamedBeanClass

        public java.lang.Class<Module> getNamedBeanClass()
        Get the class of NamedBean supported by this Manager. This should be the generic class used in the Manager's class declaration.
        Specified by:
        getNamedBeanClass in interface Manager<Module>
        Returns:
        the class supported by this Manager.

      • fireVetoableChange

        @OverridingMethodsMustInvokeSuper
public void fireVetoableChange​(java.lang.String p,
                               java.lang.Object old)
                        throws java.beans.PropertyVetoException
        Inform all registered listeners of a vetoable change.If the propertyName is "CanDelete" ALL listeners with an interest in the bean will throw an exception, which is recorded returned back to the invoking method, so that it can be presented back to the user.However if a listener decides that the bean can not be deleted then it should throw an exception with a property name of "DoNotDelete", this is thrown back up to the user and the delete process should be aborted.
        Parameters:
        p - The programmatic name of the property that is to be changed. "CanDelete" will inquire with all listeners if the item can be deleted. "DoDelete" tells the listener to delete the item.
        old - The old value of the property.
        Throws:
        java.beans.PropertyVetoException - If the recipients wishes the delete to be aborted (see above)

      • deleteBean

        public final void deleteBean​(@Nonnull
                             Module module,
                             @Nonnull
                             java.lang.String property)
                      throws java.beans.PropertyVetoException
        Method for a UI to delete a bean.

        The UI should first request a "CanDelete", this will return a list of locations (and descriptions) where the bean is in use via throwing a VetoException, then if that comes back clear, or the user agrees with the actions, then a "DoDelete" can be called which inform the listeners to delete the bean, then it will be deregistered and disposed of.

        If a property name of "DoNotDelete" is thrown back in the VetoException then the delete process should be aborted.

        Specified by:
        deleteBean in interface Manager<Module>
        Overrides:
        deleteBean in class AbstractManager<Module>
        Parameters:
        module - The NamedBean to be deleted
        property - The programmatic name of the request. "CanDelete" will enquire with all listeners if the item can be deleted. "DoDelete" tells the listener to delete the item
        Throws:
        java.beans.PropertyVetoException - If the recipients wishes the delete to be aborted (see above)