org.archive.wayback.replay.html.transformer

Class URLStringTransformer

java.lang.Object

org.archive.wayback.replay.html.transformer.URLStringTransformer

All Implemented Interfaces:

StringTransformer

Direct Known Subclasses:

MetaRefreshUrlStringTransformer

public class URLStringTransformer
extends Object
implements StringTransformer

StringTransformer for translating URLs.

input is a URL (strictly speaking, URI), typically from an HTML attribute.

As translation is simply delegated to ReplayParseContext passed to transform(org.archive.wayback.replay.html.ReplayParseContext, java.lang.String) method, this class is merely a holder of flags value representing a type of context pointed resource is used. This is necessary because StringTransformer interface does not allow for communicating this information to ReplayParseContext.contextualizeUrl(String, String).

It delegates translation to jsTransformer if given string is javascript:. This is used by FastArchivalUrlRelayParserEventHandler for rewriting HREF attributes.

Possible Refactoring:

• communicate flags information through ReplayParserContext?
• let FastArchivalUrlReplayParseEventHandler call contextualizeUrl(String, String) directly?
• move this class to non-static inner class of FastArchivalUrlReplayParseEventHandler. Perhaps it doesn't need to implement StringTransformer at all (sub-class MetaRefreshUrlStringTransformer needs separate rewrite.)

Author:

brad

See Also:

FastArchivalUrlReplayParseEventHandler, MetaRefreshUrlStringTransformer

Constructor Summary

Constructors

Constructor and Description
URLStringTransformer() Default constructor
URLStringTransformer(String flags) Flag-setting constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFlags()
StringTransformer	getJsTransformer()
void	setFlags(String flags)
void	setJsTransformer(StringTransformer jsTransformer) transformer for javascript: URIs.
String	transform(ReplayParseContext context, String url) transforms text with certain rewrite rules.

Methods inherited from class java.lang.Object

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

Constructor Detail

URLStringTransformer

public URLStringTransformer()

Default constructor

URLStringTransformer

public URLStringTransformer(String flags)

Flag-setting constructor.

Parameters:

flags - String representing how resource is used (ex. "im_", "cs_")

Method Detail

transform

public String transform(ReplayParseContext context,
               String url)

Description copied from interface: StringTransformer

transforms text with certain rewrite rules.

Refactoring: change input type to CharSequence.

Specified by:

transform in interface StringTransformer

Parameters:

context - ReplayParseContext

url - text data to be transformed

Returns:

transformed text

getFlags

public String getFlags()

Returns:

the flags

setFlags

public void setFlags(String flags)

Parameters:

flags - the flags to set

getJsTransformer

public StringTransformer getJsTransformer()

setJsTransformer

public void setJsTransformer(StringTransformer jsTransformer)

transformer for javascript: URIs.

if unspecified (null), javascript: URI is left unprocessed.

Parameters:

jsTransformer - StringTransformer