org.docgene.help.utils

Class HistoryElement

java.lang.Object

org.docgene.help.utils.HistoryElement

All Implemented Interfaces:

PageType

public class HistoryElement
extends java.lang.Object
implements PageType

Represents an history element.

Field Summary

Fields inherited from interface org.docgene.help.utils.PageType

TYPE_ARTICLE, TYPE_PAGE, TYPE_SEARCH

Constructor Summary

Constructors

Constructor and Description
HistoryElement(Article article, java.net.URL url) Constructor for an article.
HistoryElement(Article article, java.net.URL url, java.lang.String anchor) Constructor for an article.
HistoryElement(java.lang.String content, char type) Constructor for a String content.
HistoryElement(java.net.URL url, char type) Constructor for a page.
HistoryElement(java.net.URL url, java.lang.String anchor, char type)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAnchor() Return the element anchor.
Article	getArticle() Return the article aéssociated with the element (can be null).
java.lang.String	getContent() Return the element content (used for the full text search page).
java.net.URL	getURL() Return the element URL.
boolean	hasAnchor() Return true if the element has an anchor.
boolean	isArticle() Return true if this is an article.
boolean	isResourcePage() Return true if this is a resource page.
boolean	isSearchPage() Return true if this is a search page.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryElement

public HistoryElement(Article article,
                      java.net.URL url)

Constructor for an article.

Parameters:

article - the article

url - the article URL

HistoryElement

public HistoryElement(Article article,
                      java.net.URL url,
                      java.lang.String anchor)

Constructor for an article.

Parameters:

article - the article

url - the article URL

anchor - the anchor on the article

HistoryElement

public HistoryElement(java.net.URL url,
                      char type)

Constructor for a page.

Parameters:

url - the URL

type - the page type

HistoryElement

public HistoryElement(java.lang.String content,
                      char type)

Constructor for a String content.

Parameters:

content - the String content

type - the page type

HistoryElement

public HistoryElement(java.net.URL url,
                      java.lang.String anchor,
                      char type)

Method Detail

isArticle

public boolean isArticle()

Return true if this is an article.

Returns:

true if this is an article

isSearchPage

public boolean isSearchPage()

Return true if this is a search page.

Returns:

true if this is a search page

isResourcePage

public boolean isResourcePage()

Return true if this is a resource page.

Returns:

true if this is a resource page

getArticle

public Article getArticle()

Return the article aéssociated with the element (can be null).

Returns:

the article

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getContent

public java.lang.String getContent()

Return the element content (used for the full text search page).

Returns:

the content

getURL

public java.net.URL getURL()

Return the element URL.

Returns:

the URL

hasAnchor

public boolean hasAnchor()

Return true if the element has an anchor.

Returns:

true if the element has an anchor

getAnchor

public java.lang.String getAnchor()

Return the element anchor.

Returns:

the anchor