HeadGroup (jgoslin-parsers 1.1.0 API)

java.lang.Object
- de.isas.lipidomics.domain.HeadGroup

```
public class HeadGroup
extends Object
```
This class represents functional head groups of lipids. This is where the association to LipidClass and LipidCategory is maintained.

Author:

nils.hoffmann

Constructor Summary

Constructors
Constructor	Description
`HeadGroup(String rawName)`	Creates a new head group from the given head group name.
`HeadGroup(String rawName, Optional<LipidClass> lipidClass)`	Creates a new head group from the given head group name and optionally a lipid class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getNormalizedName()`	Returns a lipid string representation for the head group of this lipid.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HeadGroup
```
public HeadGroup(String rawName)
```
    Creates a new head group from the given head group name. Lipid class and category will be looked up from LipidClass.forHeadGroup(java.lang.String).
    
    Parameters:
    
    rawName - the lipid head group string.
  - HeadGroup
```
public HeadGroup(String rawName,
                 Optional<LipidClass> lipidClass)
```
    Creates a new head group from the given head group name and optionally a lipid class. The lipid class also determines the category.
    
    Parameters:
    
    rawName - the lipid head gruop string.
    
    lipidClass - the lipid class.
- Method Detail
  - getNormalizedName
```
public String getNormalizedName()
```
    Returns a lipid string representation for the head group of this lipid. This method normalizes the original head group name to the class specific primary alias, if the level and class are known. E.g. TG is normalized to TAG.
    
    Returns:
    
    the normalized lipid head group.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object