org.craftercms.engine.targeting.impl

Class AbstractTargetedUrlStrategy

java.lang.Object

org.craftercms.engine.targeting.impl.AbstractTargetedUrlStrategy

All Implemented Interfaces:

TargetedUrlStrategy

Direct Known Subclasses:

TargetedUrlByFileStrategy, TargetedUrlByFolderStrategy

public abstract class AbstractTargetedUrlStrategy
extends Object
implements TargetedUrlStrategy

TargetedUrlStrategy base class, that provides basic implementations of parseTargetedUrl(String) and buildTargetedUrl(String, String, String).

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field and Description
protected TargetIdManager	targetIdManager

Constructor Summary

Constructors

Constructor and Description
AbstractTargetedUrlStrategy()

Method Summary

Modifier and Type	Method and Description
String	buildTargetedUrl(String prefix, String targetId, String suffix) Builds the targeted URL with the specified prefix, target ID and suffix.
protected abstract String	doToTargetedUrl(String url, String currentTargetId)
protected abstract String	getPrefix(Matcher matcher)
protected abstract String	getSuffix(Matcher matcher)
protected TargetedUrlComponents	getTargetedUrlComponents(Matcher matcher)
protected abstract Pattern	getTargetedUrlPattern()
protected abstract String	getTargetId(Matcher matcher)
protected Matcher	matchUrl(String url)
TargetedUrlComponents	parseTargetedUrl(String targetedUrl) Parses the specified targeted URL, extracting it's components.
void	setTargetIdManager(TargetIdManager targetIdManager)
String	toTargetedUrl(String url, boolean forceCurrentTargetId) Returns the specified URL as a targeted URL (if it's not already a targeted URL) using the current target ID.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.craftercms.engine.targeting.TargetedUrlStrategy

isFileNameBasedStrategy

Field Detail

targetIdManager

protected TargetIdManager targetIdManager

Constructor Detail

AbstractTargetedUrlStrategy

public AbstractTargetedUrlStrategy()

Method Detail

setTargetIdManager

public void setTargetIdManager(TargetIdManager targetIdManager)

toTargetedUrl

public String toTargetedUrl(String url,
                            boolean forceCurrentTargetId)

Description copied from interface: TargetedUrlStrategy

Returns the specified URL as a targeted URL (if it's not already a targeted URL) using the current target ID. For example, if the specified URL is /products/index.xml, the current target ID is "en_US", and the strategy handles targeted URLs by file name, then the resulting targeted URL is /products/index_en_US.xml.

WARNING: The URLs strategies should receive should be relative, without the root folder, since most targeted URLs are handled using a regex.

Specified by:

toTargetedUrl in interface TargetedUrlStrategy

Parameters:

url - the URL to transform to a targeted URL

forceCurrentTargetId - true if the URL should be forced to contain the current target ID (e.g the URL is /products/index_fr.xml but the current target ID is en, then the URL will be transformed to /products/index_en.xml)

Returns:

the targeted URL version of the URL.

parseTargetedUrl

public TargetedUrlComponents parseTargetedUrl(String targetedUrl)

Description copied from interface: TargetedUrlStrategy

Parses the specified targeted URL, extracting it's components. For example, if the specified URL is /products/index_en_US.xml, and the strategy handles targeted URLs by file name, then the URL will be split into the following:

• Prefix: /products/index
• Target ID: en_US
• Suffix: .xml

Specified by:

parseTargetedUrl in interface TargetedUrlStrategy

Parameters:

targetedUrl - the targeted URL to parse

Returns:

the URL components

buildTargetedUrl

public String buildTargetedUrl(String prefix,
                               String targetId,
                               String suffix)

Description copied from interface: TargetedUrlStrategy

Builds the targeted URL with the specified prefix, target ID and suffix. For example, if the prefix is /products/index, the target ID en_US, the suffix .xml, and the strategy handles targeted URLs by file name, then the resulting URL will be /products/index_en_US.xml.

Specified by:

buildTargetedUrl in interface TargetedUrlStrategy

Parameters:

prefix - the URL prefix

targetId - the target ID

suffix - the URL suffix

Returns:

the built targeted URL

matchUrl

protected Matcher matchUrl(String url)

getTargetedUrlComponents

protected TargetedUrlComponents getTargetedUrlComponents(Matcher matcher)

getPrefix

protected abstract String getPrefix(Matcher matcher)

getTargetId

protected abstract String getTargetId(Matcher matcher)

getSuffix

protected abstract String getSuffix(Matcher matcher)

getTargetedUrlPattern

protected abstract Pattern getTargetedUrlPattern()

doToTargetedUrl

protected abstract String doToTargetedUrl(String url,
                                          String currentTargetId)