org.openimaj.citation.annotation

Annotation Type Reference

@Retention(value=RUNTIME)
 @Documented
 @Target(value={METHOD,TYPE,PACKAGE})
public @interface Reference

Annotation for bibtex-style references inside the code.

Author:

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

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	author The name(s) of the author(s)
String	title The title of the work
ReferenceType	type The type of publication
String	year The year of publication (or, if unpublished, the year of creation)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	booktitle The title of the book, if only part of it is being cited
String	chapter The chapter number
String[]	customData A list of custom key value data pairs.
String	edition The edition of a book, long form (such as "first" or "second")
String[]	editor The name(s) of the editor(s)
String	institution The institution that was involved in the publishing, but not necessarily the publisher
String	journal The journal or magazine the work was published in
String	month The month of publication (or, if unpublished, the month of creation)
String	note Miscellaneous extra information
String	number The "(issue) number" of a journal, magazine, or tech-report, if applicable.
String	organization The conference sponsor
String[]	pages Page numbers
String	publisher The publisher's name
String	school The school where the thesis was written
String	series The series of books the book was published in (e.g.
String	url An optional URL reference where the publication can be found.
String	volume The volume of a journal or multi-volume book

Element Detail

author

public abstract String[] author

The name(s) of the author(s)

Returns:

The name(s) of the author(s)

title

public abstract String title

The title of the work

Returns:

The title of the work

type

public abstract ReferenceType type

The type of publication

Returns:

The type of publication

See Also:

ReferenceType

year

public abstract String year

The year of publication (or, if unpublished, the year of creation)

Returns:

The year of publication (or, if unpublished, the year of creation)

journal

public abstract String journal

The journal or magazine the work was published in

Returns:

The journal or magazine the work was published in

Default:

""

booktitle

public abstract String booktitle

The title of the book, if only part of it is being cited

Returns:

The title of the book, if only part of it is being cited

Default:

""

pages

public abstract String[] pages

Page numbers

Returns:

Page numbers

Default:

{}

chapter

public abstract String chapter

The chapter number

Returns:

The chapter number

Default:

""

edition

public abstract String edition

The edition of a book, long form (such as "first" or "second")

Returns:

The edition of a book, long form (such as "first" or "second")

Default:

""

url

public abstract String url

An optional URL reference where the publication can be found.

Returns:

A URL where the reference can be found.

Default:

""

note

public abstract String note

Miscellaneous extra information

Returns:

Miscellaneous extra information

Default:

""

editor

public abstract String[] editor

The name(s) of the editor(s)

Returns:

The name(s) of the editor(s)

Default:

{}

institution

public abstract String institution

The institution that was involved in the publishing, but not necessarily the publisher

Returns:

The institution that was involved in the publishing, but not necessarily the publisher

Default:

""

month

public abstract String month

The month of publication (or, if unpublished, the month of creation)

Returns:

The month of publication (or, if unpublished, the month of creation)

Default:

""

number

public abstract String number

The "(issue) number" of a journal, magazine, or tech-report, if applicable. (Most publications have a "volume", but no "number" field.)

Returns:

The "(issue) number" of a journal, magazine, or tech-report, if applicable. (Most publications have a "volume", but no "number" field.)

Default:

""

organization

public abstract String organization

The conference sponsor

Returns:

The conference sponsor

Default:

""

publisher

public abstract String publisher

The publisher's name

Returns:

The publisher's name

Default:

""

school

public abstract String school

The school where the thesis was written

Returns:

The school where the thesis was written

Default:

""

series

public abstract String series

The series of books the book was published in (e.g. "The Hardy Boys" or "Lecture Notes in Computer Science")

Returns:

The series of books the book was published in (e.g. "The Hardy Boys" or "Lecture Notes in Computer Science")

Default:

""

volume

public abstract String volume

The volume of a journal or multi-volume book

Returns:

The volume of a journal or multi-volume book

Default:

""

customData

public abstract String[] customData

A list of custom key value data pairs.

Returns:

A list of custom key value data pairs.

Default:

{}