Class Settings


  • public final class Settings
    extends Object
    This class define constants to keys of configuration Aozan file.
    Since:
    1.2.1
    Author:
    Sandrine Perrin
    • Field Detail

      • HISEQ_CRITICAL_MIN_SPACE_KEY

        public static final String HISEQ_CRITICAL_MIN_SPACE_KEY
        Hiseq critical minimum space.
        See Also:
        Constant Field Values
      • HISEQ_WARNING_MIN_SPACE_KEY

        public static final String HISEQ_WARNING_MIN_SPACE_KEY
        Hiseq warning minimum space.
        See Also:
        Constant Field Values
      • BCL2FASTQ_ADAPTER_FASTA_FILE_PATH_KEY

        public static final String BCL2FASTQ_ADAPTER_FASTA_FILE_PATH_KEY
        Blc2fastq adapter fasta file path.
        See Also:
        Constant Field Values
      • BCL2FASTQ_ADDITIONNAL_ARGUMENTS_KEY

        public static final String BCL2FASTQ_ADDITIONNAL_ARGUMENTS_KEY
        Blc2fastq additionnal arguments.
        See Also:
        Constant Field Values
      • BCL2FASTQ_COMPRESSION_KEY

        public static final String BCL2FASTQ_COMPRESSION_KEY
        Bcl2fastq compression fastq files.
        See Also:
        Constant Field Values
      • BCL2FASTQ_COMPRESSION_LEVEL_KEY

        public static final String BCL2FASTQ_COMPRESSION_LEVEL_KEY
        Bcl2fastq compression level.
        See Also:
        Constant Field Values
      • BCL2FASTQ_FASTQ_CLUSTER_COUNT_KEY

        public static final String BCL2FASTQ_FASTQ_CLUSTER_COUNT_KEY
        Bcl2fastq fastq cluster count.
        See Also:
        Constant Field Values
      • SAMPLESHEET_FORMAT_KEY

        public static final String SAMPLESHEET_FORMAT_KEY
        Bcl2fastq samplesheet format.
        See Also:
        Constant Field Values
      • SAMPLESHEET_PREFIX_KEY

        public static final String SAMPLESHEET_PREFIX_KEY
        Bcl2fastq samplesheet prefix filename.
        See Also:
        Constant Field Values
      • BCL2FASTQ_WITH_FAILED_READS_KEY

        public static final String BCL2FASTQ_WITH_FAILED_READS_KEY
        Bcl2fastq with failed reads.
        See Also:
        Constant Field Values
      • SAMPLESHEET_GENERATOR_COMMAND_KEY

        public static final String SAMPLESHEET_GENERATOR_COMMAND_KEY
        Bcl2fastq samplesheet generator command.
        See Also:
        Constant Field Values
      • BCL2FASTQ_USE_DOCKER_KEY

        public static final String BCL2FASTQ_USE_DOCKER_KEY
        Set available use container docker.
        See Also:
        Constant Field Values
      • DEMUX_ARCHIVE_SAMPLESHEETS_KEY

        public static final String DEMUX_ARCHIVE_SAMPLESHEETS_KEY
        Archive samplesheets key.
        See Also:
        Constant Field Values
      • DEMUX_USE_HISEQ_OUTPUT_KEY

        public static final String DEMUX_USE_HISEQ_OUTPUT_KEY
        Demultiplex use Hiseq output.
        See Also:
        Constant Field Values
      • FIRST_BASE_REPORT_STEP_KEY

        public static final String FIRST_BASE_REPORT_STEP_KEY
        First base report step.
        See Also:
        Constant Field Values
      • RECOMPRESS_DELETE_ORIGINAL_FASTQ_KEY

        public static final String RECOMPRESS_DELETE_ORIGINAL_FASTQ_KEY
        Erase input after recompression.
        See Also:
        Constant Field Values
      • RECOMPRESS_COMPRESSION_LEVEL_KEY

        public static final String RECOMPRESS_COMPRESSION_LEVEL_KEY
        Erase input after recompression.
        See Also:
        Constant Field Values
      • RECOMPRESS_THREADS_KEY

        public static final String RECOMPRESS_THREADS_KEY
        Erase input after recompression.
        See Also:
        Constant Field Values
      • RECOMPRESS_COMPRESSION_KEY

        public static final String RECOMPRESS_COMPRESSION_KEY
        Erase input after recompression.
        See Also:
        Constant Field Values
      • READ_ONLY_OUTPUT_FILES_KEY

        public static final String READ_ONLY_OUTPUT_FILES_KEY
        Change the output file rights.
        See Also:
        Constant Field Values
      • INDEX_HTML_TEMPLATE_KEY

        public static final String INDEX_HTML_TEMPLATE_KEY
        Index html template path.
        See Also:
        Constant Field Values
      • QC_REPORT_SAVE_RAW_DATA_KEY

        public static final String QC_REPORT_SAVE_RAW_DATA_KEY
        QC report save raw data.
        See Also:
        Constant Field Values
      • QC_REPORT_SAVE_REPORT_DATA_KEY

        public static final String QC_REPORT_SAVE_REPORT_DATA_KEY
        QC report save report data.
        See Also:
        Constant Field Values
      • QC_REPORT_STYLESHEET_KEY

        public static final String QC_REPORT_STYLESHEET_KEY
        QC report stylesheet path.
        See Also:
        Constant Field Values
      • SYNC_CONTINUOUS_SYNC_KEY

        public static final String SYNC_CONTINUOUS_SYNC_KEY
        Synchronization continuous.
        See Also:
        Constant Field Values
      • SYNC_CONTINUOUS_SYNC_MIN_AGE_FILES_KEY

        public static final String SYNC_CONTINUOUS_SYNC_MIN_AGE_FILES_KEY
        Synchronization continuous minimum ages files.
        See Also:
        Constant Field Values
      • SYNC_EXCLUDE_CIF_KEY

        public static final String SYNC_EXCLUDE_CIF_KEY
        Synchronization exclude cif files.
        See Also:
        Constant Field Values
      • SYNC_SPACE_FACTOR_KEY

        public static final String SYNC_SPACE_FACTOR_KEY
        Synchronization space factor.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_CONTAMINANT_FILE_KEY

        public static final String QC_CONF_FASTQC_CONTAMINANT_FILE_KEY
        Collector FastQC contaminant file.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_KMER_SIZE_KEY

        public static final String QC_CONF_FASTQC_KMER_SIZE_KEY
        Collector FastQC kmer size.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_NOGROUP_KEY

        public static final String QC_CONF_FASTQC_NOGROUP_KEY
        Collector FastQC nogroup.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_ADAPTER_FILE_KEY

        public static final String QC_CONF_FASTQC_ADAPTER_FILE_KEY
        Path to a specific adapter file, replace default file.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_LIMITS_FILE_KEY

        public static final String QC_CONF_FASTQC_LIMITS_FILE_KEY
        Path to a specific limits file, replace default file.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_EXPGROUP_KEY

        public static final String QC_CONF_FASTQC_EXPGROUP_KEY
        Use exponential base groups in graph.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_CASAVA_KEY

        public static final String QC_CONF_FASTQC_CASAVA_KEY
        Illumina FASTQ format for FastQC.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_NOFILTER_KEY

        public static final String QC_CONF_FASTQC_NOFILTER_KEY
        Filter bad Illumina FASTQ entry in FastQC.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_NANO_KEY

        public static final String QC_CONF_FASTQC_NANO_KEY
        New option with FastQC 0.11.3 to nanopore technology, use Fast5 file instead of FastQ
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_BLAST_ARGUMENTS_KEY

        public static final String QC_CONF_FASTQC_BLAST_ARGUMENTS_KEY
        Collector fastqscreen blast arguments.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_BLAST_DB_PATH_KEY

        public static final String QC_CONF_FASTQC_BLAST_DB_PATH_KEY
        Collector FastQC blast database path.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_BLAST_ENABLE_KEY

        public static final String QC_CONF_FASTQC_BLAST_ENABLE_KEY
        Collector FastQC blast enable.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_BLAST_PATH_KEY

        public static final String QC_CONF_FASTQC_BLAST_PATH_KEY
        Collector FastQC blast path.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_BLAST_USE_DOCKER_KEY

        public static final String QC_CONF_FASTQC_BLAST_USE_DOCKER_KEY
        Use Docker for Blast.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_FASTQ_MAX_READS_PARSED_KEY

        public static final String QC_CONF_FASTQSCREEN_FASTQ_MAX_READS_PARSED_KEY
        Collector fastqscreen fastq max reads parsed.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_FASTQ_READS_PF_USED_KEY

        public static final String QC_CONF_FASTQSCREEN_FASTQ_READS_PF_USED_KEY
        Collector fastqscreen fastq reads pf used.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_GENOMES_KEY

        public static final String QC_CONF_FASTQSCREEN_GENOMES_KEY
        Collector fastqscreen genomes.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_MAPPER_KEY

        public static final String QC_CONF_FASTQSCREEN_MAPPER_KEY
        Collector fastqscreen mapper.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_MAPPER_ARGUMENTS_KEY

        public static final String QC_CONF_FASTQSCREEN_MAPPER_ARGUMENTS_KEY
        Collector fastqscreen mapper argument.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_MAPPING_IGNORE_PAIRED_END_MODE_KEY

        public static final String QC_CONF_FASTQSCREEN_MAPPING_IGNORE_PAIRED_END_MODE_KEY
        Collector fastqscreen mapping ignore paired mode.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_MAPPING_SKIP_CONTROL_LANE_KEY

        public static final String QC_CONF_FASTQSCREEN_MAPPING_SKIP_CONTROL_LANE_KEY
        Collector fastqscreen mapping skip control lane.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_GENOMES_PATH_KEY

        public static final String QC_CONF_FASTQSCREEN_GENOMES_PATH_KEY
        Collector fastqscreen settings genomes.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_GENOMES_ALIAS_PATH_KEY

        public static final String QC_CONF_FASTQSCREEN_GENOMES_ALIAS_PATH_KEY
        Collector fastqscreen settings genomes alias path.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_GENOMES_DESC_PATH_KEY

        public static final String QC_CONF_FASTQSCREEN_GENOMES_DESC_PATH_KEY
        Collector fastqscreen settings genomes description path.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_MAPPERS_INDEXES_PATH_KEY

        public static final String QC_CONF_FASTQSCREEN_MAPPERS_INDEXES_PATH_KEY
        Collector fastqscreen settings mappers indexes path.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_MAX_READ_LENGTH_KEY

        public static final String QC_CONF_FASTQSCREEN_MAX_READ_LENGTH_KEY
        Collector fastqscreen settings max read length.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_XSL_FILE_KEY

        public static final String QC_CONF_FASTQSCREEN_XSL_FILE_KEY
        Collector fastqscreen xsl file.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_PROJECT_XSL_FILE_KEY

        public static final String QC_CONF_FASTQSCREEN_PROJECT_XSL_FILE_KEY
        Collector project, fastqscreen xsl file
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_PERCENT_PROJECT_CONTAMINATION_THRESHOLD_KEY

        public static final String QC_CONF_FASTQSCREEN_PERCENT_PROJECT_CONTAMINATION_THRESHOLD_KEY
        Collector project, fastqscreen xsl file
        See Also:
        Constant Field Values
      • QC_CONF_MULTIQC_USE_DOCKER_KEY

        public static final String QC_CONF_MULTIQC_USE_DOCKER_KEY
        Use Docker for MultiQC.
        See Also:
        Constant Field Values
      • QC_CONF_READ_XML_COLLECTOR_USED_KEY

        public static final String QC_CONF_READ_XML_COLLECTOR_USED_KEY
        Collector read xml collector used.
        See Also:
        Constant Field Values
      • QC_CONF_UNDETERMINED_INDEXED_XSL_FILE_KEY

        public static final String QC_CONF_UNDETERMINED_INDEXED_XSL_FILE_KEY
        Collector undetermined indexed xsl file.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_PROCESS_UNDETERMINED_SAMPLES_KEY

        public static final String QC_CONF_FASTQC_PROCESS_UNDETERMINED_SAMPLES_KEY
        Collector FastQC, process on undetermined indices samples, default at false.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_UNZIP_REPORT_FILE_KEY

        public static final String QC_CONF_FASTQC_UNZIP_REPORT_FILE_KEY
        Collector FastQC, unzip report file.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQC_KEEP_ZIP_REPORT_FILE_KEY

        public static final String QC_CONF_FASTQC_KEEP_ZIP_REPORT_FILE_KEY
        Collector FastQC, keep zip report file.
        See Also:
        Constant Field Values
      • QC_CONF_FASTQSCREEN_PROCESS_UNDETERMINED_SAMPLES_KEY

        public static final String QC_CONF_FASTQSCREEN_PROCESS_UNDETERMINED_SAMPLES_KEY
        Collector FastqScreen, process on undetermined indices samples, default at false.
        See Also:
        Constant Field Values
    • Constructor Detail

      • Settings

        public Settings​(Map<String,​String> map)
        Public constructor.
        Parameters:
        map - Aozan configuration
    • Method Detail

      • get

        public String get​(String key)
        Get a setting value.
        Parameters:
        key - the setting key
        Returns:
        the value of the setting
      • containsKey

        public boolean containsKey​(String key)
        Test if the settings contains a key.
        Parameters:
        key - the setting key
        Returns:
        true if the settins contains the key
      • entrySet

        public Set<Map.Entry<String,​String>> entrySet()
        Get an entry set of the setting values.
        Returns:
        an entry set of the settings