org.openimaj.experiment.annotations

Annotation Type DatasetDescription

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface DatasetDescription

An annotation for marking up a specific org.openimaj.data.Dataset subclass with metadata about the dataset.

The ExperimentContext can use this metadata in any reports that it generates.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description
String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	contact
String	creator
String[]	downloadUrls
String	url

Element Detail

name

public abstract String name

Returns:

the name of the dataset

description

public abstract String description

Returns:

a description of the dataset

creator

public abstract String creator

Returns:

the creator of the dataset

Default:

""

url

public abstract String url

Returns:

a URL to information about the dataset

Default:

""

contact

public abstract String contact

Returns:

a contact person/site for the dataset

Default:

""

downloadUrls

public abstract String[] downloadUrls

Returns:

list of download location(s) for the data

Default:

""