SequenceSet (bio.seq API)

All Superinterfaces:

Collection<Sequence>, Iterable<Sequence>, Representable, Serializable

All Known Implementing Classes:

NamedSequenceSet, SimpleSequenceSet
```
public interface SequenceSet
extends Collection<Sequence>, Serializable, Representable
```
Хранилище наблюдаемых и соответствующих им скрытых последовательностей. С другой стороны, хранилище можно рассматривать как набор строк полных состояний.
Наблюдаемые и скрытые последовательности представляются в виде байтовых массивов. Каждый элемент массива отвечает отдельному наблюдаемому или скрытому состоянию; соответствие между целочисленным представлением состояний и их смыслом в рамках предметной области определяется с помощью алфавитов наблюдаемых и скрытых состояний. Алфавит представляет собой строку, каждый символ которой должен быть уникальным и обозначать одно из состояний, определяемых предметной областью. Полные состояния также могут быть представлены алфавитом, однако это представление не является обязательным.
Пример. Для задачи распознавания фрагментов генов:
- Наблюдаемых состояний четверо, они соответствуют нуклеотидам — аденину (обычно обозначается A), цитозину (C), гуанину (G) и тимину (T). Алфавит наблюдаемых состояний — строка "ACGT".
- Скрытых состояний двое — нуклеотиды, принадлежащие экзонам (обозначается x) и интронам (i); таким образом, алфавит скрытых состояний — строка "xi".
- Полных состояний восемь; полные состояния, которые соответствуют нуклеотидам в экзонах, обозначаются заглавными буквами ((A,x) == A), а соответствующие интронам — прописными ((T,i) == t).
Хранилище set, состоящее из единственной строки полных состояний "ACg" (нуклеотид аденин, относящийся к экзону, нуклеотид цитозин, относящийся к экзону, а также нуклеотид гуанин, относящийся к интрону), удовлетворяет следующим свойствам:
```
 assert(set.length() == 1);
 assert(set.observedStates().equals("ACGT"));
 assert(set.hiddenStates().equals("xi"));
 assert(set.completeStates().equals("ACGTacgt"));
 assert(Arrays.equals(set.observed(0), new byte[] { 0, 1, 2 }));
 assert(Arrays.equals(set.hidden(0), new byte[] { 0, 0, 1 }));
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`SequenceSet.Filter` Интерфейс, используемый для фильтрации набора последовательностей.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`completeStates()` Возвращает алфавит полных состояний.
`SequenceSet`	`filter(boolean[] selector)` Фильтрует набор последовательностей в соответствии с заданным индикатором вхождения.
`SequenceSet`	`filter(SequenceSet.Filter filter)` Фильтрует набор последовательностей в соответствии с заданным фильтром.
`Sequence`	`get(int index)` Возвращает из выборки прецедент с заданным номером.
`byte[]`	`hidden(int index)` Возвращает строку скрытых состояний с заданным номером.
`String`	`hiddenStates()` Возвращает алфавит скрытых состояний.
`String`	`id(int index)` Возвращает идентификатор для наблюдаемой строки с заданным номером.
`SequenceSet`	`join(SequenceSet other, SequenceSet... more)` Создает выборку путем слияния нескольких выборок.
`byte[]`	`observed(int index)` Возвращает строку наблюдаемых состояний с заданным номером.
`String`	`observedStates()` Возвращает алфавит наблюдаемых состояний.
`void`	`saveToFile(String filename)` Сохраняет набор последовательностей в файл.
`int`	`size()` Возвращает количество строк наблюдаемых (или скрытых) состояний, помещенных в хранилище.

Methods inherited from interface java.util.Collection
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, toArray, toArray

Methods inherited from interface ua.kiev.icyb.bio.Representable
repr

- Method Detail
  - size
```
int size()
```
    Возвращает количество строк наблюдаемых (или скрытых) состояний, помещенных в хранилище.
    
    Specified by:
    
    size in interface Collection<Sequence>
    
    Returns:
    количество строк в этом хранилище
  - observed
```
byte[] observed(int index)
```
    Возвращает строку наблюдаемых состояний с заданным номером.
    
    Parameters:
    index - индекс (с отсчетом от нуля) последовательности наблюдаемых состояний в этом наборе
    
    Returns:
    байтовый массив, каждый элемент которого представляет отдельное наблюдаемое состояние
  - hidden
```
byte[] hidden(int index)
```
    Возвращает строку скрытых состояний с заданным номером.
    
    Parameters:
    index - индекс (с отсчетом от нуля) последовательности скрытых состояний в этом наборе
    
    Returns:
    байтовый массив, каждый элемент которого представляет отдельное скрытое состояние
  - id
```
String id(int index)
```
    Возвращает идентификатор для наблюдаемой строки с заданным номером. Смысл идентификатора зависит от задачи; для задач биоинформатики существуют универсальные идентификаторы генов и белков.
    
    Parameters:
    index - индекс (с отсчетом от нуля) последовательности наблюдаемых состояний в этом наборе
    
    Returns:
    строковый идентификатор последовательности; идентификатор может быть равен null
  - get
```
Sequence get(int index)
```
    Возвращает из выборки прецедент с заданным номером.
    
    Parameters:
    index - номер прецедента (с отсчетом от нуля)
    
    Returns:
    прецедент из выборки
  - observedStates
```
String observedStates()
```
    Возвращает алфавит наблюдаемых состояний.
    
    Returns:
    строка, каждый символ которой уникален и обозначает одно из наблюдаемых состояний
  - hiddenStates
```
String hiddenStates()
```
    Возвращает алфавит скрытых состояний.
    
    Returns:
    строка, каждый символ которой уникален и обозначает одно из скрытых состояний
  - completeStates
```
String completeStates()
```
    Возвращает алфавит полных состояний. Если алфавит полных состяний не определен, вовращает null. Вначале перечисляются все состояния, скрытая часть которых равна первому скрытому состоянию, возвращаемому hiddenStates(); порядок перечисления определяется наблюдаемой частью состояний и совпадает с их порядком в алфавите observedStates(). Затем перечисляются все полные состояния со скрытой частью, равной
```
 this.hiddenStates().charAt(1)
 
```
    и так далее.
    Returns:
    строка, каждый символ которой уникален и обозначает одно из полных состояний; null, если алфавит полных состояний не определен
  - join
```
SequenceSet join(SequenceSet other,
               SequenceSet... more)
```
    Создает выборку путем слияния нескольких выборок. Последовательность строк в полученной выборке соответствует порядку перечисления аргументов метода: сначала идут строки из текущей выборки, затем - из other и т.д.
    
    Parameters:
    other - множество, которое добавляется к выборке
    more - дополнительные множества
  - filter
```
SequenceSet filter(boolean[] selector)
```
    Фильтрует набор последовательностей в соответствии с заданным индикатором вхождения. Наблюдаемые и скрытые строки в отфильтрованном наборе располагаются в том же порядке, в каком они находились в исходном наборе.
    
    Parameters:
    selector - массив булевых величин, определяющий для каждой пары наблюдаемой и соответствущей скрытой строк в исходном наборе, будут ли они входить в отфильтрованный набор. Длина массива не должна быть меньше размера исходного набора.
    
    Returns:
    отфильтрованный набор последовательностей
  - filter
```
SequenceSet filter(SequenceSet.Filter filter)
```
    Фильтрует набор последовательностей в соответствии с заданным фильтром. Наблюдаемые и скрытые строки в отфильтрованном наборе располагаются в том же порядке, в каком они находились в исходном наборе.
    
    Parameters:
    filter - фильтр, определяющий вхождение пар наблюдаемых и скрытых строк из исходного набора в новый набор
    
    Returns:
    отфильтрованный набор последовательностей
  - saveToFile
```
void saveToFile(String filename)
                throws IOException
```
    Сохраняет набор последовательностей в файл.
    
    Parameters:
    filename - имя файла, в который производится сохранение
    
    Throws:
    
    IOException - если в процессе сохранения проихошла ошибка ввода/вывода

Interface SequenceSet

Nested Class Summary

Method Summary

Methods inherited from interface java.util.Collection

Methods inherited from interface ua.kiev.icyb.bio.Representable

Method Detail

size

observed

hidden

id

get

observedStates

hiddenStates

completeStates

join

filter

filter

saveToFile