Package org.lifstools.jgoslin.domain

Class LipidClassMeta

java.lang.Object

org.lifstools.jgoslin.domain.LipidClassMeta

public final class LipidClassMeta
extends Object

Metadata information about a lipid on class level.

Author:

Dominik Kopczynski, Nils Hoffmann

See Also:

• LipidClasses
• LipidLevel

Field Summary

Fields

Modifier and Type	Field	Description
final String	description
final ElementTable	elements
final LipidCategory	lipidCategory
final String	lipidClassName
final int	maxNumFa
final int	possibleNumFa
final Set<String>	specialCases
final List<String>	synonyms

Constructor Summary

Constructors

Constructor	Description
LipidClassMeta(LipidCategory lipidCategory, String lipidClassName, String description, int maxNumFa, int possibleNumFa, Set<String> specialCases, ElementTable elements, List<String> synonyms)	Create a new lipid class meta instance.

Method Summary

Modifier and Type	Method	Description
String	getClassName()
String	getDescription()
ElementTable	getElements()
LipidCategory	getLipidCategory()
int	getMaxNumFa()
int	getPossibleNumFa()
Set<String>	getSpecialCases()
List<String>	getSynonyms()

Methods inherited from class java.lang.Object

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

Field Details

lipidCategory

public final LipidCategory lipidCategory

lipidClassName

public final String lipidClassName

description

public final String description

maxNumFa

public final int maxNumFa

possibleNumFa

public final int possibleNumFa

specialCases

public final Set<String> specialCases

elements

public final ElementTable elements

synonyms

public final List<String> synonyms

Constructor Details

LipidClassMeta

public LipidClassMeta(LipidCategory lipidCategory,
 String lipidClassName,
 String description,
 int maxNumFa,
 int possibleNumFa,
 Set<String> specialCases,
 ElementTable elements,
 List<String> synonyms)

Create a new lipid class meta instance.

Parameters:

lipidCategory - the lipid category

lipidClassName - the lipid class name

description - the description

maxNumFa - the maximum number of fatty acids allowed for this lipid class

possibleNumFa - the minimum possible number of fatty acids for this lipid class

specialCases - the special cases

elements - the elements (sum formula) of this class head group

synonyms - the synonyms of this lipid class head group

Method Details

getLipidCategory

public LipidCategory getLipidCategory()

getClassName

public String getClassName()

getDescription

public String getDescription()

getMaxNumFa

public int getMaxNumFa()

getPossibleNumFa

public int getPossibleNumFa()

getSpecialCases

public Set<String> getSpecialCases()

getElements

public ElementTable getElements()

getSynonyms

public List<String> getSynonyms()