au.org.ala.names.model
Class NameSearchResult

java.lang.Object
  au.org.ala.names.model.NameSearchResult

public class NameSearchResult
extends java.lang.Object

A model to store the required information in a search result This includes the type of match that was used to get the result

Author:

Natasha

Constructor Summary

NameSearchResult(org.apache.lucene.document.Document doc, MatchType type)

NameSearchResult(java.lang.String id, java.lang.String lsid, MatchType type)

Method Summary

java.lang.String	getAcceptedLsid()
java.lang.String	getCleanName() Deprecated.
java.lang.String	getId()
java.lang.String	getKingdom() Deprecated. Use the kingdom from the "getRankClassification"
java.lang.String	getLeft()
java.lang.String	getLsid() Return the LSID for the result if it is not null otherwise return the id.
MatchType	getMatchType()
RankType	getRank()
LinnaeanRankClassification	getRankClassification()
java.lang.String	getRight()
java.lang.String	getSynonymLsid() Deprecated. Use getAcceptedLsid() instead
SynonymType	getSynonymType()
boolean	hasBeenCleaned() Deprecated.
boolean	isHomonym()
boolean	isSynonym()
void	setCleanName(java.lang.String name) Deprecated.
void	setLeft(java.lang.String left)
void	setMatchType(MatchType type) Set the match type that was used to get this result
void	setRank(RankType rank)
void	setRight(java.lang.String right)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NameSearchResult

public NameSearchResult(java.lang.String id,
                        java.lang.String lsid,
                        MatchType type)

NameSearchResult

public NameSearchResult(org.apache.lucene.document.Document doc,
                        MatchType type)

Method Detail

getSynonymType

public SynonymType getSynonymType()

getRankClassification

public LinnaeanRankClassification getRankClassification()

Returns:

The classification for the match

getKingdom

@Deprecated
public java.lang.String getKingdom()

Deprecated. Use the kingdom from the "getRankClassification"

Returns:

getLsid

public java.lang.String getLsid()

Return the LSID for the result if it is not null otherwise return the id.

Returns:

getId

public java.lang.String getId()

getMatchType

public MatchType getMatchType()

Returns:

The match type used to get this result

setMatchType

public void setMatchType(MatchType type)

Set the match type that was used to get this result

Parameters:

type -

getCleanName

@Deprecated
public java.lang.String getCleanName()

Deprecated.

setCleanName

@Deprecated
public void setCleanName(java.lang.String name)

Deprecated.

hasBeenCleaned

@Deprecated
public boolean hasBeenCleaned()

Deprecated.

isHomonym

public boolean isHomonym()

isSynonym

public boolean isSynonym()

getSynonymLsid

@Deprecated
public java.lang.String getSynonymLsid()

Deprecated. Use getAcceptedLsid() instead

When the LSID for the synonym is null return the ID for the synonym

Returns:

getAcceptedLsid

public java.lang.String getAcceptedLsid()

Returns:

The accepted LSID for this name. When the name is not a synonym null is returned

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRank

public RankType getRank()

setRank

public void setRank(RankType rank)

getLeft

public java.lang.String getLeft()

setLeft

public void setLeft(java.lang.String left)

getRight

public java.lang.String getRight()

setRight

public void setRight(java.lang.String right)