Interface StandardizerActionRunner

    • Method Detail

      • standardize

        void standardize()
                  throws IllegalArgumentException
        Invoke a background thread which will run all standardizer actions on the given molecule
        Throws:
        IllegalArgumentException - if the configuration or the molecule contains errors
      • standardizeAndWait

        List<Changes> standardizeAndWait()
                                  throws IllegalArgumentException
        Executes all standardizer actions contained by the pre-set configuration on the given molecule and returns the list of applied changes. For each action of the configuration there is a change object (or null) in the list.
        Returns:
        the list of changes applied on the molecule
        Throws:
        IllegalArgumentException - if the configuration or the molecule contains errors
      • cancel

        void cancel()
        Stops the background thread
      • isRunning

        boolean isRunning()
        This function identifies the state of the standardizer thread
        Returns:
        true if the background thread runs false otherwise
      • getCurrent

        int getCurrent()
        Gets the current progress percent
        Returns:
        the current progress percent
      • getProgessLength

        int getProgessLength()
        Gets the length of the standardization process
        Returns:
        the length of the standardization process
      • getChanges

        List<Changes> getChanges()
        Gets the list of changes applied on the molecule. For each action of the configuration there is a change object (or null) in the list.
        Returns:
        the list of changes applied on the molecule
      • setMolecule

        void setMolecule​(Molecule molecule)
        Sets the molecule to be standardized by the standardizer actions
        Parameters:
        molecule - a Molecule instance to be standardized
      • getConfiguration

        StandardizerConfiguration getConfiguration()
        Gets the configuration of the runner
        Returns:
        the configuration of the runner
      • setConfiguration

        void setConfiguration​(StandardizerConfiguration configuration)
        Sets the configuration of the runner
        Parameters:
        configuration - the configuration to be set to the runner
      • getAppliedActions

        List<StandardizerAction> getAppliedActions()
        Gets the list of actions applied in the configuration at the last execution
        Returns:
        the list of applied actions at the last execution
      • setTargetGroup

        void setTargetGroup​(String groupName)
        Sets the target group of standardizer action of the runner
        Parameters:
        groupName - the name of the group of standardizer actions
      • setTargetGroups

        void setTargetGroups​(String... groupNames)
        Sets the target groups of standardizer action of the runner
        Parameters:
        groupNames - the names of the groups of standardizer actions
      • setLicenseEnvironment

        void setLicenseEnvironment​(String env)
        Sets the license environment of the runner
        Parameters:
        env - the license environment of the runner
      • setIgnoreConfigurationErrors

        void setIgnoreConfigurationErrors​(boolean ignore)
        Sets whether configuration errors should be ignored
        Parameters:
        ignore - whether configuration errors should be ignored