A C D E F G H I K L M N O P R S T U V W

A

addAdditionalName(String, String, String, LinnaeanRankClassification) - Method in class au.org.ala.names.search.ALANameIndexer
 
affPattern - Static variable in class au.org.ala.names.search.ALANameSearcher
 
ALANameIndexer - Class in au.org.ala.names.search
Creates the Lucene index based on the names that are exported from http://code.google.com/p/ala-portal/source/browse/trunk/ala-names-generator/src/main/resources/create-dumps.sql
ALANameIndexer() - Constructor for class au.org.ala.names.search.ALANameIndexer
 
ALANameIndexer.IndexField - Enum in au.org.ala.names.search
 
ALANameSearcher - Class in au.org.ala.names.search
The API used to perform a search on the ALA Name Matching Lucene Index.
ALANameSearcher() - Constructor for class au.org.ala.names.search.ALANameSearcher
 
ALANameSearcher(String) - Constructor for class au.org.ala.names.search.ALANameSearcher
Creates a new name searcher.
ALAParsedName<T> - Class in au.org.ala.names.model
Stores the extra information for an ALA Parsed Phrase name.
ALAParsedName() - Constructor for class au.org.ala.names.model.ALAParsedName
 
ALAParsedName(ParsedName<T>) - Constructor for class au.org.ala.names.model.ALAParsedName
 
au.org.ala.names.lucene.analyzer - package au.org.ala.names.lucene.analyzer
 
au.org.ala.names.model - package au.org.ala.names.model
 
au.org.ala.names.parser - package au.org.ala.names.parser
 
au.org.ala.names.search - package au.org.ala.names.search
 
au.org.ala.names.util - package au.org.ala.names.util
 
authorship - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 

C

cfPattern - Static variable in class au.org.ala.names.search.ALANameSearcher
 
cid - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
cleanPhrase - Variable in class au.org.ala.names.model.ALAParsedName
 
cleanVoucher - Variable in class au.org.ala.names.model.ALAParsedName
 
commit() - Method in class au.org.ala.names.search.ALANameIndexer
 
commit(boolean, boolean) - Method in class au.org.ala.names.search.ALANameIndexer
 
create(boolean, boolean, String, String, String, String, String) - Method in class au.org.ala.names.search.DwcaNameIndexer
Creates the name matching index based on a complete list of names supplied in a single DwCA
createALAIndexDocument(String, String, String, String, LinnaeanRankClassification) - Method in class au.org.ala.names.search.ALANameIndexer
 
createALAIndexDocument(String, String, String, String, String, String, String, String, LinnaeanRankClassification) - Method in class au.org.ala.names.search.ALANameIndexer
 
createALASynonymDocument(String, String, String, String, String, String, String, float, String) - Method in class au.org.ala.names.search.ALANameIndexer
 
createComponents(String, Reader) - Method in class au.org.ala.names.lucene.analyzer.LowerCaseKeywordAnalyzer
 
createIndex(String, String, boolean, boolean) - Method in class au.org.ala.names.search.ALANameIndexer
Creates the index from the specified checklist bank names usage export file into the specified index directory.
createIndex(String, String, String, String, String, boolean, boolean) - Method in class au.org.ala.names.search.ALANameIndexer
 
createIndexWriter(File, Analyzer, boolean) - Method in class au.org.ala.names.search.ALANameIndexer
Creates an index writer in the specified directory.
createIrmngIndex(String, String) - Method in class au.org.ala.names.search.ALANameIndexer
Creates the IRMNG homonym index based on the DWCA and species homonyms supplied from the NSL

D

deleteName(String) - Method in class au.org.ala.names.search.ALANameIndexer
Deletes the entry that has the supplied lsid.
dumpSpecies() - Method in class au.org.ala.names.search.ALANameSearcher
Dumps a list of the species LSID's that are contained in the index.
DwcaNameIndexer - Class in au.org.ala.names.search
Create a name index from a DWCA.
DwcaNameIndexer() - Constructor for class au.org.ala.names.search.DwcaNameIndexer
 

E

equals(Object) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
ErrorType - Enum in au.org.ala.names.model
When an error occurs during a recursive search the search does NOT stop.
errorType - Variable in exception au.org.ala.names.search.SearchResultException
 
ExcludedNameException - Exception in au.org.ala.names.search
An exception that is thrown when the match is to a name that has been excluded.
ExcludedNameException(String, NameSearchResult) - Constructor for exception au.org.ala.names.search.ExcludedNameException
 
ExcludedNameException(String, NameSearchResult, NameSearchResult) - Constructor for exception au.org.ala.names.search.ExcludedNameException
Constructs an ExcludedNameException that represents that we have a match that is excluded and one that is not.

F

family - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
fid - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
FileUtils - Class in au.org.ala.names.util
Some Generic file utilities.
FileUtils() - Constructor for class au.org.ala.names.util.FileUtils
 

G

genus - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
getAcceptedLsid() - Method in class au.org.ala.names.model.NameSearchResult
 
getAllRanksBelow(Integer) - Static method in enum au.org.ala.names.model.RankType
 
getAuthorship() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getBoost() - Method in enum au.org.ala.names.model.RankType
 
getChildResult() - Method in exception au.org.ala.names.search.ParentSynonymChildException
 
getCid() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getCleanName() - Method in class au.org.ala.names.model.NameSearchResult
Deprecated. 
getCommonNameDocument(String, String, String, float) - Method in class au.org.ala.names.search.ALANameIndexer
 
getCommonNameDocument(String, String, String, float, boolean) - Method in class au.org.ala.names.search.ALANameIndexer
 
getErrors() - Method in class au.org.ala.names.model.MetricsResultDTO
 
getErrorType() - Method in exception au.org.ala.names.search.SearchResultException
 
getExcludedName() - Method in exception au.org.ala.names.search.ExcludedNameException
 
getFamily() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getFid() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getForCBRank(Rank) - Static method in enum au.org.ala.names.model.RankType
 
getForId(Integer) - Static method in enum au.org.ala.names.model.RankType
 
getForName(String) - Static method in enum au.org.ala.names.model.RankType
 
getForStrRank(String) - Static method in enum au.org.ala.names.model.RankType
Gets the Rank Type for the supplied raw string...
getGenus() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getGid() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getId() - Method in class au.org.ala.names.model.NameSearchResult
 
getId() - Method in enum au.org.ala.names.model.RankType
 
getId() - Method in enum au.org.ala.names.model.SynonymType
 
getIndexDirectory() - Method in class au.org.ala.names.search.ALANameIndexer
 
getInfraspecificEpithet() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getIRMNGGenus(LinnaeanRankClassification, RankType) - Method in class au.org.ala.names.search.ALANameSearcher
Multiple genus indicate that an unresolved homonym exists for the supplied search details.
getKid() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getKingdom() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getKingdom() - Method in class au.org.ala.names.model.NameSearchResult
Deprecated. Use the kingdom from the "getRankClassification"
getKlass() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getLastException() - Method in class au.org.ala.names.model.MetricsResultDTO
 
getLeft() - Method in class au.org.ala.names.model.NameSearchResult
 
getLineIterator(InputStream, String) - Static method in class au.org.ala.names.util.FileUtils
 
getLocationPhraseDesciption() - Method in class au.org.ala.names.model.ALAParsedName
Deprecated. typo with the getter. Use correct spelling.
getLocationPhraseDescription() - Method in class au.org.ala.names.model.ALAParsedName
 
getLsid() - Method in class au.org.ala.names.model.NameSearchResult
Return the LSID for the result if it is not null otherwise return the id.
getLuceneSearchString(boolean) - Method in class au.org.ala.names.model.LinnaeanRankClassification
Returns the additional string that needs to be included in a search
getMatchedResult() - Method in exception au.org.ala.names.search.MisappliedException
 
getMatchType(String) - Method in enum au.org.ala.names.model.MatchType
 
getMatchType() - Method in class au.org.ala.names.model.NameSearchResult
 
getMisappliedResult() - Method in exception au.org.ala.names.search.MisappliedException
 
getNameType() - Method in class au.org.ala.names.model.MetricsResultDTO
 
getNonExcludedName() - Method in exception au.org.ala.names.search.ExcludedNameException
 
getOid() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getOrder() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getParentResult() - Method in exception au.org.ala.names.search.ParentSynonymChildException
 
getPhraseNominatingParty() - Method in class au.org.ala.names.model.ALAParsedName
 
getPhraseVoucher() - Method in class au.org.ala.names.model.ALAParsedName
 
getPhylum() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getPid() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getPrimaryLsid(String) - Method in class au.org.ala.names.search.ALANameSearcher
Returns the primary LSID for the supplied lsid.
getRank() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getRank() - Method in class au.org.ala.names.model.NameSearchResult
 
getRank() - Method in enum au.org.ala.names.model.RankType
 
getRankClassification() - Method in class au.org.ala.names.model.NameSearchResult
 
getResult() - Method in class au.org.ala.names.model.MetricsResultDTO
 
getResults() - Method in exception au.org.ala.names.search.SearchResultException
 
getRight() - Method in class au.org.ala.names.model.NameSearchResult
 
getScientificName() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getSid() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getSpecies() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getSpecificEpithet() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getSubspecies() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
getSynonymLsid() - Method in class au.org.ala.names.model.NameSearchResult
Deprecated. Use NameSearchResult.getAcceptedLsid() instead
getSynonymType() - Method in class au.org.ala.names.model.NameSearchResult
 
getTypeFor(String) - Static method in enum au.org.ala.names.model.SynonymType
 
gid - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 

H

hasBeenCleaned() - Method in class au.org.ala.names.model.NameSearchResult
Deprecated. 
hashCode() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
hasIdenticalClassification(LinnaeanRankClassification, RankType) - Method in class au.org.ala.names.model.LinnaeanRankClassification
checks to see if the non-null values of this classification are identical to the supplied classification

This is used to determine whether classification match.

HomonymException - Exception in au.org.ala.names.search
Exception that is thrown when the result is an unresolved homonym
HomonymException(String, List<NameSearchResult>) - Constructor for exception au.org.ala.names.search.HomonymException
 
HomonymException(String) - Constructor for exception au.org.ala.names.search.HomonymException
 
HomonymException() - Constructor for exception au.org.ala.names.search.HomonymException
 
HomonymException(List<NameSearchResult>) - Constructor for exception au.org.ala.names.search.HomonymException
 

I

IGNORE_MARKERS - Static variable in class au.org.ala.names.parser.PhraseNameParser
 
indexIrmngDwcA(IndexWriter, String) - Method in class au.org.ala.names.search.ALANameIndexer
Indexes the IRMNG homonyms from the supplied DWCA direcory
infraspecificEpithet - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
init() - Method in class au.org.ala.names.search.ALANameIndexer
 
initialOnePattern - Static variable in class au.org.ala.names.model.ALAParsedName
 
initialTwoPattern - Static variable in class au.org.ala.names.model.ALAParsedName
 
isHomonym() - Method in class au.org.ala.names.model.NameSearchResult
 
isSynonym() - Method in class au.org.ala.names.model.NameSearchResult
 

K

kid - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
kingdom - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
klass - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 

L

LinnaeanRankClassification - Class in au.org.ala.names.model
A model object that represents a Linnaean Classification.
LinnaeanRankClassification() - Constructor for class au.org.ala.names.model.LinnaeanRankClassification
 
LinnaeanRankClassification(String, String, String, String, String, String, String, String, String, String, String) - Constructor for class au.org.ala.names.model.LinnaeanRankClassification
 
LinnaeanRankClassification(LinnaeanRankClassification) - Constructor for class au.org.ala.names.model.LinnaeanRankClassification
 
LinnaeanRankClassification(String, String, String, String, String, String, String) - Constructor for class au.org.ala.names.model.LinnaeanRankClassification
 
LinnaeanRankClassification(String, String) - Constructor for class au.org.ala.names.model.LinnaeanRankClassification
The constructor was added for convenience.
LOCATION_OR_DESCR - Static variable in class au.org.ala.names.parser.PhraseNameParser
 
locationPhraseDescription - Variable in class au.org.ala.names.model.ALAParsedName
 
log - Variable in class au.org.ala.names.search.ALANameSearcher
 
log - Static variable in class au.org.ala.names.search.DwcaNameIndexer
 
LowerCaseKeywordAnalyzer - Class in au.org.ala.names.lucene.analyzer
A custom KeywordAnalyzer that converts the text to lowercase before tokenizing the complete string as one token
LowerCaseKeywordAnalyzer() - Constructor for class au.org.ala.names.lucene.analyzer.LowerCaseKeywordAnalyzer
 
ltrim(String) - Static method in class au.org.ala.names.util.TaxonNameSoundEx
 

M

main(String[]) - Static method in class au.org.ala.names.model.ALAParsedName
 
main(String[]) - Static method in class au.org.ala.names.model.LinnaeanRankClassification
 
main(String[]) - Static method in class au.org.ala.names.search.ALANameIndexer
Generates the Lucene index required for the name matching API.
main(String[]) - Static method in class au.org.ala.names.search.DwcaNameIndexer
 
MatchType - Enum in au.org.ala.names.model
An enumeration that represents the type of match that has been performed.
MetricsResultDTO - Class in au.org.ala.names.model
Stores the data the data that makes up a name match includes metrics such as name types and errors

Allows a metrics to be returned even when a match is not found.

MetricsResultDTO() - Constructor for class au.org.ala.names.model.MetricsResultDTO
 
MisappliedException - Exception in au.org.ala.names.search
Indicates that the matched name has been misapplied in the past.
MisappliedException(NameSearchResult) - Constructor for exception au.org.ala.names.search.MisappliedException
Constructor to use of the first result is misapplied.
MisappliedException(NameSearchResult, NameSearchResult) - Constructor for exception au.org.ala.names.search.MisappliedException
Constructor to use if the first result is accepted and second result is a misapplied synonym
multipleSpaces - Static variable in class au.org.ala.names.model.ALAParsedName
 

N

NameIndexField - Enum in au.org.ala.names.model
An Enum for all the fields that are indexed for the name matching.
NameSearchResult - Class in au.org.ala.names.model
A model to store the required information in a search result This includes the type of match that was used to get the result
NameSearchResult(String, String, MatchType) - Constructor for class au.org.ala.names.model.NameSearchResult
 
NameSearchResult(Document, MatchType) - Constructor for class au.org.ala.names.model.NameSearchResult
 
normalize(String) - Static method in class au.org.ala.names.util.TaxonNameSoundEx
 

O

oid - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
order - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 

P

ParentSynonymChildException - Exception in au.org.ala.names.search
An exception that is thrown when the result represents a situation where the parent is a synonym of the child concept.
ParentSynonymChildException(NameSearchResult, NameSearchResult) - Constructor for exception au.org.ala.names.search.ParentSynonymChildException
 
parse(String) - Method in class au.org.ala.names.parser.PhraseNameParser
 
PHRASE - Static variable in class au.org.ala.names.parser.PhraseNameParser
 
PHRASE_PATTERN - Static variable in class au.org.ala.names.parser.PhraseNameParser
 
PHRASE_RANKS - Static variable in class au.org.ala.names.parser.PhraseNameParser
 
phraseBlacklist - Static variable in class au.org.ala.names.model.ALAParsedName
 
PhraseNameParser - Class in au.org.ala.names.parser
A Parser that can be used to parse a "Phrase" name.
PhraseNameParser() - Constructor for class au.org.ala.names.parser.PhraseNameParser
 
phraseNominatingParty - Variable in class au.org.ala.names.model.ALAParsedName
 
phrasePunctuationRemoval - Static variable in class au.org.ala.names.model.ALAParsedName
 
phraseVoucher - Variable in class au.org.ala.names.model.ALAParsedName
 
phylum - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
pid - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
POTENTIAL_SPECIES_PATTERN - Static variable in class au.org.ala.names.parser.PhraseNameParser
 
potentialVoucherId - Static variable in class au.org.ala.names.model.ALAParsedName
 

R

rank - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
RANK_MARKER - Static variable in class au.org.ala.names.parser.PhraseNameParser
 
RankType - Enum in au.org.ala.names.model
An enumeration of the rank types available in ALA, with some text vocabulary that can be used to match to a RankType.
reopenReaders() - Method in class au.org.ala.names.search.ALANameSearcher
 
resolveIRMNGHomonym(LinnaeanRankClassification, RankType) - Method in class au.org.ala.names.search.ALANameSearcher
Attempt to resolve the homonym using the IRMNG index.
results - Variable in exception au.org.ala.names.search.SearchResultException
 
rtrim(String) - Static method in class au.org.ala.names.util.TaxonNameSoundEx
 

S

scientificName - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
searchForAcceptedLsidDefaultHandling(LinnaeanRankClassification, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Returns the accepted LSID for the supplied classification.
searchForAcceptedLsidDefaultHandling(LinnaeanRankClassification, boolean, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
 
searchForAcceptedRecordDefaultHandling(LinnaeanRankClassification, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Returns the accepted result for the supplied classification.
searchForAcceptedRecordDefaultHandling(LinnaeanRankClassification, boolean, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
 
searchForCommonName(String) - Method in class au.org.ala.names.search.ALANameSearcher
Performs a search on the supplied common name returning a NameSearchResult.
searchForLSID(String, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Searches the index for the supplied name with or without fuzzy name matching.
searchForLSID(String, boolean, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Search for lsid with or without fuzzy matching.
searchForLSID(String) - Method in class au.org.ala.names.search.ALANameSearcher
Searches for the name without using fuzzy name matching...
searchForLSID(String, RankType, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Searches the index for the supplied name of the specified rank with or without fuzzy name matching.
searchForLSID(String, RankType, boolean, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Searches for the supplied name of the specified rank with or without fuzzy name matching.
searchForLSID(String, RankType) - Method in class au.org.ala.names.search.ALANameSearcher
Searches for an LSID of the supplied name and rank without a fuzzy match...
searchForLSID(String, String, String, RankType) - Method in class au.org.ala.names.search.ALANameSearcher
Deprecated. Use ALANameSearcher.searchForLSID(String, au.org.ala.names.model.LinnaeanRankClassification, au.org.ala.names.model.RankType) instead. It is more extensible to supply a classification object then a list of higher classification
searchForLSID(String, LinnaeanRankClassification, RankType, boolean, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Search for an LSID based on the supplied name, classification and rank with or without fuzzy name matching.
searchForLSID(LinnaeanRankClassification, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Search for an LSID with the supplied classification without a fuzzy match.
searchForLSID(String, LinnaeanRankClassification, RankType) - Method in class au.org.ala.names.search.ALANameSearcher
Search for an LSID based on suppled name, classification and rank without a fuzzy match...
searchForLsidById(String) - Method in class au.org.ala.names.search.ALANameSearcher
Gets the LSID for the record that has the supplied checklist bank id.
searchForLSIDCommonName(String) - Method in class au.org.ala.names.search.ALANameSearcher
Performs a search on the common name index for the supplied name.
searchForRecord(LinnaeanRankClassification, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Search for a result - optionally allowing for a recursive search
searchForRecord(LinnaeanRankClassification, boolean, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Search for a result - optionally allowing for a recursive search and fuzzy matching
searchForRecord(LinnaeanRankClassification, boolean, boolean, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Search for an LSID with the supplied classification without a fuzzy match.
searchForRecord(String, RankType, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Searches the index for the supplied name of the specified rank.
searchForRecord(String, RankType) - Method in class au.org.ala.names.search.ALANameSearcher
Searches index for the supplied name and rank without a fuzzy match.
searchForRecord(String, String, String, RankType) - Method in class au.org.ala.names.search.ALANameSearcher
Deprecated. Use ALANameSearcher.searchForRecord(java.lang.String, au.org.ala.names.model.LinnaeanRankClassification, au.org.ala.names.model.RankType, boolean) instead. It is more extensible to supply a classification object then a list of higher classification
searchForRecord(String, LinnaeanRankClassification, RankType, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
 
searchForRecord(String, LinnaeanRankClassification, RankType, boolean, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Searches for a record based on the supplied name, rank and classification with or without fuzzy name matching.
searchForRecord(String, LinnaeanRankClassification, RankType) - Method in class au.org.ala.names.search.ALANameSearcher
Searches for a record based on the supplied name, classification and rank without fuzzy name matching
searchForRecordByID(String) - Method in class au.org.ala.names.search.ALANameSearcher
Returns the records that has the supplied checklist bank id
searchForRecordByLsid(String) - Method in class au.org.ala.names.search.ALANameSearcher
 
searchForRecordMetrics(LinnaeanRankClassification, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Searches for a result returning a metrics of the result.
searchForRecordMetrics(LinnaeanRankClassification, boolean, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Searches for a result returning a metrics of the result.
searchForRecordMetrics(LinnaeanRankClassification, boolean, boolean, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Search for a specific name returning extra metrics that can be reported as name match quality...
searchForRecordMetrics(LinnaeanRankClassification, boolean, boolean, boolean, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Searches for a result returning a metrics of the result.
searchForRecords(String, RankType, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Searches for records with the specified name and rank with or without fuzzy name matching
searchForRecords(String, RankType, LinnaeanRankClassification, int) - Method in class au.org.ala.names.search.ALANameSearcher
Searches for a list of results for the supplied name, classification and rank without fuzzy match
searchForRecords(String, RankType, LinnaeanRankClassification, int, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
Searches for the records that satisfy the given conditions using the algorithm outlined in the class description.
searchForRecords(String, RankType, LinnaeanRankClassification, int, boolean, boolean) - Method in class au.org.ala.names.search.ALANameSearcher
 
SearchResultException - Exception in au.org.ala.names.search
The generic search result exception that can be thrown during a search.
SearchResultException(String) - Constructor for exception au.org.ala.names.search.SearchResultException
 
SearchResultException(String, List<NameSearchResult>) - Constructor for exception au.org.ala.names.search.SearchResultException
 
setAuthorship(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setCid(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setCleanName(String) - Method in class au.org.ala.names.model.NameSearchResult
Deprecated. 
setErrors(Set<ErrorType>) - Method in class au.org.ala.names.model.MetricsResultDTO
 
setExcludedName(NameSearchResult) - Method in exception au.org.ala.names.search.ExcludedNameException
 
setFamily(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setFid(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setGenus(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setGid(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setIndexDirectory(String) - Method in class au.org.ala.names.search.ALANameIndexer
 
setInfraspecificEpithet(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setKid(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setKingdom(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setKlass(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setLastException(SearchResultException) - Method in class au.org.ala.names.model.MetricsResultDTO
 
setLeft(String) - Method in class au.org.ala.names.model.NameSearchResult
 
setLocationPhraseDescription(String) - Method in class au.org.ala.names.model.ALAParsedName
 
setMatchedResult(NameSearchResult) - Method in exception au.org.ala.names.search.MisappliedException
 
setMatchType(MatchType) - Method in class au.org.ala.names.model.NameSearchResult
Set the match type that was used to get this result
setMisappliedResult(NameSearchResult) - Method in exception au.org.ala.names.search.MisappliedException
 
setNameType(NameType) - Method in class au.org.ala.names.model.MetricsResultDTO
 
setNonExcludedName(NameSearchResult) - Method in exception au.org.ala.names.search.ExcludedNameException
 
setOid(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setOrder(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setPhraseNominatingParty(String) - Method in class au.org.ala.names.model.ALAParsedName
 
setPhraseVoucher(String) - Method in class au.org.ala.names.model.ALAParsedName
 
setPhylum(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setPid(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setRank(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setRank(RankType) - Method in class au.org.ala.names.model.NameSearchResult
 
setResult(NameSearchResult) - Method in class au.org.ala.names.model.MetricsResultDTO
 
setResults(List<NameSearchResult>) - Method in exception au.org.ala.names.search.HomonymException
 
setRight(String) - Method in class au.org.ala.names.model.NameSearchResult
 
setScientificName(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setSid(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setSpecies(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setSpecificEpithet(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
setSubspecies(String) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
sid - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
soundEx(String) - Method in class au.org.ala.names.util.TaxonNameSoundEx
Returns the SoundEx for the source string
SOURCE_AUTHORITY - Static variable in class au.org.ala.names.parser.PhraseNameParser
 
species - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
SPECIES_PATTERN - Static variable in class au.org.ala.names.parser.PhraseNameParser
 
specificEpithet - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
SPPException - Exception in au.org.ala.names.search
The exception to be thrown when a Genus spp.
SPPException() - Constructor for exception au.org.ala.names.search.SPPException
 
streamToSet(InputStream, Set<String>, boolean) - Static method in class au.org.ala.names.util.FileUtils
 
subspecies - Variable in class au.org.ala.names.model.LinnaeanRankClassification
 
SynonymType - Enum in au.org.ala.names.model
Stores the Synonym type information.

T

TaxonNameSoundEx - Class in au.org.ala.names.util
A Java implementation of the sound ex algorithm supplied by Tony Rees Copied from Taxamatch project.
TaxonNameSoundEx() - Constructor for class au.org.ala.names.util.TaxonNameSoundEx
 
tnse - Variable in class au.org.ala.names.search.ALANameSearcher
 
toCSV(char) - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
toString() - Method in enum au.org.ala.names.model.ErrorType
 
toString() - Method in class au.org.ala.names.model.LinnaeanRankClassification
 
toString() - Method in enum au.org.ala.names.model.MatchType
 
toString() - Method in enum au.org.ala.names.model.NameIndexField
 
toString() - Method in class au.org.ala.names.model.NameSearchResult
 
toString() - Method in enum au.org.ala.names.search.ALANameIndexer.IndexField
 
treatWord(String, String) - Static method in class au.org.ala.names.util.TaxonNameSoundEx
 

U

updateClassificationWithGUID(LinnaeanRankClassification) - Method in class au.org.ala.names.search.ALANameSearcher
Updates the supplied classification so that the supplied ID's are substituted with GUIDs.

V

VALID_PHRASE_RANKS - Static variable in class au.org.ala.names.parser.PhraseNameParser
 
validateHomonymByAuthor(List<NameSearchResult>, String, LinnaeanRankClassification) - Method in class au.org.ala.names.search.ALANameSearcher
 
validateHomonyms(List<NameSearchResult>, String, LinnaeanRankClassification) - Method in class au.org.ala.names.search.ALANameSearcher
Takes a result set that contains a homonym and then either throws a HomonymException or returns the first result that matches the supplied taxa.
valueOf(String) - Static method in enum au.org.ala.names.model.ErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum au.org.ala.names.model.MatchType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum au.org.ala.names.model.NameIndexField
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum au.org.ala.names.model.RankType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum au.org.ala.names.model.SynonymType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum au.org.ala.names.search.ALANameIndexer.IndexField
Returns the enum constant of this type with the specified name.
values() - Static method in enum au.org.ala.names.model.ErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum au.org.ala.names.model.MatchType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum au.org.ala.names.model.NameIndexField
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum au.org.ala.names.model.RankType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum au.org.ala.names.model.SynonymType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum au.org.ala.names.search.ALANameIndexer.IndexField
Returns an array containing the constants of this enum type, in the order they are declared.
virusStopPattern - Static variable in class au.org.ala.names.search.ALANameSearcher
 
VOUCHER - Static variable in class au.org.ala.names.parser.PhraseNameParser
 
voucherBlacklist - Static variable in class au.org.ala.names.model.ALAParsedName
 
voucherRemovePattern - Static variable in class au.org.ala.names.model.ALAParsedName
 
voucherRemovePattern - Static variable in class au.org.ala.names.search.ALANameSearcher
 

W

WRONG_CASE_INFRAGENERIC - Static variable in class au.org.ala.names.parser.PhraseNameParser
 

A C D E F G H I K L M N O P R S T U V W

Copyright © 2014. All Rights Reserved.