Package org.craftercms.engine.targeting.impl

Class TargetedUrlByFileStrategy

java.lang.Object

org.craftercms.engine.targeting.impl.AbstractTargetedUrlStrategy

org.craftercms.engine.targeting.impl.TargetedUrlByFileStrategy

All Implemented Interfaces:

TargetedUrlStrategy

public class TargetedUrlByFileStrategy
extends AbstractTargetedUrlStrategy

TargetedUrlStrategy implementation that recognizes the target ID in the file name (e.g. /products/index_es_CR.xml).

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_TARGET_ID_SEPARATOR
static int	PREFIX_GROUP
static int	SUFFIX_GROUP
static int	TARGET_ID_GROUP
static String	TARGETED_URL_REGEX_FORMAT
protected String	targetIdSeparator

Fields inherited from class org.craftercms.engine.targeting.impl.AbstractTargetedUrlStrategy

targetIdManager

Constructor Summary

Constructors

Constructor	Description
TargetedUrlByFileStrategy()

Method Summary

Modifier and Type	Method	Description
String	buildTargetedUrl(String prefix, String targetId, String suffix)	Builds the targeted URL with the specified prefix, target ID and suffix.
protected String	doToTargetedUrl(String url, String currentTargetId)
protected String	getPrefix(Matcher matcher)
protected String	getSuffix(Matcher matcher)
protected Pattern	getTargetedUrlPattern()
protected String	getTargetId(Matcher matcher)
boolean	isFileNameBasedStrategy()	Returns true if the strategy is based on the name of the file.
void	setTargetIdSeparator(String targetIdSeparator)

Methods inherited from class org.craftercms.engine.targeting.impl.AbstractTargetedUrlStrategy

getTargetedUrlComponents, matchUrl, parseTargetedUrl, setTargetIdManager, toTargetedUrl

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TARGET_ID_SEPARATOR

public static final String DEFAULT_TARGET_ID_SEPARATOR

See Also:

Constant Field Values

TARGETED_URL_REGEX_FORMAT

public static final String TARGETED_URL_REGEX_FORMAT

See Also:

Constant Field Values

PREFIX_GROUP

public static final int PREFIX_GROUP

See Also:

Constant Field Values

TARGET_ID_GROUP

public static final int TARGET_ID_GROUP

See Also:

Constant Field Values

SUFFIX_GROUP

public static final int SUFFIX_GROUP

See Also:

Constant Field Values

targetIdSeparator

protected String targetIdSeparator

Constructor Detail

TargetedUrlByFileStrategy

public TargetedUrlByFileStrategy()

Method Detail

setTargetIdSeparator

public void setTargetIdSeparator(String targetIdSeparator)

isFileNameBasedStrategy

public boolean isFileNameBasedStrategy()

Description copied from interface: TargetedUrlStrategy

Returns true if the strategy is based on the name of the file.

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

Overrides:

buildTargetedUrl in class AbstractTargetedUrlStrategy

Parameters:

prefix - the URL prefix

targetId - the target ID

suffix - the URL suffix

Returns:

the built targeted URL

getPrefix

protected String getPrefix(Matcher matcher)

Specified by:

getPrefix in class AbstractTargetedUrlStrategy

getTargetId

protected String getTargetId(Matcher matcher)

Specified by:

getTargetId in class AbstractTargetedUrlStrategy

getSuffix

protected String getSuffix(Matcher matcher)

Specified by:

getSuffix in class AbstractTargetedUrlStrategy

getTargetedUrlPattern

protected Pattern getTargetedUrlPattern()

Specified by:

getTargetedUrlPattern in class AbstractTargetedUrlStrategy

doToTargetedUrl

protected String doToTargetedUrl(String url,
                                 String currentTargetId)

Specified by:

doToTargetedUrl in class AbstractTargetedUrlStrategy