org.opencms.jsp

Class CmsJspResourceWrapper

java.lang.Object

org.opencms.file.CmsResource

org.opencms.jsp.CmsJspResourceWrapper

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<I_CmsResource>, I_CmsResource

public class CmsJspResourceWrapper
extends CmsResource

Wrapper subclass of CmsResource with some convenience methods.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.file.CmsResource

CmsResource.CmsResourceCopyMode, CmsResource.CmsResourceDeleteMode, CmsResource.CmsResourceUndoMode

Nested classes/interfaces inherited from interface org.opencms.file.I_CmsResource

I_CmsResource.CmsResourceAttribute

Field Summary

Fields inherited from class org.opencms.file.CmsResource

COPY_AS_NEW, COPY_AS_SIBLING, COPY_PRESERVE_SIBLING, DATE_EXPIRED_DEFAULT, DATE_RELEASED_DEFAULT, DATE_RELEASED_EXPIRED_IGNORE, DELETE_PRESERVE_SIBLINGS, DELETE_REMOVE_SIBLINGS, FLAG_INTERNAL, FLAG_LABELED, FLAG_TEMPFILE, m_dateContent, m_length, NAME_CONSTRAINTS, STATE_CHANGED, STATE_DELETED, STATE_KEEP, STATE_NEW, STATE_UNCHANGED, TEMP_FILE_PREFIX, TOUCH_DATE_UNCHANGED, UNDO_CONTENT, UNDO_CONTENT_RECURSIVE, UNDO_MOVE_CONTENT, UNDO_MOVE_CONTENT_RECURSIVE, VFS_FOLDER_SITES, VFS_FOLDER_SYSTEM

Fields inherited from interface org.opencms.file.I_CmsResource

COMPARE_DATE_LAST_MODIFIED, COMPARE_DATE_RELEASED, COMPARE_ROOT_PATH, COMPARE_ROOT_PATH_IGNORE_CASE, COMPARE_ROOT_PATH_IGNORE_CASE_FOLDERS_FIRST

Constructor Summary

Constructors

Constructor and Description
CmsJspResourceWrapper(CmsObject cms, CmsResource res) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLink() Gets a link to the resource.
java.util.Map<java.lang.String,CmsJspResourceWrapper>	getLocaleResource() Gets a map of the locale group for the current resource, with locale strings as keys.
java.util.Locale	getMainLocale() Gets the main locale for this resource.

Methods inherited from class org.opencms.file.CmsResource

checkResourceName, clone, compareTo, equals, getCopy, getDateContent, getDateCreated, getDateExpired, getDateLastModified, getDateReleased, getFlags, getFolderPath, getLength, getName, getName, getParentFolder, getPathLevel, getPathPart, getProjectLastModified, getResourceId, getRootPath, getSiblingCount, getState, getStructureId, getTypeId, getUserCreated, getUserLastModified, getVersion, hashCode, isExpired, isFile, isFolder, isFolder, isInternal, isLabeled, isReleased, isReleasedAndNotExpired, isTemporaryFile, isTemporaryFileName, isTouched, setDateExpired, setDateLastModified, setDateReleased, setFlags, setInternal, setState, setType, setUserLastModified, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CmsJspResourceWrapper

public CmsJspResourceWrapper(CmsObject cms,
                             CmsResource res)

Creates a new instance.

Parameters:

cms - the current CMS context

res - the resource to wrap

Method Detail

getLink

public java.lang.String getLink()

Gets a link to the resource.

Returns:

the link

getLocaleResource

public java.util.Map<java.lang.String,CmsJspResourceWrapper> getLocaleResource()

Gets a map of the locale group for the current resource, with locale strings as keys.

Returns:

a map with locale strings as keys and resource wrappers for the corresponding locale variants

getMainLocale

public java.util.Locale getMainLocale()

Gets the main locale for this resource.

Returns:

the main locale for this resource