Env (bio.seq API)

java.lang.Object
- ua.kiev.icyb.bio.Env

All Implemented Interfaces:

Representable
```
public class Env
extends Object
implements Representable
```
Набор инструментов для работы с окружением.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Env.ObjInputStream` Поток для загрузки данных, предоставляющий доступ к окружению, в пределах которого выполняется загрузка.

Constructor Summary

Constructors
Constructor and Description
`Env()` Создает окружение с настройками по умолчанию.
`Env(String configFile)` Создает окружение с настройками, которые читаются из файла конфигурации.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addDataset(String name, String filename)` Добавляет соответствие между именем выборки и файлом.
`void`	`debug(int level, String message)` Печатает отладочное сообщение в стандартный вывод `System.out`.
`void`	`debugInline(int level, String message)` Печатает короткое отладочное сообщение в стандартный вывод `System.out`.
`int`	`debugLevel()` Возвращает уровень отладки, влияющий на детальность выводимой информации.
`void`	`error(int level, String message)` Печатает отладочное сообщение в стандартный поток ошибок `System.err`.
`void`	`exception(Exception e)` Уведомляет о возникновении исключительной ситуации.
`ExecutorService`	`executor()` Пул вычислительных потоков, который может использоваться для параллельных вычислений.
`void`	`finalize()`
`static BufferedReader`	`getReader(String filename)` Создает автомат для чтения из текстового файла с буфером.
`static BufferedWriter`	`getWriter(String filename)` Создает автомат для записи в текстовый файл с буфером.
`boolean`	`interruptedByError()` Было ли выполнение текущего задания прервано из-за ошибки?
`boolean`	`interruptedByUser()` Было ли выполнение текущего задания прервано пользователем (напр., с помощью нажатия `^C`)?
`<T extends Serializable> T`	`load(String filename)` Считывает сериализуемый объект из двоичного файла, в который тот был сохранен методом `save(Serializable, String)`.
`SequenceSet`	`loadSet(String datasetName)` Заргужает именованную выборку.
`protected void`	`processProperty(String key, String value)` Обрабатывает опцию из файла конфигурации.
`String`	`repr()` Возвращает более или менее детализированное текстовое представление объекта.
`BufferedReader`	`resolveDataset(String name)` Возвращает автомат для чтения указанной именованной выборки.
`void`	`run(Launchable task)` Запускает задание.
`void`	`run(Launchable task, String saveFile)` Запускает задание с сохранением результатов выполнения в файл.
`void`	`save(Serializable obj, String filename)` Записывает сериализуемый объект в двоичный файл.
`String`	`saveProgress()` Сохраняет данные текущего задания в файл, заданный при вызове метода `run(Launchable, String)`.
`void`	`setDebugLevel(int level)` Устанавливает уровень отладки.
`void`	`setEncoding(String encoding)` Устанавливает кодировку выходных потоков.
`void`	`setLocale(String locale)` Устанавливает локаль.
`void`	`setThreadCount(int threadCount)` Устанавливает количество потоков выполнения.
`int`	`threadCount()` Возвращает количество вычислительных потоков при параллельных вычислениях, задаваемое соответствующей переменной окружения.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Env
```
public Env()
```
    Создает окружение с настройками по умолчанию.
  - Env
```
public Env(String configFile)
    throws IOException
```
    Создает окружение с настройками, которые читаются из файла конфигурации. Файл конигурации должен быть текстовым файлом в формате, определенном согласно классу Properties.
    Определенные настройки:
    - env.debug — определяет уровень отладки;
    - env.threads — определяет количество потоков выполнения;
    - env.locale — определяет локализацию сообщений;
    - env.encoding — определяет кодировку сообщений.
    Остальные настройки воспринимаются как соответствие между названиями выборок и файлами, в которых хранятся выборки, например
    elegans = path/to/file/elegans.gz
    Путь к файлу выборки указывается относительно пути к файлу конфигурации.
    Parameters:
    configFile - имя файла конфигурации
    
    Throws:
    
    IOException - при ошибке чтения из файла
- Method Detail
  - getReader
```
public static BufferedReader getReader(String filename)
                                throws IOException
```
    Создает автомат для чтения из текстового файла с буфером. Если имя файла заканчивается на «.gz», полагается, что файл сжат с помощью алгоритма GZIP.
    
    Parameters:
    filename - имя файла
    
    Returns:
    автомат для считывания файла
    
    Throws:
    
    IOException - если во время создания автомата произошла ошибка (например, файла не существует)
  - getWriter
```
public static BufferedWriter getWriter(String filename)
                                throws IOException
```
    Создает автомат для записи в текстовый файл с буфером. Если имя файла заканчивается на «.gz», полагается, что файл следует сжимать с помощью алгоритма GZIP.
    
    Parameters:
    filename - имя файла
    
    Returns:
    автомат для записи в файл
    
    Throws:
    
    IOException - если во время создания автомата произошла ошибка
  - processProperty
```
protected void processProperty(String key,
                   String value)
```
    Обрабатывает опцию из файла конфигурации.
    
    Parameters:
    key - имя опции
    value - значение опции
  - interruptedByUser
```
public boolean interruptedByUser()
```
    Было ли выполнение текущего задания прервано пользователем (напр., с помощью нажатия ^C)?
    
    Returns:
    true, если выполнение прервано пользователем
  - interruptedByError
```
public boolean interruptedByError()
```
    Было ли выполнение текущего задания прервано из-за ошибки?
    
    Returns:
    true, если выполнение прервано из-за ошибки
  - debugLevel
```
public int debugLevel()
```
    Возвращает уровень отладки, влияющий на детальность выводимой информации. Значение 0 соответстует выводу только наиболее важных сведений; значения меньше нуля подавляют весь вывод; значения больше нуля увеличивают объем информации для вывода.
    
    Returns:
    уровень отладки
  - setDebugLevel
```
public void setDebugLevel(int level)
```
    Устанавливает уровень отладки. Чем выше уровень отладки, тем больше сообщений выводится во время выполнения алгоритмов.
    
    Parameters:
    level - новый уровень отладки
  - setLocale
```
public void setLocale(String locale)
```
    Устанавливает локаль.
    
    Parameters:
    locale - текстовое представление локали, например, 'en_US'
  - setEncoding
```
public void setEncoding(String encoding)
```
    Устанавливает кодировку выходных потоков.
    
    Parameters:
    encoding - текстовое представление кодировки, например 'UTF-8'
  - setThreadCount
```
public void setThreadCount(int threadCount)
```
    Устанавливает количество потоков выполнения.
    
    Parameters:
    threadCount - количество потоков или отрицательное число для автоматического выбора
  - addDataset
```
public void addDataset(String name,
              String filename)
```
    Добавляет соответствие между именем выборки и файлом.
    
    Parameters:
    name - имя выборки
    filename - имя файла, содержащего данные выборки
  - exception
```
public void exception(Exception e)
               throws RuntimeException
```
    Уведомляет о возникновении исключительной ситуации.
    
    Parameters:
    e - объект исключения
    
    Throws:
    
    RuntimeException - вызывается гарантированно
  - resolveDataset
```
public BufferedReader resolveDataset(String name)
                              throws IOException
```
    Возвращает автомат для чтения указанной именованной выборки. Если указанное имя не соответствует выборке, оно трактуется как имя файла.
    
    Parameters:
    name - имя выборки
    
    Returns:
    автомат для чтения выборки
    
    Throws:
    
    IOException - если при создании автомата возникла ошибка ввода/вывода
  - debug
```
public void debug(int level,
         String message)
```
    Печатает отладочное сообщение в стандартный вывод System.out.
    
    Parameters:
    level - минимальный уровень отладки, необходимый чтобы напечатать сообщение
    message - печатаемое сообщение
  - error
```
public void error(int level,
         String message)
```
    Печатает отладочное сообщение в стандартный поток ошибок System.err.
    
    Parameters:
    level - минимальный уровень отладки, необходимый чтобы напечатать сообщение
    message - печатаемое сообщение
  - debugInline
```
public void debugInline(int level,
               String message)
```
    Печатает короткое отладочное сообщение в стандартный вывод System.out. В отличие от метода debug(int, String), после вывода сообщения не ставится символ переноса строки '\n'.
    
    Parameters:
    level - минимальный уровень отладки, необходимый чтобы напечатать сообщение
    message - печатаемое сообщение
  - threadCount
```
public int threadCount()
```
    Возвращает количество вычислительных потоков при параллельных вычислениях, задаваемое соответствующей переменной окружения.
    
    Returns:
    количество вычислительных потоков
  - executor
```
public ExecutorService executor()
```
    Пул вычислительных потоков, который может использоваться для параллельных вычислений. Число потоков в пуле определяется методом threadCount().
    
    Returns:
    пул потоков для параллельных вычислений
  - run
```
public void run(Launchable task)
```
    Запускает задание.
    
    Parameters:
    task - задание
  - run
```
public void run(Launchable task,
       String saveFile)
```
    Запускает задание с сохранением результатов выполнения в файл.
    
    Parameters:
    task - задание
    saveFile - файл, в который сохраняются результаты выполнения
  - loadSet
```
public SequenceSet loadSet(String datasetName)
                    throws IOException
```
    Заргужает именованную выборку. Окружение поддерживает кэширование, т.е. при вызове метода с одинаковыми аргументами возвращается один и тот же объект.
    
    Parameters:
    datasetName - имя выборки, которую нужно загрузить
    
    Returns:
    объект выборки
    
    Throws:
    
    IOException - при ошибке ввода/вывода
  - load
```
public <T extends Serializable> T load(String filename)
                            throws IOException
```
    Считывает сериализуемый объект из двоичного файла, в который тот был сохранен методом save(Serializable, String).
    
    Parameters:
    filename - имя файла
    
    Returns:
    считанный объект
    
    Throws:
    
    IOException - если во время чтения произошла ошибка ввода/вывода; в том числе, если не найден один из классов сериализованных объектов
  - save
```
public void save(Serializable obj,
        String filename)
          throws IOException
```
    Записывает сериализуемый объект в двоичный файл. Файл сжимается с помощью алгоритма GZIP.
    
    Parameters:
    obj - объект, который надо записать
    filename - имя файла, в который производится запись
    
    Throws:
    
    IOException - в случае ошибки ввода/вывода во время записи
  - saveProgress
```
public String saveProgress()
```
    Сохраняет данные текущего задания в файл, заданный при вызове метода run(Launchable, String).
    Эта имплементация метода дополнительно пытается перед сохранением скопировать предыдущее сохранение в файл, имя которого получается добавлением к исходному имени тильды '~' (например, test.run~ для test.run).
  - repr
```
public String repr()
```
    Description copied from interface: Representable
    
    Возвращает более или менее детализированное текстовое представление объекта. В отличие от метода Object.toString(), подразумевается, что представление занимает одну или более полных строк.
    
    Specified by:
    
    repr in interface Representable
    
    Returns:
    текстовое представление объекта
  - finalize
```
public void finalize()
```
    Overrides:
    
    finalize in class Object

Class Env

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Env

Env

Method Detail

getReader

getWriter

processProperty

interruptedByUser

interruptedByError

debugLevel

setDebugLevel

setLocale

setEncoding

setThreadCount

addDataset

exception

resolveDataset

debug

error

debugInline

threadCount

executor

run

run

loadSet

load

save

saveProgress

repr

finalize