org.archive.wayback.util.htmllex

Class ParseContext

java.lang.Object

org.archive.wayback.util.htmllex.ParseContext

Direct Known Subclasses:

ReplayParseContext

public class ParseContext
extends Object

Class which tracks the context and state involved with parsing an HTML document via SAX events. Also holds some page URL information, and provides some URL resolving functionality. Lastly, this class exposes a general purpose HashMap for use by specific applications.

Version:

$Date$, $Revision$

Author:

brad

Field Summary

Fields

Modifier and Type	Field and Description
protected org.archive.url.UsableURI	baseUrl

Constructor Summary

Constructors

Constructor and Description
ParseContext() constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	contextualizeUrl(String url)
String	getData(String key) Retrieves previously stored data for key key from this ParseContext
Map<String,String>	getMap()
String	getOraclePolicy()
boolean	isInCSS()
boolean	isInHTML()
boolean	isInJS()
boolean	isInScriptText()
void	putData(String key, String value) Stores arbitrary key value pairs in this ParseContext
String	resolve(String url) Resolve possibly-relative url with baseUrl set to this object.
void	setBaseUrl(String baseURL)
void	setBaseUrl(URL url)
void	setInCSS(boolean inCSS)
void	setInHTML(boolean inHTML) set to true when any HTML open tag is found.
void	setInJS(boolean inJS)
void	setInScriptText(boolean inScriptText)
void	setOraclePolicy(String policy)

Methods inherited from class java.lang.Object

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

Field Detail

baseUrl

protected org.archive.url.UsableURI baseUrl

Constructor Detail

ParseContext

public ParseContext()

constructor

Method Detail

putData

public void putData(String key,
           String value)

Stores arbitrary key value pairs in this ParseContext

Parameters:

key - for storage

value - for storage

getData

public String getData(String key)

Retrieves previously stored data for key key from this ParseContext

Parameters:

key - under which value was stored

Returns:

previously stored value for key or null, if nothing was stored

getMap

public Map<String,String> getMap()

Returns:

the full Map of String to String for this parsing context.

setBaseUrl

public void setBaseUrl(String baseURL)

Parameters:

baseURL - an base URL for relative URLs

setBaseUrl

public void setBaseUrl(URL url)

Parameters:

url - against which relative URLs should be resolved for this parse

resolve

public String resolve(String url)
               throws URISyntaxException

Resolve possibly-relative url with baseUrl set to this object.

Caveat: this method no longer unescape HTML entities in url. HTML entities must be all unescaped before calling method.

Parameters:

url - which should be resolved

Returns:

absolute URL.

Throws:

URISyntaxException - if the input URL is malformed

contextualizeUrl

public String contextualizeUrl(String url)

Parameters:

url - which should be resolved.

Returns:

absolute form of input url, or url itself if javascript:

setInHTML

public void setInHTML(boolean inHTML)

set to true when any HTML open tag is found.

used for checking if the content really looks like an HTML document.

Parameters:

inHTML -

isInHTML

public boolean isInHTML()

isInCSS

public boolean isInCSS()

Returns:

the inCSS

setInCSS

public void setInCSS(boolean inCSS)

Parameters:

inCSS - the inCSS to set

isInJS

public boolean isInJS()

Returns:

the inJS

setInJS

public void setInJS(boolean inJS)

Parameters:

inJS - the inJS to set

isInScriptText

public boolean isInScriptText()

Returns:

the inScriptText

setInScriptText

public void setInScriptText(boolean inScriptText)

Parameters:

inScriptText - the inScriptText to set

getOraclePolicy

public String getOraclePolicy()

setOraclePolicy

public void setOraclePolicy(String policy)