Package org.forester.io.parsers.nhx

Class NHXParser

java.lang.Object

org.forester.io.parsers.nhx.NHXParser

All Implemented Interfaces:

IteratingPhylogenyParser, PhylogenyParser

public final class NHXParser
extends java.lang.Object
implements PhylogenyParser, IteratingPhylogenyParser

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NHXParser.TAXONOMY_EXTRACTION

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.regex.Pattern	MB_BL_PATTERN
static java.util.regex.Pattern	MB_PROB_PATTERN
static java.util.regex.Pattern	MB_PROB_SD_PATTERN
static java.util.regex.Pattern	NUMBERS_ONLY_PATTERN
static boolean	REPLACE_UNDERSCORES_DEFAULT

Constructor Summary

Constructors

Constructor	Description
NHXParser()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()
NHXParser.TAXONOMY_EXTRACTION	getTaxonomyExtraction()
boolean	hasNext()
Phylogeny	next()
Phylogeny[]	parse()
static Phylogeny[]	parse(java.lang.Object nhx_source)
static void	parseNHX(java.lang.String s, PhylogenyNode node_to_annotate, NHXParser.TAXONOMY_EXTRACTION taxonomy_extraction, boolean replace_underscores, boolean allow_errors_in_distance_to_parent, boolean replace_bell)
void	reset()
void	setAllowErrorsInDistanceToParent(boolean allow_errors_in_distance_to_parent)
void	setGuessRootedness(boolean guess_rootedness)
void	setIgnoreQuotes(boolean ignore_quotes)
void	setReplaceUnderscores(boolean replace_underscores)
void	setSource(java.lang.Object nhx_source)
void	setTaxonomyExtraction(NHXParser.TAXONOMY_EXTRACTION taxonomy_extraction)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MB_BL_PATTERN

public static final java.util.regex.Pattern MB_BL_PATTERN

MB_PROB_PATTERN

public static final java.util.regex.Pattern MB_PROB_PATTERN

MB_PROB_SD_PATTERN

public static final java.util.regex.Pattern MB_PROB_SD_PATTERN

NUMBERS_ONLY_PATTERN

public static final java.util.regex.Pattern NUMBERS_ONLY_PATTERN

REPLACE_UNDERSCORES_DEFAULT

public static final boolean REPLACE_UNDERSCORES_DEFAULT

See Also:

Constant Field Values

Constructor Detail

NHXParser

public NHXParser()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface PhylogenyParser

getTaxonomyExtraction

public final NHXParser.TAXONOMY_EXTRACTION getTaxonomyExtraction()

hasNext

public final boolean hasNext()

Specified by:

hasNext in interface IteratingPhylogenyParser

next

public final Phylogeny next()
                     throws NHXFormatException,
                            java.io.IOException

Specified by:

next in interface IteratingPhylogenyParser

Throws:

NHXFormatException

java.io.IOException

parse

public final Phylogeny[] parse()
                        throws java.io.IOException

Specified by:

parse in interface PhylogenyParser

Throws:

java.io.IOException

reset

public final void reset()
                 throws NHXFormatException,
                        java.io.IOException

Specified by:

reset in interface IteratingPhylogenyParser

Throws:

NHXFormatException

java.io.IOException

setGuessRootedness

public final void setGuessRootedness(boolean guess_rootedness)

setIgnoreQuotes

public final void setIgnoreQuotes(boolean ignore_quotes)

setReplaceUnderscores

public final void setReplaceUnderscores(boolean replace_underscores)

setSource

public final void setSource(java.lang.Object nhx_source)
                     throws NHXFormatException,
                            java.io.IOException

Specified by:

setSource in interface IteratingPhylogenyParser

Specified by:

setSource in interface PhylogenyParser

Throws:

NHXFormatException

java.io.IOException

setTaxonomyExtraction

public final void setTaxonomyExtraction(NHXParser.TAXONOMY_EXTRACTION taxonomy_extraction)

setAllowErrorsInDistanceToParent

public final void setAllowErrorsInDistanceToParent(boolean allow_errors_in_distance_to_parent)

parse

public static final Phylogeny[] parse(java.lang.Object nhx_source)
                               throws NHXFormatException,
                                      java.io.IOException

Throws:

NHXFormatException

java.io.IOException

parseNHX

public static final void parseNHX(java.lang.String s,
                                  PhylogenyNode node_to_annotate,
                                  NHXParser.TAXONOMY_EXTRACTION taxonomy_extraction,
                                  boolean replace_underscores,
                                  boolean allow_errors_in_distance_to_parent,
                                  boolean replace_bell)
                           throws NHXFormatException,
                                  PhyloXmlDataFormatException

Throws:

NHXFormatException

PhyloXmlDataFormatException