Class ArticleCatalogReader

java.lang.Object

org.episteme.core.io.AbstractResourceReader<List<BibliographicalNotice>>

org.episteme.core.bibliography.loaders.ArticleCatalogReader

All Implemented Interfaces:

CatalogReader, ResourceIO<List<BibliographicalNotice>>, ResourceReader<List<BibliographicalNotice>>

public class ArticleCatalogReader
extends AbstractResourceReader<List<BibliographicalNotice>>
implements CatalogReader

Loader for scientific article catalogs, supporting interfaces with major research databases like PubMed, CrossRef, or arXiv.

Since:

1.0

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Constructor Summary

Constructors

Constructor	Description
ArticleCatalogReader()

Method Summary

Modifier and Type	Method	Description
String	getCategory()	Returns the category for grouping.
String	getDescription()	Returns a short description of this resource handler.
String	getLongDescription()	Returns a long description of this resource handler.
String	getName()	Returns the display name of this resource handler.
String	getResourcePath()	Returns the base path where this resource is located.
Class<List<BibliographicalNotice>>	getResourceType()	Returns the type of resource.
String[]	getSupportedVersions()	Returns the supported versions of the format this reader/writer handles.
protected List<BibliographicalNotice>	loadFromInputStream(InputStream is, String id)
protected List<BibliographicalNotice>	loadFromSource(String id)
CompletableFuture<BibliographicalNotice>	loadNotice(String id)	Loads a specific notice by its identifier (e.g., ISBN, DOI).
CompletableFuture<List<BibliographicalNotice>>	search(String query)	Searches the catalog for works matching the given query string.

Methods inherited from class AbstractResourceReader

clearCache, getMiniCatalog, getSampleDataPath, isUsingFallback, load, loadAll, loadAllFromSource, loadFromFallback, 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, load

Constructor Details

ArticleCatalogReader

public ArticleCatalogReader()

Method Details

search

public CompletableFuture<List<BibliographicalNotice>> search(String query)

Description copied from interface: CatalogReader

Searches the catalog for works matching the given query string.

Specified by:

search in interface CatalogReader

Parameters:

query - the search query

Returns:

a list of matching notices

loadNotice

public CompletableFuture<BibliographicalNotice> loadNotice(String id)

Description copied from interface: CatalogReader

Loads a specific notice by its identifier (e.g., ISBN, DOI).

Specified by:

loadNotice in interface CatalogReader

Parameters:

id - the identifier

Returns:

the notice, or null if not found

loadFromSource

protected List<BibliographicalNotice> loadFromSource(String id)
                                              throws Exception

Specified by:

loadFromSource in class AbstractResourceReader<List<BibliographicalNotice>>

Throws:

Exception

loadFromInputStream

protected List<BibliographicalNotice> loadFromInputStream(InputStream is,
 String id)
                                                   throws Exception

Overrides:

loadFromInputStream in class AbstractResourceReader<List<BibliographicalNotice>>

Throws:

Exception

getResourcePath

public String getResourcePath()

Description copied from interface: ResourceIO

Returns the base path where this resource is located.

Specified by:

getResourcePath in interface ResourceIO<List<BibliographicalNotice>>

getResourceType

public Class<List<BibliographicalNotice>> getResourceType()

Description copied from interface: ResourceIO

Returns the type of resource.

Specified by:

getResourceType in interface ResourceIO<List<BibliographicalNotice>>

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<List<BibliographicalNotice>>

Returns:

the display 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<List<BibliographicalNotice>>

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<List<BibliographicalNotice>>

Returns:

the long description

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<List<BibliographicalNotice>>

Returns:

the category name

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<List<BibliographicalNotice>>

Returns:

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