Class VitaminReader

java.lang.Object

org.episteme.core.io.AbstractResourceReader<Vitamin>

org.episteme.natural.biology.loaders.VitaminReader

All Implemented Interfaces:

MiniCatalog<Vitamin>, ResourceIO<Vitamin>, ResourceReader<Vitamin>

public class VitaminReader
extends AbstractResourceReader<Vitamin>
implements MiniCatalog<Vitamin>

Loads and manages vitamins data from JSON. Acts as a catalog of vitamins.

Since:

1.0

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Method Summary

Modifier and Type	Method	Description
Optional<Vitamin>	findByName(String name)	Finds an entry by name.
List<Vitamin>	getAll()	Returns all entries in the catalog.
String	getCategory()	Returns the category for grouping.
String	getDescription()	Returns a short description of this resource handler.
List<Vitamin>	getFatSoluble()
static VitaminReader	getInstance()
String	getLongDescription()	Returns a long description of this resource handler.
protected MiniCatalog<Vitamin>	getMiniCatalog()
String	getName()	Returns the display name of this resource handler.
String	getResourcePath()	Returns the base path where this resource is located.
Class<Vitamin>	getResourceType()	Returns the type of resource.
String[]	getSupportedVersions()	Returns the supported versions of the format this reader/writer handles.
List<Vitamin>	getWaterSoluble()
static List<Vitamin>	loadFromResource(String resourcePath)
protected Vitamin	loadFromSource(String id)
int	size()	Returns the size of the catalog.

Methods inherited from class AbstractResourceReader

clearCache, getSampleDataPath, isUsingFallback, load, loadAll, loadAllFromSource, loadFromFallback, loadFromInputStream, setCacheEnabled

Methods inherited from class Object

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

Methods inherited from interface ResourceIO

getExpectedResourceFiles, getSupportedExtensions, isFileBased, isOutput

Methods inherited from interface ResourceReader

isInput

Method Details

getInstance

public static VitaminReader getInstance()

getCategory

public String getCategory()

Description copied from interface: ResourceIO

Returns the category for grouping. MUST be implemented with I18N support.

Specified by:

getCategory in interface ResourceIO<Vitamin>

Returns:

the category name

getDescription

public String getDescription()

Description copied from interface: ResourceIO

Returns a short description of this resource handler. MUST be implemented with I18N support.

Specified by:

getDescription in interface ResourceIO<Vitamin>

Returns:

the description

getLongDescription

public String getLongDescription()

Description copied from interface: ResourceIO

Returns a long description of this resource handler. MUST be implemented with I18N support.

Specified by:

getLongDescription in interface ResourceIO<Vitamin>

Returns:

the long description

getResourcePath

public String getResourcePath()

Description copied from interface: ResourceIO

Returns the base path where this resource is located.

Specified by:

getResourcePath in interface ResourceIO<Vitamin>

getResourceType

public Class<Vitamin> getResourceType()

Description copied from interface: ResourceIO

Returns the type of resource.

Specified by:

getResourceType in interface ResourceIO<Vitamin>

loadFromSource

protected Vitamin loadFromSource(String id)
                          throws Exception

Specified by:

loadFromSource in class AbstractResourceReader<Vitamin>

Throws:

Exception

getMiniCatalog

protected MiniCatalog<Vitamin> getMiniCatalog()

Overrides:

getMiniCatalog in class AbstractResourceReader<Vitamin>

loadFromResource

public static List<Vitamin> loadFromResource(String resourcePath)

getAll

public List<Vitamin> getAll()

Description copied from interface: MiniCatalog

Returns all entries in the catalog.

Specified by:

getAll in interface MiniCatalog<Vitamin>

findByName

public Optional<Vitamin> findByName(String name)

Description copied from interface: MiniCatalog

Finds an entry by name.

Specified by:

findByName in interface MiniCatalog<Vitamin>

size

public int size()

Description copied from interface: MiniCatalog

Returns the size of the catalog.

Specified by:

size in interface MiniCatalog<Vitamin>

getFatSoluble

public List<Vitamin> getFatSoluble()

getWaterSoluble

public List<Vitamin> getWaterSoluble()

getSupportedVersions

public String[] getSupportedVersions()

Description copied from interface: ResourceIO

Returns the supported versions of the format this reader/writer handles.

Each implementation MUST override this method to declare which versions of the underlying format are supported. The returned array should contain version strings in the format's standard notation (e.g., "3.0", "2.1", "Level 3 Version 2").

Examples:

• MathML: {"3.0", "2.0"}
• SBML: {"Level 3 Version 2", "Level 3 Version 1", "Level 2 Version 5"}
• PhyloXML: {"1.10", "1.00"}

Specified by:

getSupportedVersions in interface ResourceIO<Vitamin>

Returns:

array of supported version strings, never null (empty array if version-agnostic)

getName

public String getName()

Description copied from interface: ResourceIO

Returns the display name of this resource handler. MUST be implemented with I18N support.

Specified by:

getName in interface ResourceIO<Vitamin>

Returns:

the display name