Package org.opencms.workplace.tools.content.convertxml

Class CmsConvertXmlSettings

java.lang.Object

org.opencms.workplace.tools.content.convertxml.CmsConvertXmlSettings

public final class CmsConvertXmlSettings
extends Object

Bean to hold the settings needed for the operation of converting xml files in the OpenCms VFS.

Since:

7.0.5

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
CmsConvertXmlSettings(org.opencms.file.CmsObject cms)	Bean constructor with cms object for path validation.

Method Summary

Modifier and Type	Method	Description
boolean	getIncludeSubFolders()	Gets if also files in sub folders shall become processed.
boolean	getOnlyCountFiles()	Gets if only count files to transform.
int	getResourceType()	Gets resource type to transform.
String	getVfsFolder()	Returns the path under which files will be processed.
String	getXslFile()	Gets path to xsl file.
void	setIncludeSubFolders(boolean subFolders)	Sets value if also process files in sub folders.
void	setOnlyCountFiles(boolean countFiles)	Sets if only count files to transform.
void	setResourceType(int resourceType)	Sets resource type to transform.
void	setVfsFolder(String vfsFolder)	Sets vfs folder to process files in.
void	setXslFile(String xslFile)	Sets path to xsl file.

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

CmsConvertXmlSettings

public CmsConvertXmlSettings(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

getResourceType

public int getResourceType()

Gets resource type to transform.

Returns:

Resource type to transform.

getIncludeSubFolders

public boolean getIncludeSubFolders()

Gets if also files in sub folders shall become processed.

Returns:

if also files in sub folders shall become processed.

getOnlyCountFiles

public boolean getOnlyCountFiles()

Gets if only count files to transform.

Returns:

If only count files to transform.

getVfsFolder

public String getVfsFolder()

Returns the path under which files will be processed.

Returns:

the path under which files will be processed.

getXslFile

public String getXslFile()

Gets path to xsl file.

Returns:

Path to xsl file.

setResourceType

public void setResourceType(int resourceType)
                     throws org.opencms.main.CmsIllegalArgumentException

Sets resource type to transform.

Parameters:

resourceType - File format to transform

Throws:

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

setIncludeSubFolders

public void setIncludeSubFolders(boolean subFolders)
                          throws org.opencms.main.CmsIllegalArgumentException

Sets value if also process files in sub folders.

Parameters:

subFolders - True if process sub folders, too

Throws:

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

setOnlyCountFiles

public void setOnlyCountFiles(boolean countFiles)
                       throws org.opencms.main.CmsIllegalArgumentException

Sets if only count files to transform.

Parameters:

countFiles - True, if only count files to transform

Throws:

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

setVfsFolder

public void setVfsFolder(String vfsFolder)
                  throws org.opencms.main.CmsIllegalArgumentException

Sets vfs folder to process files in.

Parameters:

vfsFolder - The vfs folder to process files in

Throws:

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

setXslFile

public void setXslFile(String xslFile)
                throws org.opencms.main.CmsIllegalArgumentException

Sets path to xsl file.

Parameters:

xslFile - Path to xsl file

Throws:

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