org.opencms.staticexport
Class CmsStaticExportRfsRule

java.lang.Object
  org.opencms.staticexport.CmsStaticExportRfsRule

public class CmsStaticExportRfsRule
extends Object

Help class for storing of rfs-rules..

Since:

6.0.0

Version:

$Revision: 1.2 $

Author:

Michael Moossen

Constructor Summary

CmsStaticExportRfsRule(String name, String description, String source, String rfsPrefix, String exportPath, Boolean useRelativeLinks)
Default constructor.

CmsStaticExportRfsRule(String name, String description, String source, String rfsPrefix, String exportPath, Boolean useRelativeLinks, List relatedSystemRes)
Full constructor.

Method Summary

void	addRelatedSystemRes(String regex) Adds a regex of related system resources.
String	getDescription() Returns the description.
String	getExportPath() Returns the rfs export Path.
String	getExportPathConfigured() Returns the configured rfs export Path with unstubstituted context values.
String	getName() Returns the name.
List	getRelatedSystemResources() Returns the related system resources list as list of Pattern.
String	getRfsPrefix() Returns the url Prefix with macro replacement.
String	getRfsPrefixConfigured() Returns the configured url Prefix with unstubstituted context values.
Pattern	getSource() Returns the source regex pattern.
Boolean	getUseRelativeLinks() Returns true if the links in the static export should be relative.
boolean	match(String vfsName) Checks if a vfsName matches the given related system resource patterns.
void	setExportPath(String exportPath) Sets the rfs export Path after normalizing.
void	setRfsPrefix(String rfsPrefix) Sets the url Prefix after normalizing.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsStaticExportRfsRule

public CmsStaticExportRfsRule(String name,
                              String description,
                              String source,
                              String rfsPrefix,
                              String exportPath,
                              Boolean useRelativeLinks)

Default constructor.

Parameters:

name - the name of the rule

description - the description for the rule

source - the source regex

rfsPrefix - the url prefix

exportPath - the rfs export path

useRelativeLinks - Relative links value

CmsStaticExportRfsRule

public CmsStaticExportRfsRule(String name,
                              String description,
                              String source,
                              String rfsPrefix,
                              String exportPath,
                              Boolean useRelativeLinks,
                              List relatedSystemRes)

Full constructor.

Parameters:

name - the name of the rule

description - the description for the rule

source - the source regex

rfsPrefix - the url prefix

exportPath - the rfs export path

useRelativeLinks - Relative links value

relatedSystemRes - list of Patterns

Method Detail

addRelatedSystemRes

public void addRelatedSystemRes(String regex)

Adds a regex of related system resources.

Parameters:

regex - the regex to add

getDescription

public String getDescription()

Returns the description.

Returns:

the description

getExportPath

public String getExportPath()

Returns the rfs export Path.

Returns:

the rfs export Path

getExportPathConfigured

public String getExportPathConfigured()

Returns the configured rfs export Path with unstubstituted context values.

Returns:

the configured rfs export Path

getName

public String getName()

Returns the name.

Returns:

the name

getRelatedSystemResources

public List getRelatedSystemResources()

Returns the related system resources list as list of Pattern.

Returns:

the related resources list as list of Pattern

getRfsPrefix

public String getRfsPrefix()

Returns the url Prefix with macro replacement.

Returns:

the url Prefix

getRfsPrefixConfigured

public String getRfsPrefixConfigured()

Returns the configured url Prefix with unstubstituted context values.

Returns:

the configured url Prefix

getSource

public Pattern getSource()

Returns the source regex pattern.

Returns:

the source regex pattern

getUseRelativeLinks

public Boolean getUseRelativeLinks()

Returns true if the links in the static export should be relative.

Returns:

true if the links in the static export should be relative

match

public boolean match(String vfsName)

Checks if a vfsName matches the given related system resource patterns.

Parameters:

vfsName - the vfs name of a resource to check

Returns:

true if the name matches one of the given related system resource patterns

setExportPath

public void setExportPath(String exportPath)

Sets the rfs export Path after normalizing.

Parameters:

exportPath - the rfs export Path to set

setRfsPrefix

public void setRfsPrefix(String rfsPrefix)

Sets the url Prefix after normalizing.

Parameters:

rfsPrefix - the url Prefix to set

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()