edu.jhu.hlt.concrete.metadata.tools

Interface SafeTooledAnnotationMetadata

All Superinterfaces:

MetadataTool, SafeAnnotationMetadata

public interface SafeTooledAnnotationMetadata
extends SafeAnnotationMetadata, MetadataTool

Interface that extends the functionality of SafeAnnotationMetadata, requiring implementation a MetadataTool.

Additionally, contains a default implementation of SafeAnnotationMetadata.getTool() that uses the provided MetadataTool to create a well-formed Tool string.

Method Summary

Modifier and Type	Method and Description
default String	getTool() By default, use NewlineMetadataToolBuilder.generateToolString(MetadataTool) to generate a parseable Tool string.
default String	getToolName()
default List<String>	getToolNotes()

Methods inherited from interface edu.jhu.hlt.concrete.safe.metadata.SafeAnnotationMetadata

getTimestamp

Methods inherited from interface edu.jhu.hlt.concrete.metadata.tools.MetadataTool

getToolVersion

Method Detail

getToolName

default String getToolName()

Specified by:

getToolName in interface MetadataTool

Returns:

the name of the tool.

getTool

default String getTool()

By default, use NewlineMetadataToolBuilder.generateToolString(MetadataTool) to generate a parseable Tool string.

Implementers should generally not override this implementation.

Specified by:

getTool in interface SafeAnnotationMetadata

getToolNotes

default List<String> getToolNotes()

Specified by:

getToolNotes in interface MetadataTool

Returns:

a List of Strings that represent notes about the tool. For example, "used for experiment X".