org.docgene.help.utils

Class HistoryElement

java.lang.Object

org.docgene.help.utils.HistoryElement

public class HistoryElement
extends java.lang.Object

Represents an history element.

Field Summary

Fields

Modifier and Type	Field and Description
static char	TYPE_ARTICLE Represents an article.
static char	TYPE_PAGE Represents a page or resource.
static char	TYPE_SEARCH Represents a full text search result page.

Constructor Summary

Constructors

Constructor and Description
HistoryElement(java.net.URL url)
HistoryElement(java.net.URL url, char type)
HistoryElement(java.net.URL url, java.lang.String anchor)
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.
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	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

Field Detail

TYPE_ARTICLE

public static final char TYPE_ARTICLE

Represents an article.

See Also:

Constant Field Values

TYPE_PAGE

public static final char TYPE_PAGE

Represents a page or resource.

See Also:

Constant Field Values

TYPE_SEARCH

public static final char TYPE_SEARCH

Represents a full text search result page.

See Also:

Constant Field Values

Constructor Detail

HistoryElement

public HistoryElement(java.net.URL url)

HistoryElement

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

HistoryElement

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

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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