org.docgene.help.model

Class Article

java.lang.Object

org.docgene.help.model.Article

public class Article
extends java.lang.Object

Represents an article.

Constructor Summary

Constructors

Constructor and Description
Article(java.lang.String name, java.lang.String desc, java.net.URL url) Constructor.
Article(java.net.URL url) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAltTitle(java.lang.String altTitle) Add an alternate title to the article.
void	addAnchor(java.lang.String anchorName, java.lang.String anchorID) Add an anchor to the article.
void	addTitle(java.lang.String titleName, java.lang.String titleID) Add a title to the article.
java.util.Set<java.lang.String>	getAltTitles() Return the alternate titles.
java.util.Map<java.lang.String,java.lang.String>	getAnchors() Return the article anchors.
java.lang.String	getDescription() Return the article description.
java.lang.String	getHeader() Return the article header.
java.lang.String	getName() Return the article name.
java.util.Map<java.lang.String,java.lang.String>	getTitles() Return the article titles.
java.net.URL	getURL() Return the article URL.
java.lang.String	getURLAsString() Return the article URL as a String.
void	setHeader(java.lang.String header) Set the article header.

Methods inherited from class java.lang.Object

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

Constructor Detail

Article

public Article(java.net.URL url)

Constructor.

Parameters:

url - the article URL

Article

public Article(java.lang.String name,
               java.lang.String desc,
               java.net.URL url)

Constructor.

Parameters:

name - the article name

desc - the article description

url - the article URL

Method Detail

getDescription

public java.lang.String getDescription()

Return the article description.

Returns:

the article description

setHeader

public void setHeader(java.lang.String header)

Set the article header.

Parameters:

header - the article header

getHeader

public java.lang.String getHeader()

Return the article header.

Returns:

the article header

getName

public java.lang.String getName()

Return the article name.

Returns:

the article name

getURL

public java.net.URL getURL()

Return the article URL.

Returns:

the article URL

getURLAsString

public java.lang.String getURLAsString()

Return the article URL as a String.

Returns:

the article URL as a String

addAltTitle

public void addAltTitle(java.lang.String altTitle)

Add an alternate title to the article.

Parameters:

altTitle - the alternate title

getAltTitles

public java.util.Set<java.lang.String> getAltTitles()

Return the alternate titles.

Returns:

the alternate titles

addTitle

public void addTitle(java.lang.String titleName,
                     java.lang.String titleID)

Add a title to the article.

Parameters:

titleName - the title name

titleID - the title ID

getTitles

public java.util.Map<java.lang.String,java.lang.String> getTitles()

Return the article titles.

Returns:

the titles

addAnchor

public void addAnchor(java.lang.String anchorName,
                      java.lang.String anchorID)

Add an anchor to the article.

Parameters:

anchorName - the anchor name

anchorID - the anchor ID

getAnchors

public java.util.Map<java.lang.String,java.lang.String> getAnchors()

Return the article anchors.

Returns:

the anchors