org.opencms.staticexport.CmsStaticExportData Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.staticexport;
import org.opencms.file.CmsResource;
/**
* Provides a data structure for the result of an export request.
*
* @since 6.0.0
*/
public class CmsStaticExportData {
/** Flag to indicate whether this is the export data for a detail page. */
private boolean m_isDetailPage;
/** The parameters. */
private String m_parameters;
/** The resource to export. */
private CmsResource m_resource;
/** The uri to export in the rfs. */
private String m_rfsName;
/** The uri in the vfs. */
private String m_vfsName;
/**
* Creates a new static export data object.
*
* @param vfsName the vfs name of the resource
* @param rfsName the rfs name of the resource
* @param resource the resource object
* @param parameters the parameter string of a resource
*/
public CmsStaticExportData(String vfsName, String rfsName, CmsResource resource, String parameters) {
m_vfsName = vfsName;
m_rfsName = rfsName;
m_resource = resource;
m_parameters = parameters;
}
/**
* Return the parameters of the resource to export.
*
* @return the parameter map
*/
public String getParameters() {
return m_parameters;
}
/**
* Returns the resource to export.
*
* @return the resource to export
*/
public CmsResource getResource() {
return m_resource;
}
/**
* Returns the rfs name of the resource to export.
*
* @return the rfs name of the resource to export
*/
public String getRfsName() {
return m_rfsName;
}
/**
* Returns the vfs name of the resource to export.
*
* @return the vfs name of the resource to export
*/
public String getVfsName() {
return m_vfsName;
}
/**
* Returns true if this is the static export data for a detail page.
*
* @return true if this is the static export data for a detail page
*/
public boolean isDetailPage() {
return m_isDetailPage;
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuffer result = new StringBuffer();
result.append(this.getClass().getName());
result.append("[vfsName=");
result.append(m_vfsName);
result.append(", rfsName=");
result.append(m_rfsName);
if (m_resource != null) {
result.append(", structureId=");
result.append(m_resource.getStructureId());
}
result.append("]");
return result.toString();
}
/**
* Changes the 'is detail page' flag in this export data instance.
*
* @param isDetailPage the new value for the flag
*/
protected void setIsDetailPage(boolean isDetailPage) {
m_isDetailPage = isDetailPage;
}
/**
* Sets the parameters.
*
* @param parameters the parameters to set
*/
protected void setParameters(String parameters) {
m_parameters = parameters;
}
/**
* Sets the RFS name.
*
* @param rfsName the RFS name to set
*/
protected void setRfsName(String rfsName) {
m_rfsName = rfsName;
}
}