|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.biojava.bio.seq.io.EmblLikeFormat
Format processor for handling EMBL records and similar files. This takes a very simple approach: all `normal' attribute lines are passed to the listener as a tag (first two characters) and a value (the rest of the line from the 6th character onwards). Any data between the special `SQ' line and the "//" entry terminator is passed as a SymbolReader.
This low-level format processor should normally be used in conjunction with one or more `filter' objects, such as EmblProcessor.
Many ideas borrowed from the old EmblFormat processor by Thomas Down and Thad Welch.
Field Summary | |
protected static java.lang.String |
ACCESSION_TAG
|
protected static java.lang.String |
AUTHORS_TAG
|
protected static java.lang.String |
CIRCULAR_TAG
|
protected static java.lang.String |
COMMENT_TAG
|
protected static java.lang.String |
COORDINATE_TAG
|
protected static java.lang.String |
DATE_TAG
|
static java.lang.String |
DEFAULT
|
protected static java.lang.String |
DEFINITION_TAG
|
protected static java.lang.String |
DIVISION_TAG
|
protected static java.lang.String |
END_SEQUENCE_TAG
|
protected static java.lang.String |
FEATURE_TABLE_TAG
|
protected static java.lang.String |
FEATURE_TAG
|
protected static java.lang.String |
ID_TAG
|
protected static java.lang.String |
JOURNAL_TAG
|
protected static java.lang.String |
KEYWORDS_TAG
|
protected static java.lang.String |
ORGANISM_TAG
|
protected static java.lang.String |
REF_ACCESSION_TAG
|
protected static java.lang.String |
REFERENCE_TAG
|
protected static java.lang.String |
SEPARATOR_TAG
|
protected static java.lang.String |
SIZE_TAG
|
protected static java.lang.String |
SOURCE_TAG
|
protected static java.lang.String |
START_SEQUENCE_TAG
|
protected static java.lang.String |
STRAND_NUMBER_TAG
|
protected static java.lang.String |
TITLE_TAG
|
protected static java.lang.String |
TYPE_TAG
|
protected static java.lang.String |
VERSION_TAG
|
Constructor Summary | |
EmblLikeFormat()
|
Method Summary | |
void |
addParseErrorListener(ParseErrorListener theListener)
Adds a parse error listener to the list of listeners if it isn't already included. |
void |
BadLineParsed(ParseErrorEvent theEvent)
This method determines the behaviour when a bad line is processed. |
java.lang.String |
getDefaultFormat()
Deprecated. |
boolean |
getElideSymbols()
Return a flag indicating if symbol data will be skipped when parsing streams. |
protected void |
notifyParseErrorEvent(ParseErrorEvent theEvent)
Passes the event on to all the listeners registered for ParseErrorEvents. |
protected void |
processSequenceLine(java.lang.String line,
StreamParser parser)
Dispatch symbol data from SQ-block line of an EMBL-like file. |
boolean |
readSequence(java.io.BufferedReader reader,
SymbolTokenization symParser,
SeqIOListener listener)
Read a sequence and pass data on to a SeqIOListener. |
void |
removeParseErrorListener(ParseErrorListener theListener)
Removes a parse error listener from the list of listeners if it is included. |
void |
setElideSymbols(boolean b)
Specifies whether the symbols (SQ) part of the entry should be ignored. |
void |
writeSequence(Sequence seq,
java.io.PrintStream os)
writeSequence writes a sequence to the specified
PrintStream, using the default format. |
void |
writeSequence(Sequence seq,
java.lang.String format,
java.io.PrintStream os)
Deprecated. use writeSequence(Sequence seq, PrintStream os) |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String DEFAULT
protected static final java.lang.String ID_TAG
protected static final java.lang.String SIZE_TAG
protected static final java.lang.String STRAND_NUMBER_TAG
protected static final java.lang.String TYPE_TAG
protected static final java.lang.String CIRCULAR_TAG
protected static final java.lang.String DIVISION_TAG
protected static final java.lang.String ACCESSION_TAG
protected static final java.lang.String VERSION_TAG
protected static final java.lang.String DATE_TAG
protected static final java.lang.String DEFINITION_TAG
protected static final java.lang.String KEYWORDS_TAG
protected static final java.lang.String SOURCE_TAG
protected static final java.lang.String ORGANISM_TAG
protected static final java.lang.String REFERENCE_TAG
protected static final java.lang.String COORDINATE_TAG
protected static final java.lang.String REF_ACCESSION_TAG
protected static final java.lang.String AUTHORS_TAG
protected static final java.lang.String TITLE_TAG
protected static final java.lang.String JOURNAL_TAG
protected static final java.lang.String COMMENT_TAG
protected static final java.lang.String FEATURE_TAG
protected static final java.lang.String SEPARATOR_TAG
protected static final java.lang.String FEATURE_TABLE_TAG
protected static final java.lang.String START_SEQUENCE_TAG
protected static final java.lang.String END_SEQUENCE_TAG
Constructor Detail |
public EmblLikeFormat()
Method Detail |
public void setElideSymbols(boolean b)
Specifies whether the symbols (SQ) part of the entry should
be ignored. If this property is set to true
, the
parser will never call addSymbols on the
SeqIOListener
, but parsing will be faster if
you're only interested in header information.
This property also allows the header to be parsed for files which have invalid sequence data.
public boolean getElideSymbols()
public boolean readSequence(java.io.BufferedReader reader, SymbolTokenization symParser, SeqIOListener listener) throws IllegalSymbolException, java.io.IOException, ParseException
SequenceFormat
readSequence
in interface SequenceFormat
reader
- The stream of data to parse.symParser
- A SymbolParser defining a mapping from
character data to Symbols.listener
- A listener to notify when data is extracted
from the stream.
IllegalSymbolException
- if it is not possible to
translate character data from the stream into valid BioJava
symbols.
java.io.IOException
- if an error occurs while reading from the
stream.
ParseException
protected void processSequenceLine(java.lang.String line, StreamParser parser) throws IllegalSymbolException, ParseException
IllegalSymbolException
ParseException
public void writeSequence(Sequence seq, java.io.PrintStream os) throws java.io.IOException
SequenceFormat
writeSequence
writes a sequence to the specified
PrintStream, using the default format.
writeSequence
in interface SequenceFormat
seq
- the sequence to write out.os
- the printstream to write to.
java.io.IOException
public void writeSequence(Sequence seq, java.lang.String format, java.io.PrintStream os) throws java.io.IOException
writeSequence
writes a sequence to the specified
PrintStream
, using the specified format.
writeSequence
in interface SequenceFormat
seq
- a Sequence
to write out.format
- a String
indicating which sub-format
of those available from a particular
SequenceFormat
implemention to use when
writing.os
- a PrintStream
object.
java.io.IOException
- if an error occurs.public java.lang.String getDefaultFormat()
getDefaultFormat
returns the String identifier for
the default format written by a SequenceFormat
implementation.
getDefaultFormat
in interface SequenceFormat
String
.public void BadLineParsed(ParseErrorEvent theEvent)
This method determines the behaviour when a bad line is processed. Some options are to log the error, throw an exception, ignore it completely, or pass the event through.
This method should be overwritten when different behavior is desired.
BadLineParsed
in interface ParseErrorListener
theEvent
- The event that contains the bad line and token.public void addParseErrorListener(ParseErrorListener theListener)
addParseErrorListener
in interface ParseErrorSource
theListener
- Listener to be added.public void removeParseErrorListener(ParseErrorListener theListener)
removeParseErrorListener
in interface ParseErrorSource
theListener
- Listener to be removed.protected void notifyParseErrorEvent(ParseErrorEvent theEvent)
theEvent
- The event to be handed to the listeners.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |