org.openimaj.citation.annotation.mock

Class MockReference

java.lang.Object

org.openimaj.citation.annotation.mock.MockReference

All Implemented Interfaces:

InvocationHandler

public class MockReference
extends Object
implements InvocationHandler

A Mocked version of a Reference

Author:

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

Constructor Summary

Constructors

Constructor and Description
MockReference(org.jbibtex.BibTeXEntry entry) Construct from a BibTeXEntry

Method Summary

Modifier and Type	Method and Description
Reference	asReference()
String[]	author() The name(s) of the author(s)
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
Object	invoke(Object proxy, Method method, Object[] args)
String	journal() The journal or magazine the work was published in
static Reference	makeReference(org.jbibtex.BibTeXEntry entry) Make a Reference from a BibTeXEntry.
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	title() The title of the work
ReferenceType	type() The type of publication
String	url() An optional URL reference where the publication can be found.
String	volume() The volume of a journal or multi-volume book
String	year() The year of publication (or, if unpublished, the year of creation)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MockReference

public MockReference(org.jbibtex.BibTeXEntry entry)

Construct from a BibTeXEntry

Parameters:

entry - the BibTeXEntry

Method Detail

author

public String[] author()

The name(s) of the author(s)

Returns:

The name(s) of the author(s)

title

public String title()

The title of the work

Returns:

The title of the work

type

public ReferenceType type()

The type of publication

Returns:

The type of publication

See Also:

ReferenceType

year

public 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 String journal()

The journal or magazine the work was published in

Returns:

The journal or magazine the work was published in

booktitle

public 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

pages

public String[] pages()

Page numbers

Returns:

Page numbers

chapter

public String chapter()

The chapter number

Returns:

The chapter number

edition

public 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")

url

public String url()

An optional URL reference where the publication can be found.

Returns:

A URL where the reference can be found.

note

public String note()

Miscellaneous extra information

Returns:

Miscellaneous extra information

editor

public String[] editor()

The name(s) of the editor(s)

Returns:

The name(s) of the editor(s)

institution

public 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

month

public 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)

number

public 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.)

organization

public String organization()

The conference sponsor

Returns:

The conference sponsor

publisher

public String publisher()

The publisher's name

Returns:

The publisher's name

school

public String school()

The school where the thesis was written

Returns:

The school where the thesis was written

series

public 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")

volume

public String volume()

The volume of a journal or multi-volume book

Returns:

The volume of a journal or multi-volume book

customData

public String[] customData()

A list of custom key value data pairs.

Returns:

A list of custom key value data pairs.

invoke

public Object invoke(Object proxy,
                     Method method,
                     Object[] args)
              throws Throwable

Specified by:

invoke in interface InvocationHandler

Throws:

Throwable

asReference

public Reference asReference()

Returns:

the MockReference as a Reference instance

makeReference

public static Reference makeReference(org.jbibtex.BibTeXEntry entry)

Make a Reference from a BibTeXEntry.

Parameters:

entry - the BibTeXEntry.

Returns:

the Reference