org.docgene.model

Class XMLArchiveURL

java.lang.Object

org.docgene.model.AbstractLink

org.docgene.model.XMLExternalLink

org.docgene.model.XMLArchiveURL

All Implemented Interfaces:

ElementReference, ExternalLink, ParagraphElement, StyledElement, URLLinkElement

public class XMLArchiveURL
extends XMLExternalLink

Represent an external link (to a web page or a local file).

Since:

1.6.6

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
XMLArchiveURL()

Method Summary

Modifier and Type	Method and Description
void	bind(java.lang.String urlS, java.net.URL url) Bind an URL for the link.
void	bind(java.lang.String urlS, java.net.URL url, boolean isAbsolute) Bind an URL for the link.
java.net.URL	constructRequestURL() Construct the request to ask for the file in the archive.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.net.URL	getNotNullURL() Return a not null link URL.
java.lang.String	getOriginalLink() Return the original article link.
java.lang.String	getOriginalLink(java.lang.String urlS) Return the original article link.
long	getTimestamp() Return the time stamp.
boolean	hasTimestamp() Return true if there is a timestamp.
void	setOriginalLink(java.lang.String urlS) Set the original article link.

Methods inherited from class org.docgene.model.XMLExternalLink

getPath, getText, getURL, getURLAsString, setText, setURL

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.ExternalLink

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

XMLArchiveURL

public XMLArchiveURL()

Method Detail

setOriginalLink

public void setOriginalLink(java.lang.String urlS)

Set the original article link.

Parameters:

urlS - the original article link

hasTimestamp

public boolean hasTimestamp()

Return true if there is a timestamp.

Returns:

true if there is a timestamp

getNotNullURL

public java.net.URL getNotNullURL()

Return a not null link URL. Defer by default to XMLExternalLink.getURL().

Returns:

the not null link URL

getOriginalLink

public java.lang.String getOriginalLink(java.lang.String urlS)

Return the original article link.

Parameters:

urlS - the url

Returns:

the original article link or null if the link pattern is invalid

constructRequestURL

public java.net.URL constructRequestURL()

Construct the request to ask for the file in the archive.

Returns:

the request

getTimestamp

public long getTimestamp()

Return the time stamp.

Returns:

the timestamp

getOriginalLink

public java.lang.String getOriginalLink()

Return the original article link.

Returns:

the original article link or null if the link pattern is invalid

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Specified by:

getDeclaration in interface StyledElement

Overrides:

getDeclaration in class XMLExternalLink

Returns:

the declaration ID of the element

bind

public void bind(java.lang.String urlS,
                 java.net.URL url,
                 boolean isAbsolute)

Bind an URL for the link.

Overrides:

bind in class XMLExternalLink

Parameters:

urlS - the URL as String

url - the URL

isAbsolute - true for an absolute URL

bind

public void bind(java.lang.String urlS,
                 java.net.URL url)

Bind an URL for the link.

Specified by:

bind in interface URLLinkElement

Overrides:

bind in class XMLExternalLink

Parameters:

urlS - the URL as String

url - the URL