org.docgene.model

Class XMLCitation

java.lang.Object

org.docgene.model.AbstractLink

org.docgene.model.XMLCitation

All Implemented Interfaces:

org.docgene.model.ElementReference, org.docgene.model.ExternalLink, org.docgene.model.NoteContent, ParagraphElement, StyledElement

public class XMLCitation
extends org.docgene.model.AbstractLink
implements org.docgene.model.NoteContent

Represent the content of a "cite" element.

Field Summary

Fields inherited from class org.docgene.model.AbstractLink

isAbsolute, isValid

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLCitation() Constructor.

Method Summary

Modifier and Type	Method and Description
void	bind(java.lang.String urlS) Bind the link URL.
java.lang.String	getAuthor() Return the link reference author.
java.lang.String	getDate() Return the link reference date.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.lang.String	getID() Return the node ID.
int	getIndex() Return the node index.
java.util.List<XMLNoteRef>	getNoteReferences()
java.lang.String	getPublisher() Return the link reference publisher.
java.lang.String	getQuote() Return the noteRef associated quote.
java.lang.String	getText() Return the link description text.
java.net.URL	getURL() Return the link URL.
boolean	hasID() Return true if the node has an ID.
void	setAuthor(java.lang.String author) Set the link reference author.
void	setDate(java.lang.String date) Set the link reference date.
void	setID(java.lang.String id) Set the node ID
void	setIndex(int index) Set the node index.
void	setPublisher(java.lang.String publisher) Set the link reference publisher.
void	setQuote(java.lang.String quote) Set the noteRef associated quote.
void	setText(java.lang.String text) Set the link text.

Methods inherited from class org.docgene.model.AbstractLink

getCustomStyles, getLineNumber, isAbsolute, isValid, setCustomStyles, setLineNumber, setValid

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docgene.model.NoteContent

getRef

Methods inherited from interface org.docgene.model.ExternalLink

getNotNullURL, getPath, getURLAsString, getURLAsString, getURLAsString

Methods inherited from interface org.docgene.model.StyledElement

getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Constructor Detail

XMLCitation

public XMLCitation()

Constructor.

Method Detail

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Specified by:

getDeclaration in interface StyledElement

Returns:

the declaration ID of the element

setAuthor

public void setAuthor(java.lang.String author)

Set the link reference author.

Parameters:

author - the link reference author

getAuthor

public java.lang.String getAuthor()

Return the link reference author.

Returns:

the link reference author

setPublisher

public void setPublisher(java.lang.String publisher)

Set the link reference publisher.

Parameters:

publisher - the link reference publisher

getPublisher

public java.lang.String getPublisher()

Return the link reference publisher.

Returns:

the link reference publisher

setDate

public void setDate(java.lang.String date)

Set the link reference date.

Parameters:

date - the link reference date

getDate

public java.lang.String getDate()

Return the link reference date.

Returns:

the link reference date

setQuote

public void setQuote(java.lang.String quote)

Set the noteRef associated quote.

Parameters:

quote - the noteRef associated quote

getQuote

public java.lang.String getQuote()

Return the noteRef associated quote.

Returns:

the noteRef associated quote

setText

public void setText(java.lang.String text)

Set the link text.

Parameters:

text - the link text

getURL

public java.net.URL getURL()

Return the link URL.

Specified by:

getURL in interface org.docgene.model.ExternalLink

Returns:

the link URL

getText

public java.lang.String getText()

Return the link description text.

Specified by:

getText in interface org.docgene.model.ExternalLink

Returns:

the link description text

bind

public void bind(java.lang.String urlS)
          throws java.net.MalformedURLException

Bind the link URL.

Parameters:

urlS - the URL as String

Throws:

java.net.MalformedURLException

setIndex

public void setIndex(int index)

Set the node index.

Specified by:

setIndex in interface org.docgene.model.NoteContent

Parameters:

index - the node index

setID

public void setID(java.lang.String id)

Set the node ID

Parameters:

id - the node ID

hasID

public boolean hasID()

Return true if the node has an ID.

Specified by:

hasID in interface org.docgene.model.NoteContent

Returns:

true if the node has an ID

getID

public java.lang.String getID()

Return the node ID.

Specified by:

getID in interface org.docgene.model.NoteContent

Returns:

the node ID

getIndex

public int getIndex()

Return the node index.

Specified by:

getIndex in interface org.docgene.model.NoteContent

Returns:

the node index

getNoteReferences

public java.util.List<XMLNoteRef> getNoteReferences()

Specified by:

getNoteReferences in interface org.docgene.model.NoteContent