Package org.opencms.workplace.tools.content

Class CmsTagReplaceSettings

java.lang.Object

org.opencms.workplace.tools.content.CmsTagReplaceSettings

public final class CmsTagReplaceSettings
extends Object

Bean to hold the settings needed for the operation of replacing HTML Tags of xmlpage resources in the OpenCms VFS.

Since:

6.1.7

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_CONTENTOOLS_TAGREPLACE	Property for the tag-replace contentool to know the files that have been processed before in case of early terminaton in previous runs.

Constructor Summary

Constructors

Constructor	Description
CmsTagReplaceSettings(org.opencms.file.CmsObject cms)	Bean constructor with cms object for path validation.

Method Summary

Modifier and Type	Method	Description
protected Set	getDeleteTags()	Returns the Set<Tag> to delete from transformed output.
String	getPropertyValueTagReplaceID()	Returns the value of the shared PROPERTY_CONTENTOOLS_TAGREPLACE to set on resources that have been processed with these settings.
SortedMap	getReplacements()	Returns the replacements to perform in form of a comma-separated List of "key=value" tokens.
String	getWorkPath()	Returns the path under which files will be processed recursively.
protected boolean	replace(org.htmlparser.Tag tag)	Transforms the given Tag into the one it has to become by changing it's name and/or attributes.
void	setPropertyValueTagReplaceID(String propertyValueTagreplaceID)	Sets the value of the shared PROPERTY_CONTENTOOLS_TAGREPLACE to set on resources that have been processed with these settings.
void	setReplacements(SortedMap replacements)	Sets the replacements to perform in form of a comma-separated List of "key=value" tokens.
void	setWorkPath(String workPath)	Sets the path under which files will be processed recursively.

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_CONTENTOOLS_TAGREPLACE

public static final String PROPERTY_CONTENTOOLS_TAGREPLACE

Property for the tag-replace contentool to know the files that have been processed before in case of early terminaton in previous runs.

See Also:

• Constant Field Values

Constructor Details

CmsTagReplaceSettings

public CmsTagReplaceSettings(org.opencms.file.CmsObject cms)

Bean constructor with cms object for path validation.

Parameters:

cms - used to test the working path for valididty.

Method Details

getPropertyValueTagReplaceID

public String getPropertyValueTagReplaceID()

Returns the value of the shared PROPERTY_CONTENTOOLS_TAGREPLACE to set on resources that have been processed with these settings.

Returns:

the value of the shared PROPERTY_CONTENTOOLS_TAGREPLACE to set on resources that have been processed with these settings.

getReplacements

public SortedMap getReplacements()

Returns the replacements to perform in form of a comma-separated List of "key=value" tokens.

Returns:

the replacements to perform in form of a comma-separated List of "key=value" tokens.

getWorkPath

public String getWorkPath()

Returns the path under which files will be processed recursively.

Returns:

the path under which files will be processed recursively.

setPropertyValueTagReplaceID

public void setPropertyValueTagReplaceID(String propertyValueTagreplaceID)
                                  throws org.opencms.main.CmsIllegalArgumentException

Sets the value of the shared PROPERTY_CONTENTOOLS_TAGREPLACE to set on resources that have been processed with these settings.

Parameters:

propertyValueTagreplaceID - the value of the shared PROPERTY_CONTENTOOLS_TAGREPLACE to set on resources that have been processed with these settings.

Throws:

org.opencms.main.CmsIllegalArgumentException - if the argument is not valid.

setReplacements

public void setReplacements(SortedMap replacements)
                     throws org.opencms.main.CmsIllegalArgumentException

Sets the replacements to perform in form of a comma-separated List of "key=value" tokens.

Parameters:

replacements - the replacements to perform in form of a comma-separated List of "key=value" tokens.

Throws:

org.opencms.main.CmsIllegalArgumentException - if the argument is not valid.

setWorkPath

public void setWorkPath(String workPath)
                 throws org.opencms.main.CmsIllegalArgumentException

Sets the path under which files will be processed recursively.

Parameters:

workPath - the path under which files will be processed recursively.

Throws:

org.opencms.main.CmsIllegalArgumentException - if the argument is not valid.

getDeleteTags

protected Set getDeleteTags()

Returns the Set<Tag> to delete from transformed output.

Returns:

the Set<Tag> to delete from transformed output.

replace

protected boolean replace(org.htmlparser.Tag tag)

Transforms the given Tag into the one it has to become by changing it's name and/or attributes.

Parameters:

tag - the tag to be transformed.

Returns:

true if the given tag was modified, false else.