public class EnzymeName extends Object implements Comparable<EnzymeName>, Viewable
Currently three different types of names are supported:
Synonyms can be qualified and ordered.
Instances of this class are immutable.
Modifier and Type | Field and Description |
---|---|
static EnzymeName |
UNDEF |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(EnzymeName name) |
boolean |
equals(Object o)
Standard equals method omitting 'orderIn' attribute, which is irrelevant for this check.
|
static EnzymeName |
getCommonNameInstance(String name,
EnzymeSourceConstant source,
EnzymeViewConstant view)
Returns an
EnzymeName instance representing an enzyme's common (recommended) name. |
String |
getName()
Returns the name.
|
EnzymeNameQualifierConstant |
getQualifier()
Returns the name's qualifier.
|
EnzymeSourceConstant |
getSource()
Returns the name's source.
|
static EnzymeName |
getSynonymInstance(String name,
EnzymeNameQualifierConstant qualifier,
EnzymeSourceConstant source,
EnzymeViewConstant view)
Returns an
EnzymeName instance representing an enzyme's synonym. |
static EnzymeName |
getSystematicNameInstance(String name,
EnzymeSourceConstant source,
EnzymeViewConstant view)
Returns an
EnzymeName instance representing an enzyme's systematic name. |
EnzymeNameTypeConstant |
getType()
Returns the name's type.
|
EnzymeViewConstant |
getView()
Returns the name's view code.
|
int |
hashCode()
Returns the hash code of this object.
|
static EnzymeName |
valueOf(String name,
EnzymeNameTypeConstant type,
EnzymeNameQualifierConstant qualifier,
EnzymeSourceConstant source,
EnzymeViewConstant view) |
public static EnzymeName UNDEF
public static EnzymeName valueOf(String name, EnzymeNameTypeConstant type, EnzymeNameQualifierConstant qualifier, EnzymeSourceConstant source, EnzymeViewConstant view)
public static EnzymeName getCommonNameInstance(String name, EnzymeSourceConstant source, EnzymeViewConstant view)
EnzymeName
instance representing an enzyme's common (recommended) name.name
- The common name.EnzymeName
instance representing the common name.NullPointerException
- if name
is null
.IllegalArgumentException
- if name
is empty.public static EnzymeName getSystematicNameInstance(String name, EnzymeSourceConstant source, EnzymeViewConstant view)
EnzymeName
instance representing an enzyme's systematic name.name
- The systematic name.EnzymeName
instance representing the systematic name.NullPointerException
- if name
is null
.IllegalArgumentException
- if name
is empty.public static EnzymeName getSynonymInstance(String name, EnzymeNameQualifierConstant qualifier, EnzymeSourceConstant source, EnzymeViewConstant view)
EnzymeName
instance representing an enzyme's synonym.name
- The systematic name.qualifier
- A qualifier used for synonyms (see EnzymeNameQualifierConstant
).EnzymeName
instance representing the synonym.NullPointerException
- if name
or qualifier
are null
.IllegalArgumentException
- if name
is empty or orderIn
is < 1.public int compareTo(EnzymeName name)
compareTo
in interface Comparable<EnzymeName>
name
- The specified enzyme name.public boolean equals(Object o)
public int hashCode()
public String getName()
public EnzymeNameTypeConstant getType()
EnzymeNameTypeConstant
public EnzymeNameQualifierConstant getQualifier()
EnzymeNameQualifierConstant
public EnzymeSourceConstant getSource()
EnzymeSourceConstant
public EnzymeViewConstant getView()
The code defines in which view this name will be displayed.
getView
in interface Viewable
EnzymeViewConstant
Copyright © 2014 EMBL-EBI. All rights reserved.