Package org.opencms.db

Class CmsRewriteAlias

java.lang.Object

org.opencms.db.CmsRewriteAlias

public class CmsRewriteAlias
extends Object

This class represents an alias which does not just map a fixed path to a fixed resource, but instead uses a regular expression substitution to determine the target path.

Constructor Summary

Constructors

Constructor	Description
CmsRewriteAlias(CmsUUID id, String siteRoot, String patternString, String replacementString, CmsAliasMode mode)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
CmsUUID	getId()	Gets the id of the alias.
CmsAliasMode	getMode()	Gets the alias mode.
String	getPatternString()	Gets the regular expression string.
String	getReplacementString()	Gets the string used to replace the string matching the regex.
String	getSiteRoot()	Gets the root of the site in which this alias is valid.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsRewriteAlias

public CmsRewriteAlias(CmsUUID id,
 String siteRoot,
 String patternString,
 String replacementString,
 CmsAliasMode mode)

Creates a new instance.

Parameters:

id - the id of the alias

siteRoot - the site root inside which the alias is valid

patternString - the regular expression used for matching the URI

replacementString - the replacement string used when the URI is matched

mode - the alias mode

Method Details

getId

public CmsUUID getId()

Gets the id of the alias.

Returns:

the id of the alias

getMode

public CmsAliasMode getMode()

Gets the alias mode.

Returns:

the alias mode

getPatternString

public String getPatternString()

Gets the regular expression string.

Returns:

the regular expression string

getReplacementString

public String getReplacementString()

Gets the string used to replace the string matching the regex.

Returns:

the replacement string

getSiteRoot

public String getSiteRoot()

Gets the root of the site in which this alias is valid.

Returns:

the site root