Package adams.flow.transformer

Class AbstractReportFileImport<T extends Report>

    • Field Detail

      • BACKUP_REPORTS

        public static final String BACKUP_REPORTS
        the key for storing the current reports in the backup.
        See Also:
        Constant Field Values

      • m_IDs

        protected List<Integer> m_IDs
        the IDs of the chromatograms that have been imported.

      • m_Reports

        protected List<T extends Report> m_Reports
        the reports that have been read.

      • m_RemoveExisting

        protected boolean m_RemoveExisting
        whether to remove existing reports (i.e., completely remove them from the DB).

      • m_Import

        protected boolean m_Import
        whether to import the containers into the database.

      • m_Forward

        protected boolean m_Forward
        whether to forward the containers instead of the IDs.

      • m_Merge

        protected boolean m_Merge
        whether to merge the current and existing report.

      • m_OverwriteFields

        protected Field[] m_OverwriteFields
        the fields to overwrite in "merge" mode.

    • Constructor Detail

      • AbstractReportFileImport

        public AbstractReportFileImport()

    • Method Detail

      • getDefaultReader

        protected abstract AbstractReportReader<T> getDefaultReader()
        Returns the default reader for loading the reports.
        Returns:
        the default reader

      • setReader

        public void setReader​(AbstractReportReader value)
        Sets the reader to use.
        Parameters:
        value - the filter

      • getReader

        public AbstractReportReader getReader()
        Returns the reader in use.
        Returns:
        the reader

      • readerTipText

        public String readerTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setRemoveExisting

        public void setRemoveExisting​(boolean value)
        Sets whether existing reports are removed first.
        Parameters:
        value - if true then existing reports will be removed first

      • getRemoveExisting

        public boolean getRemoveExisting()
        Returns whether existing reports are removed first.
        Returns:
        true if are removed first

      • removeExistingTipText

        public String removeExistingTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setForward

        public void setForward​(boolean value)
        Sets whether to forward the containers instead of the IDs.
        Parameters:
        value - if true then the containers are forwarded

      • getForward

        public boolean getForward()
        Returns whether to forward the containers or the IDs.
        Returns:
        true if the containers are forwarded

      • forwardTipText

        public String forwardTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setImport

        public void setImport​(boolean value)
        Sets whether to import the containers into the database.
        Parameters:
        value - if true then the containers are imported

      • getImport

        public boolean getImport()
        Returns whether to import the containers into the database.
        Returns:
        true if the containers are imported

      • importTipText

        public String importTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setMerge

        public void setMerge​(boolean value)
        Sets whether the information of the current report is added to an existing one.
        Parameters:
        value - if true then information is added

      • getMerge

        public boolean getMerge()
        Returns whether the information of current report is added to an existing one.
        Returns:
        true if information is added

      • mergeTipText

        public String mergeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOverwriteFields

        public void setOverwriteFields​(Field[] value)
        Sets the fields to overwrite in "merge" mode.
        Parameters:
        value - the fields

      • getOverwriteFields

        public Field[] getOverwriteFields()
        Returns the fields to overwrite in "merge" mode.
        Returns:
        the fields

      • overwriteFieldsTipText

        public String overwriteFieldsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class AbstractActor

      • getReportProvider

        protected abstract ReportProviderByDBID<T> getReportProvider()
        Returns the report provider to use for writing the reports to the database.
        Returns:
        the provider to use

      • getReportClass

        protected abstract Class getReportClass()
        Returns the report class in use.
        Returns:
        the report class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        java.lang.Integer.class