ua.kiev.icyb.bio

Class SimpleSequenceSet

java.lang.Object

java.util.AbstractCollection<Sequence>

ua.kiev.icyb.bio.SimpleSequenceSet

All Implemented Interfaces:

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

Direct Known Subclasses:

NamedSequenceSet

public class SimpleSequenceSet
extends AbstractCollection<Sequence>
implements SequenceSet

Имплементация контейнера для хранения строк полных состояний, определяемая интерфейсом SequenceSet.

Хранение данных

Для постоянного хранения наборов полных состояний используются текстовые файлы в одном из двух форматов. Если задан алфавит полных состояний, используется формат файла

 <алфавит наблюдаемых состояний> <алфавит скрытых состояний> <алфавит полных состояний>
 c: <первая строка полных состояний>
 c: <вторая строка полных состояний>
 ...
 c: <последняя строка полных состояний>
 

Если алфавит полных состояний не задан, используется следующий формат:

 <алфавит наблюдаемых состояний> <алфавит скрытых состояний>
 o: <первая строка наблюдаемых состояний>
 h: <первая строка скрытых состояний>
 o: <вторая строка наблюдаемых состояний>
 h: <вторая строка скрытых состояний>
 ...
 

Файл может быть сжат с помощью алгоритма GZIP; в этом случае он должен заканчиваться расширением «.gz».

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface ua.kiev.icyb.bio.SequenceSet

SequenceSet.Filter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	writeContent Следует ли записывать содержимое выборки при сериализации.

Constructor Summary

Constructors

Modifier	Constructor and Description
	SimpleSequenceSet(BufferedReader reader) Загружает выборку из текстового потока данных.
protected	SimpleSequenceSet(SequenceSet other) Копирующий конструктор.
	SimpleSequenceSet(String observedStates, String hiddenStates, String completeStates) Создает новую пустую выборку.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(Sequence sequence) Добавляет в коллекцию пару из наблюдаемой и соответстующей скрытой последовательности состояний.
protected void	addSet(SequenceSet set) Добавляет все строки из другой выборки в эту выборку.
protected String	autoID() Возвращает автоматически сгенерированный идентификатор прецедента.
void	clear()
String	completeStates() Возвращает алфавит полных состояний.
boolean	contains(Object obj)
protected boolean	doAdd(Sequence sequence) Добавляет в коллекцию пару из наблюдаемой и соответстующей скрытой последовательности состояний.
boolean	equals(Object obj)
SequenceSet	filter(boolean[] selector) Фильтрует набор последовательностей в соответствии с заданным индикатором вхождения.
SequenceSet	filter(SequenceSet.Filter filter) Фильтрует набор последовательностей в соответствии с заданным фильтром.
Sequence	get(int index) Возвращает из выборки прецедент с заданным номером.
int	hashCode()
byte[]	hidden(int index) Возвращает строку скрытых состояний с заданным номером.
String	hiddenStates() Возвращает алфавит скрытых состояний.
String	id(int index) Возвращает идентификатор для наблюдаемой строки с заданным номером.
Iterator<Sequence>	iterator()
SequenceSet	join(SequenceSet other, SequenceSet... more) Создает выборку путем слияния нескольких выборок.
byte[]	observed(int index) Возвращает строку наблюдаемых состояний с заданным номером.
String	observedStates() Возвращает алфавит наблюдаемых состояний.
protected void	read(BufferedReader reader) Выполняет чтение строк выборки из текстового файла.
Sequence	remove(int index) Удаляет из коллекции прецедент с заданным индексом.
String	repr() Возвращает более или менее детализированное текстовое представление объекта.
void	saveToFile(String fileName) Сохраняет набор последовательностей в файл.
int	size() Возвращает количество строк наблюдаемых (или скрытых) состояний, помещенных в хранилище.
String	toString()

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

addAll, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Field Detail

writeContent

protected boolean writeContent

Следует ли записывать содержимое выборки при сериализации.

Constructor Detail

SimpleSequenceSet

public SimpleSequenceSet(String observedStates,
                 String hiddenStates,
                 String completeStates)

Создает новую пустую выборку.

Parameters:

observedStates - алфавит наблюдаемых состояний

hiddenStates - алфавит скрытых состояний

completeStates - алфавит полных состояний (может быть равен null)

SimpleSequenceSet

public SimpleSequenceSet(BufferedReader reader)
                  throws IOException

Загружает выборку из текстового потока данных.

Parameters:

reader - поток данных, из которого читается информация о строках выборки

Throws:

IOException - если при чтении файла выборки произошла ошибка ввода/вывода

SimpleSequenceSet

protected SimpleSequenceSet(SequenceSet other)

Копирующий конструктор.

Parameters:

other - выборка, которую необходимо скопировать

Method Detail

autoID

protected String autoID()

Возвращает автоматически сгенерированный идентификатор прецедента. Используется в методе read(BufferedReader) для прецедентов, у которых явно не задан идентификатор.

Реализация по умолчанию возвращает номер прецедента в выборке.

Returns:

идентификатор прецедента

read

protected void read(BufferedReader reader)
             throws IOException

Выполняет чтение строк выборки из текстового файла.

Parameters:

reader - автомат для считывания строк выборки

Throws:

IOException

size

public int size()

Description copied from interface: SequenceSet

Возвращает количество строк наблюдаемых (или скрытых) состояний, помещенных в хранилище.

Specified by:

size in interface Collection<Sequence>

Specified by:

size in interface SequenceSet

Specified by:

size in class AbstractCollection<Sequence>

Returns:

количество строк в этом хранилище

observed

public byte[] observed(int index)

Description copied from interface: SequenceSet

Возвращает строку наблюдаемых состояний с заданным номером.

Specified by:

observed in interface SequenceSet

Parameters:

index - индекс (с отсчетом от нуля) последовательности наблюдаемых состояний в этом наборе

Returns:

байтовый массив, каждый элемент которого представляет отдельное наблюдаемое состояние

hidden

public byte[] hidden(int index)

Description copied from interface: SequenceSet

Возвращает строку скрытых состояний с заданным номером.

Specified by:

hidden in interface SequenceSet

Parameters:

index - индекс (с отсчетом от нуля) последовательности скрытых состояний в этом наборе

Returns:

байтовый массив, каждый элемент которого представляет отдельное скрытое состояние

id

public String id(int index)

Description copied from interface: SequenceSet

Возвращает идентификатор для наблюдаемой строки с заданным номером. Смысл идентификатора зависит от задачи; для задач биоинформатики существуют универсальные идентификаторы генов и белков.

Specified by:

id in interface SequenceSet

Parameters:

index - индекс (с отсчетом от нуля) последовательности наблюдаемых состояний в этом наборе

Returns:

строковый идентификатор последовательности; идентификатор может быть равен null

get

public Sequence get(int index)

Description copied from interface: SequenceSet

Возвращает из выборки прецедент с заданным номером.

Specified by:

get in interface SequenceSet

Parameters:

index - номер прецедента (с отсчетом от нуля)

Returns:

прецедент из выборки

observedStates

public String observedStates()

Description copied from interface: SequenceSet

Возвращает алфавит наблюдаемых состояний.

Specified by:

observedStates in interface SequenceSet

Returns:

строка, каждый символ которой уникален и обозначает одно из наблюдаемых состояний

hiddenStates

public String hiddenStates()

Description copied from interface: SequenceSet

Возвращает алфавит скрытых состояний.

Specified by:

hiddenStates in interface SequenceSet

Returns:

строка, каждый символ которой уникален и обозначает одно из скрытых состояний

completeStates

public String completeStates()

Description copied from interface: SequenceSet

Возвращает алфавит полных состояний. Если алфавит полных состяний не определен, вовращает null. Вначале перечисляются все состояния, скрытая часть которых равна первому скрытому состоянию, возвращаемому SequenceSet.hiddenStates(); порядок перечисления определяется наблюдаемой частью состояний и совпадает с их порядком в алфавите SequenceSet.observedStates(). Затем перечисляются все полные состояния со скрытой частью, равной

 this.hiddenStates().charAt(1)
 

и так далее.

Specified by:

completeStates in interface SequenceSet

Returns:

строка, каждый символ которой уникален и обозначает одно из полных состояний; null, если алфавит полных состояний не определен

join

public SequenceSet join(SequenceSet other,
               SequenceSet... more)

Description copied from interface: SequenceSet

Создает выборку путем слияния нескольких выборок. Последовательность строк в полученной выборке соответствует порядку перечисления аргументов метода: сначала идут строки из текущей выборки, затем - из other и т.д.

Specified by:

join in interface SequenceSet

Parameters:

other - множество, которое добавляется к выборке

more - дополнительные множества

filter

public SequenceSet filter(boolean[] selector)

Description copied from interface: SequenceSet

Фильтрует набор последовательностей в соответствии с заданным индикатором вхождения. Наблюдаемые и скрытые строки в отфильтрованном наборе располагаются в том же порядке, в каком они находились в исходном наборе.

Specified by:

filter in interface SequenceSet

Parameters:

selector - массив булевых величин, определяющий для каждой пары наблюдаемой и соответствущей скрытой строк в исходном наборе, будут ли они входить в отфильтрованный набор. Длина массива не должна быть меньше размера исходного набора.

Returns:

отфильтрованный набор последовательностей

filter

public SequenceSet filter(SequenceSet.Filter filter)

Description copied from interface: SequenceSet

Фильтрует набор последовательностей в соответствии с заданным фильтром. Наблюдаемые и скрытые строки в отфильтрованном наборе располагаются в том же порядке, в каком они находились в исходном наборе.

Specified by:

filter in interface SequenceSet

Parameters:

filter - фильтр, определяющий вхождение пар наблюдаемых и скрытых строк из исходного набора в новый набор

Returns:

отфильтрованный набор последовательностей

saveToFile

public void saveToFile(String fileName)
                throws IOException

Description copied from interface: SequenceSet

Сохраняет набор последовательностей в файл.

Specified by:

saveToFile in interface SequenceSet

Parameters:

fileName - имя файла, в который производится сохранение

Throws:

IOException - если в процессе сохранения проихошла ошибка ввода/вывода

doAdd

protected boolean doAdd(Sequence sequence)

Добавляет в коллекцию пару из наблюдаемой и соответстующей скрытой последовательности состояний.

Parameters:

sequence - добавляемый объект

addSet

protected void addSet(SequenceSet set)

Добавляет все строки из другой выборки в эту выборку.

Parameters:

set - коллекция последовательностей, которые надо добавить в эту выборку

repr

public String repr()

Возвращает более или менее детализированное текстовое представление объекта. В отличие от метода Object.toString(), подразумевается, что представление занимает одну или более полных строк.

В представление входит имя выборки (если есть), количество строк и алфавиты наблюдаемых и скрытых состояний.

Specified by:

repr in interface Representable

Returns:

текстовое представление объекта

toString

public String toString()

Overrides:

toString in class AbstractCollection<Sequence>

iterator

public Iterator<Sequence> iterator()

Specified by:

iterator in interface Iterable<Sequence>

Specified by:

iterator in interface Collection<Sequence>

Specified by:

iterator in class AbstractCollection<Sequence>

contains

public boolean contains(Object obj)

Specified by:

contains in interface Collection<Sequence>

Overrides:

contains in class AbstractCollection<Sequence>

clear

public void clear()

Specified by:

clear in interface Collection<Sequence>

Overrides:

clear in class AbstractCollection<Sequence>

add

public boolean add(Sequence sequence)

Добавляет в коллекцию пару из наблюдаемой и соответстующей скрытой последовательности состояний.

Specified by:

add in interface Collection<Sequence>

Overrides:

add in class AbstractCollection<Sequence>

Parameters:

sequence - добавляемый объект

remove

public Sequence remove(int index)

Удаляет из коллекции прецедент с заданным индексом.

Parameters:

index - индекс прецедента, который надо удалить

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<Sequence>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<Sequence>

Overrides:

hashCode in class Object