org.ands.rifcs.base

Class CitationInfo

java.lang.Object

org.ands.rifcs.base.RIFCSElement

org.ands.rifcs.base.CitationInfo

public class CitationInfo
extends RIFCSElement

Class representing registry object related information.

Author:

Scott Yeadon

Method Summary

Methods

Modifier and Type	Method and Description
void	addCitationMetadata(CitationMetadata citationMetadata) Add citationMetadata to the citationInfo object.
java.lang.String	getCitation() Get the fullCitation.
CitationMetadata	getCitationMetadata() Get the citationMetadata.
java.lang.String	getCitationStyle() Get the fullCitation style.
CitationMetadata	newCitationMetadata() Create and return an empty CitationMetadata object.
void	setCitation(java.lang.String citation, java.lang.String style) Set the fullCitation and citation style.

Methods inherited from class java.lang.Object

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

Method Detail

newCitationMetadata

public final CitationMetadata newCitationMetadata()
                                           throws RIFCSException

Create and return an empty CitationMetadata object. The returned object has no properties or content and is not part of the RIF-CS document, it is essentially a constructor of an object owned by the RIF-CS document. The returned object needs to be "filled out" (e.g. with properties, additional sub-elements, etc) before being added to the RIF-CS document.

Returns:

the new CitationMetadata object

Throws:

RIFCSException - A RIFCSException

setCitation

public final void setCitation(java.lang.String citation,
               java.lang.String style)
                       throws RIFCSException

Set the fullCitation and citation style.

Parameters:

citation - The full citation in string form

style - The full citation style, use null if style is unknown

Throws:

RIFCSException - A RIFCSException

getCitation

public final java.lang.String getCitation()

Get the fullCitation.

Returns:

String The fullCitation element content in string form or empty string if not present

getCitationStyle

public final java.lang.String getCitationStyle()

Get the fullCitation style.

Returns:

String The fullCitation element style or empty string if there is no style associated with the citation text

addCitationMetadata

public final void addCitationMetadata(CitationMetadata citationMetadata)

Add citationMetadata to the citationInfo object.

Parameters:

citationMetadata - a citationMetadata option

getCitationMetadata

public final CitationMetadata getCitationMetadata()

Get the citationMetadata.

Returns:

CitationMetadata a citationMetadata object