magpie.utility.interfaces

Class Citation

java.lang.Object

magpie.utility.interfaces.Citation

public class Citation
extends java.lang.Object

Class used by Citable to define a resource being cited.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String[]	Authors Author(s) associated with this citation
java.lang.Class	Component Component this citation is associated with
java.net.URL	Location URL of resource being cited.
java.lang.String	Notes Anything else that a user should know about this resource.
java.lang.String	Title Title of resource being cited.
java.lang.String	Type Type of resource being cited.

Constructor Summary

Constructors

Constructor and Description
Citation(java.lang.Class component, java.lang.String type, java.lang.String[] authors, java.lang.String title, java.lang.String url, java.lang.String notes) Create a new citation object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	hashCode()
java.lang.String	printInformation() Print out a description of this citation.
org.json.JSONObject	toJSON() Return citation into JSON.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

Component

public final java.lang.Class Component

Component this citation is associated with

Authors

public final java.lang.String[] Authors

Author(s) associated with this citation

Title

public final java.lang.String Title

Title of resource being cited. Examples: Title of paper, name of software package.

Type

public final java.lang.String Type

Type of resource being cited. Examples: "Article", "Webpage", "Book", "Thesis"

Location

public final java.net.URL Location

URL of resource being cited. If not available, list None

Notes

public final java.lang.String Notes

Anything else that a user should know about this resource.

Constructor Detail

Citation

public Citation(java.lang.Class component,
                java.lang.String type,
                java.lang.String[] authors,
                java.lang.String title,
                java.lang.String url,
                java.lang.String notes)

Create a new citation object. Optional arguments can be null. This should give enough information for the person to find the resource but need not include enough information for a complete citation.

Parameters:

component - Component that this citation is associated with

authors - Optional: List of authors. [0] should be the primary author. Preferred format: <first initial>. <family name>. Recommended to use "et al." for author lists longer than 3.

title - Title of resource

type - Type of resource being cited (e.g., "Article", "Webpage", "Book").

url - Optional: URL of resource

notes - Optional: Anything else someone who cites this should know

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

printInformation

public java.lang.String printInformation()

Print out a description of this citation.

Returns:

String containing a formated description of this citation

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJSON

public org.json.JSONObject toJSON()

Return citation into JSON. Detailed formatting should be in HTML format

Returns:

JSON object describing the citation