Package org.opencms.file.types

Class CmsResourceTypeFolderSubSitemap

java.lang.Object

org.opencms.file.types.A_CmsResourceType

org.opencms.file.types.A_CmsResourceTypeFolderBase

org.opencms.file.types.CmsResourceTypeFolderExtended

org.opencms.file.types.CmsResourceTypeFolderSubSitemap

All Implemented Interfaces:

Serializable, I_CmsConfigurationParameterHandler, I_CmsResourceType

public class CmsResourceTypeFolderSubSitemap
extends CmsResourceTypeFolderExtended

Resource type descriptor for sub site map folder types.

This type extends an extended folder with a configurable type id and type name.

Since:

8.5.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencms.file.types.I_CmsResourceType

I_CmsResourceType.Formatter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_SUBSITEMAP	The type name for subsitemaps.

Fields inherited from class org.opencms.file.types.CmsResourceTypeFolderExtended

CONFIGURATION_FOLDER_CLASS, CONFIGURATION_FOLDER_CLASS_PARAMS

Fields inherited from class org.opencms.file.types.A_CmsResourceTypeFolderBase

ATTR_SHALLOW_FOLDER_COPY

Fields inherited from class org.opencms.file.types.A_CmsResourceType

CONFIGURATION_GALLERY_JAVASCRIPT_PATH, CONFIGURATION_GALLERY_PREVIEW_PROVIDER, CONFIGURATION_GALLERY_TYPE_NAMES, CONFIGURATION_INTERNAL, DEFAULT_GALLERY_PREVIEW_PROVIDER, m_addititionalModuleResourceType, m_className, m_configuration, m_copyResources, m_defaultProperties, m_frozen, m_galleryPreviewProvider, m_mappings, m_moduleName, m_typeId, m_typeName, MACRO_RESOURCE_FOLDER_PATH, MACRO_RESOURCE_FOLDER_PATH_TOUCH, MACRO_RESOURCE_NAME, MACRO_RESOURCE_PARENT_PATH, MACRO_RESOURCE_ROOT_PATH, MACRO_RESOURCE_SITE_PATH

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Fields inherited from interface org.opencms.file.types.I_CmsResourceType

ADD_MAPPING_METHOD, ADD_RESOURCE_TYPE_METHOD, CONFIGURATION_PROPERTY_CREATE, CONFIGURATION_RESOURCE_TYPE_ID, CONFIGURATION_RESOURCE_TYPE_NAME, PROPERTY_ON_RESOURCE, PROPERTY_ON_STRUCTURE

Constructor Summary

Constructors

Constructor	Description
CmsResourceTypeFolderSubSitemap()

Method Summary

Modifier and Type	Method	Description
static List<Integer>	getSubSitemapResourceTypeIds()	Returns the registered sub site map resource type id's.
void	initConfiguration(String name, String id, String className)	Special version of the configuration initialization used with resource types to set resource type, id and class name, required for the XML configuration.
static boolean	isSubSitemap(CmsResource resource)	Returns true in case the given resource is a sub site map.
static boolean	isSubSitemapTypeId(int typeId)	Returns true in case the given resource type id is a sub site map type.

Methods inherited from class org.opencms.file.types.CmsResourceTypeFolderExtended

addConfigurationParameter, getConfiguration, getFolderClassName, getFolderClassParams

Methods inherited from class org.opencms.file.types.A_CmsResourceTypeFolderBase

chtype, copyResource, createResource, getLoaderId, isFolder, moveResource, replaceResource, setDateExpired, setDateLastModified, setDateReleased, undelete, undoChanges

Methods inherited from class org.opencms.file.types.A_CmsResourceType

addCopyResource, addDefaultProperty, addMappingType, changeLock, chflags, chtype, copyResourceToProject, createRelations, createSibling, deleteResource, equals, getAdjustLinksFolder, getCachePropertyDefault, getClassName, getConfiguredCopyResources, getConfiguredDefaultProperties, getConfiguredMappings, getCopyResources, getFormattersForResource, getGalleryPreviewProvider, getGalleryTypes, getMacroResolver, getModuleName, getResourceType, getTypeId, getTypeName, hashCode, importResource, initConfiguration, initialize, isAdditionalModuleResourceType, isDirectEditable, isIdentical, lockResource, processCopyResources, processDefaultProperties, removeResourceFromProject, replaceResource, restoreResource, setAdditionalModuleResourceType, setAdjustLinksFolder, setModuleName, toString, unlockResource, updateRelationForUndo, writeFile, writePropertyObject, writePropertyObjects

Methods inherited from class java.lang.Object

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

Field Details

TYPE_SUBSITEMAP

public static final String TYPE_SUBSITEMAP

The type name for subsitemaps.

See Also:

• Constant Field Values

Constructor Details

CmsResourceTypeFolderSubSitemap

public CmsResourceTypeFolderSubSitemap()

Method Details

getSubSitemapResourceTypeIds

public static List<Integer> getSubSitemapResourceTypeIds()

Returns the registered sub site map resource type id's.

Returns:

the resource type id's

isSubSitemap

public static boolean isSubSitemap(CmsResource resource)

Returns true in case the given resource is a sub site map.

Internally this checks if the given resource type has an id that is registered as a sub site map resource type.

Parameters:

resource - the resource to check

Returns:

true in case the given resource is a sub site map

Since:

8.0.0

isSubSitemapTypeId

public static boolean isSubSitemapTypeId(int typeId)

Returns true in case the given resource type id is a sub site map type.

Internally this checks if the given resource type id is registered as a sub site map resource type.

Parameters:

typeId - the resource type id to check

Returns:

true in case the given resource type id is a sub site map type

Since:

8.0.0

initConfiguration

public void initConfiguration(String name,
 String id,
 String className)
                       throws CmsConfigurationException

Description copied from interface: I_CmsResourceType

Special version of the configuration initialization used with resource types to set resource type, id and class name, required for the XML configuration.

Please note: Many resource types defined in the core have in fact a fixed resource type and a fixed id. Configurable name and id is used only for certain types.

The provided named class must implement this interface (I_CmsResourceType). Usually the provided class name should be the class name of the resource type instance, but this may be different in special cases or configuration errors. For example, if a module is imported that contains it's own resource type class files, the included class file are usually not be available until the server is restarted. If the named class given in the XML configuration (or module manifest.xml) is not available, or not implementing I_CmsResourceType, then CmsResourceTypeUnknown is used for the resource type instance.

Specified by:

initConfiguration in interface I_CmsResourceType

Overrides:

initConfiguration in class A_CmsResourceType

Parameters:

name - the resource type name

id - the resource type id

className - the class name of the resource type (read from the XML configuration)

Throws:

CmsConfigurationException - if the configuration is invalid

See Also:

• A_CmsResourceType.initConfiguration(java.lang.String, java.lang.String, String)