au.org.ala.names.model
Class LinnaeanRankClassification

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

public class LinnaeanRankClassification
extends java.lang.Object

A model object that represents a Linnaean Classification.

Field Summary

protected java.lang.String	authorship
protected java.lang.String	cid
protected java.lang.String	family
protected java.lang.String	fid
protected java.lang.String	genus
protected java.lang.String	gid
protected java.lang.String	infraspecificEpithet
protected java.lang.String	kid
protected java.lang.String	kingdom
protected java.lang.String	klass
protected java.lang.String	oid
protected java.lang.String	order
protected java.lang.String	phylum
protected java.lang.String	pid
protected java.lang.String	rank
protected java.lang.String	scientificName
protected java.lang.String	sid
protected java.lang.String	species
protected java.lang.String	specificEpithet
protected java.lang.String	subspecies

Constructor Summary

LinnaeanRankClassification()

LinnaeanRankClassification(LinnaeanRankClassification cl)

LinnaeanRankClassification(java.lang.String kingdom, java.lang.String genus)
The constructor was added for convenience.

LinnaeanRankClassification(java.lang.String kingdom, java.lang.String phylum, java.lang.String klass, java.lang.String order, java.lang.String family, java.lang.String genus, java.lang.String scientificName)

LinnaeanRankClassification(java.lang.String kingdom, java.lang.String phylum, java.lang.String klass, java.lang.String order, java.lang.String family, java.lang.String genus, java.lang.String species, java.lang.String specificEpithet, java.lang.String subspecies, java.lang.String infraspecificEpithet, java.lang.String scientificName)

Method Summary

boolean	equals(java.lang.Object object)
java.lang.String	getAuthorship()
java.lang.String	getCid()
java.lang.String	getFamily()
java.lang.String	getFid()
java.lang.String	getGenus()
java.lang.String	getGid()
java.lang.String	getInfraspecificEpithet()
java.lang.String	getKid()
java.lang.String	getKingdom()
java.lang.String	getKlass()
java.lang.String	getLuceneSearchString(boolean optional) Returns the additional string that needs to be included in a search
java.lang.String	getOid()
java.lang.String	getOrder()
java.lang.String	getPhylum()
java.lang.String	getPid()
java.lang.String	getRank()
java.lang.String	getScientificName()
java.lang.String	getSid()
java.lang.String	getSpecies()
java.lang.String	getSpecificEpithet()
java.lang.String	getSubspecies()
int	hashCode()
boolean	hasIdenticalClassification(LinnaeanRankClassification lrc, RankType matchLevel) 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.
static void	main(java.lang.String[] args)
void	setAuthorship(java.lang.String authorship)
void	setCid(java.lang.String cid)
void	setFamily(java.lang.String family)
void	setFid(java.lang.String fid)
void	setGenus(java.lang.String genus)
void	setGid(java.lang.String gid)
void	setInfraspecificEpithet(java.lang.String infraspecificEpithet)
void	setKid(java.lang.String kid)
void	setKingdom(java.lang.String kingdom)
void	setKlass(java.lang.String klass)
void	setOid(java.lang.String oid)
void	setOrder(java.lang.String order)
void	setPhylum(java.lang.String phylum)
void	setPid(java.lang.String pid)
void	setRank(java.lang.String rank)
void	setScientificName(java.lang.String scientificName)
void	setSid(java.lang.String sid)
void	setSpecies(java.lang.String species)
void	setSpecificEpithet(java.lang.String specificEpithet)
void	setSubspecies(java.lang.String subspecies)
java.lang.String	toCSV(char sep)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

kingdom

protected java.lang.String kingdom

kid

protected java.lang.String kid

phylum

protected java.lang.String phylum

pid

protected java.lang.String pid

klass

protected java.lang.String klass

cid

protected java.lang.String cid

order

protected java.lang.String order

oid

protected java.lang.String oid

family

protected java.lang.String family

fid

protected java.lang.String fid

genus

protected java.lang.String genus

gid

protected java.lang.String gid

species

protected java.lang.String species

sid

protected java.lang.String sid

specificEpithet

protected java.lang.String specificEpithet

subspecies

protected java.lang.String subspecies

infraspecificEpithet

protected java.lang.String infraspecificEpithet

scientificName

protected java.lang.String scientificName

authorship

protected java.lang.String authorship

rank

protected java.lang.String rank

Constructor Detail

LinnaeanRankClassification

public LinnaeanRankClassification()

LinnaeanRankClassification

public LinnaeanRankClassification(java.lang.String kingdom,
                                  java.lang.String phylum,
                                  java.lang.String klass,
                                  java.lang.String order,
                                  java.lang.String family,
                                  java.lang.String genus,
                                  java.lang.String species,
                                  java.lang.String specificEpithet,
                                  java.lang.String subspecies,
                                  java.lang.String infraspecificEpithet,
                                  java.lang.String scientificName)

LinnaeanRankClassification

public LinnaeanRankClassification(LinnaeanRankClassification cl)

LinnaeanRankClassification

public LinnaeanRankClassification(java.lang.String kingdom,
                                  java.lang.String phylum,
                                  java.lang.String klass,
                                  java.lang.String order,
                                  java.lang.String family,
                                  java.lang.String genus,
                                  java.lang.String scientificName)

Parameters:

kingdom -

phylum -

klass -

order -

family -

genus -

scientificName -

LinnaeanRankClassification

public LinnaeanRankClassification(java.lang.String kingdom,
                                  java.lang.String genus)

The constructor was added for convenience.

Parameters:

kingdom -

genus -

Method Detail

getFamily

public java.lang.String getFamily()

Returns:

Returns the family.

setFamily

public void setFamily(java.lang.String family)

Parameters:

family - The family to set.

getGenus

public java.lang.String getGenus()

Returns:

Returns the genus.

setGenus

public void setGenus(java.lang.String genus)

Parameters:

genus - The genus to set.

getKingdom

public java.lang.String getKingdom()

Returns:

Returns the kingdom.

setKingdom

public void setKingdom(java.lang.String kingdom)

Parameters:

kingdom - The kingdom to set.

getKlass

public java.lang.String getKlass()

Returns:

Returns the klass.

setKlass

public void setKlass(java.lang.String klass)

Parameters:

klass - The klass to set.

getOrder

public java.lang.String getOrder()

Returns:

Returns the order.

setOrder

public void setOrder(java.lang.String order)

Parameters:

order - The order to set.

getPhylum

public java.lang.String getPhylum()

Returns:

Returns the phylum.

setPhylum

public void setPhylum(java.lang.String phylum)

Parameters:

phylum - The phylum to set.

getScientificName

public java.lang.String getScientificName()

Returns:

Returns the scientificName.

setScientificName

public void setScientificName(java.lang.String scientificName)

Parameters:

scientificName - The scientificName to set.

getSpecies

public java.lang.String getSpecies()

setSpecies

public void setSpecies(java.lang.String species)

getSpecificEpithet

public java.lang.String getSpecificEpithet()

Returns:

the specificEpithet

setSpecificEpithet

public void setSpecificEpithet(java.lang.String specificEpithet)

Parameters:

specificEpithet - the specificEpithet to set

getInfraspecificEpithet

public java.lang.String getInfraspecificEpithet()

Returns:

the infraspecificEpithet

setInfraspecificEpithet

public void setInfraspecificEpithet(java.lang.String infraspecificEpithet)

Parameters:

infraspecificEpithet - the infraspecificEpithet to set

getSubspecies

public java.lang.String getSubspecies()

Returns:

the subspecies

setSubspecies

public void setSubspecies(java.lang.String subspecies)

Parameters:

subspecies - the subspecies to set

getKid

public java.lang.String getKid()

Returns:

the identification for the kingdom, either a CB ID or GUID

setKid

public void setKid(java.lang.String kid)

getPid

public java.lang.String getPid()

Returns:

the identification for the phylum, either a CB ID or GUID

setPid

public void setPid(java.lang.String pid)

getCid

public java.lang.String getCid()

Returns:

the identification for the class, either a CB ID or GUID

setCid

public void setCid(java.lang.String cid)

getOid

public java.lang.String getOid()

Returns:

the identification for the order, either a CB ID or GUID

setOid

public void setOid(java.lang.String oid)

getFid

public java.lang.String getFid()

setFid

public void setFid(java.lang.String fid)

getGid

public java.lang.String getGid()

setGid

public void setGid(java.lang.String gid)

getSid

public java.lang.String getSid()

setSid

public void setSid(java.lang.String sid)

getAuthorship

public java.lang.String getAuthorship()

setAuthorship

public void setAuthorship(java.lang.String authorship)

getRank

public java.lang.String getRank()

setRank

public void setRank(java.lang.String rank)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

toCSV

public java.lang.String toCSV(char sep)

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(Object)

hasIdenticalClassification

public boolean hasIdenticalClassification(LinnaeanRankClassification lrc,
                                          RankType matchLevel)

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. Thus we are not using the scientific name.

Use this method to determine whether or not a search result (lrc) matches the supplied classification.

Parameters:

lrc -

Returns:

getLuceneSearchString

public java.lang.String getLuceneSearchString(boolean optional)

Returns the additional string that needs to be included in a search

Parameters:

optional - Indicates whether the the terms should be optional

Returns:

main

public static void main(java.lang.String[] args)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()