Package ubic.gemma.core.analysis.service

Interface ExpressionMetadataChangelogFileService

All Known Implementing Classes:

ExpressionMetadataChangelogFileServiceImpl

public interface ExpressionMetadataChangelogFileService

Service for reading and appending to changelog files.

External metadata files are not under Gemma's management, so the changes they go through is not kept track of in the AuditTrail of an experiment. Instead, a changelog file is maintained under ${gemma.appdata.home}/metadata/GSEnnnnn/CHANGELOG.md.

The format of the changelog follows that of GNU.

Author:

poirigui

Method Summary

Modifier and Type	Method	Description
void	addChangelogEntry(ExpressionExperiment expressionExperiment, String changelogEntry)
void	addChangelogEntry(ExpressionExperiment expressionExperiment, String changelogEntry, LocalDate date)	Add a changelog entry to the changelog file of the given experiment.
String	readChangelog(ExpressionExperiment expressionExperiment)	Read the content of the changelog file of the given experiment.

Method Details

readChangelog

String readChangelog(ExpressionExperiment expressionExperiment)
              throws IOException

Read the content of the changelog file of the given experiment.

If no changelog file is found, an empty string is returned.

Throws:

IOException

addChangelogEntry

void addChangelogEntry(ExpressionExperiment expressionExperiment,
 String changelogEntry)
                throws IOException

Throws:

IOException

See Also:

• addChangelogEntry(ExpressionExperiment, String, LocalDate)

addChangelogEntry

void addChangelogEntry(ExpressionExperiment expressionExperiment,
 String changelogEntry,
 LocalDate date)
                throws IOException

Add a changelog entry to the changelog file of the given experiment.

Parameters:

expressionExperiment - the experiment to add the entry to

changelogEntry - the content of the entry, the date and author are automatically added

date - the date of the entry. This is a local date because the changelog format does not include a timezone.

Throws:

IOException