org.archive.wayback.util.url

Class KeyMakerUrlCanonicalizer

java.lang.Object

org.archive.wayback.util.url.KeyMakerUrlCanonicalizer

All Implemented Interfaces:

UrlCanonicalizer

public class KeyMakerUrlCanonicalizer
extends Object
implements UrlCanonicalizer

UrlCanonicalizer which allows use of the SURT canonicalization code from archive-commons.

Author:

brad

Constructor Summary

Constructors

Constructor and Description
KeyMakerUrlCanonicalizer()
KeyMakerUrlCanonicalizer(boolean surtForm)

Method Summary

Methods

Modifier and Type	Method and Description
org.archive.url.URLKeyMaker	getKeyMaker()
boolean	isSurtForm() Returns true if this Canonicalizer returns SURTs, false is URLs
void	setKeyMaker(org.archive.url.URLKeyMaker keyMaker)
String	urlStringToKey(String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyMakerUrlCanonicalizer

public KeyMakerUrlCanonicalizer()

KeyMakerUrlCanonicalizer

public KeyMakerUrlCanonicalizer(boolean surtForm)

Method Detail

urlStringToKey

public String urlStringToKey(String url)
                      throws org.apache.commons.httpclient.URIException

Specified by:

urlStringToKey in interface UrlCanonicalizer

Parameters:

url - String representation of an URL, in as original, and unchanged form as possible.

Returns:

a lookup key appropriate for searching within a ResourceIndex.

Throws:

org.apache.commons.httpclient.URIException - if the input url String is not a valid URL.

getKeyMaker

public org.archive.url.URLKeyMaker getKeyMaker()

Returns:

the keyMaker

setKeyMaker

public void setKeyMaker(org.archive.url.URLKeyMaker keyMaker)

Parameters:

keyMaker - the keyMaker to set

isSurtForm

public boolean isSurtForm()

Description copied from interface: UrlCanonicalizer

Returns true if this Canonicalizer returns SURTs, false is URLs

Specified by:

isSurtForm in interface UrlCanonicalizer

Returns:

true if SURTs are returned false otherwise.