org.opencms.workplace.list

类 A_CmsListResourceCollector

java.lang.Object

org.opencms.workplace.list.A_CmsListResourceCollector

所有已实现的接口:

java.lang.Comparable<I_CmsResourceCollector>, I_CmsResourceCollector, I_CmsListResourceCollector

直接已知子类:

CmsContentCheckCollector, CmsDeleteBrokenRelationsCollector, CmsInternalLinkValidationFilesCollector, CmsListResourceLinkRelationCollector, CmsLockedResourcesCollector, CmsNewResourceXmlContentModelCollector, CmsProjectFilesCollector, CmsPublishBrokenRelationsCollector, CmsSearchResourcesCollector, CmsShowOrgUnitResourcesCollector, CmsSourceSearchCollector

public abstract class A_CmsListResourceCollector
extends java.lang.Object
implements I_CmsListResourceCollector

Collector to provide CmsResource objects for a explorer List.

从以下版本开始:

6.1.0

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	m_collectorParameter The collector parameter.
protected java.util.Map<java.lang.String,CmsListItem>	m_liCache List item cache.
protected java.util.Map<java.lang.String,CmsResource>	m_resCache Resource cache.
protected java.util.List<CmsResource>	m_resources Cache for resource list result.
static java.lang.String	VFS_PATH_NONE VFS path to use for a dummy resource object.

从接口继承的字段 org.opencms.workplace.list.I_CmsListResourceCollector

PARAM_FILTER, PARAM_ORDER, PARAM_PAGE, PARAM_RESOURCES, PARAM_SORTBY, SEP_KEYVAL, SEP_PARAM

构造器概要

构造器

限定符	构造器和说明
protected	A_CmsListResourceCollector(A_CmsListExplorerDialog wp) Constructor, creates a new list collector.

方法概要

方法

限定符和类型	方法和说明
int	compareTo(I_CmsResourceCollector arg0)
protected CmsListItem	createResourceListItem(CmsResource resource, CmsHtmlList list, boolean showPermissions, boolean showDateLastMod, boolean showUserLastMod, boolean showDateCreate, boolean showUserCreate, boolean showDateRel, boolean showDateExp, boolean showState, boolean showLockedBy, boolean showSite) Returns a list item created from the resource information, differs between valid resources and invalid resources.
java.lang.String	getCreateLink(CmsObject cms) Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the default collector.
java.lang.String	getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the named collector.
java.lang.String	getCreateParam(CmsObject cms) Returns the default parameter that must be passed to the I_CmsResourceCollector.getCreateLink(CmsObject, String, String) method.
java.lang.String	getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns the parameter that must be passed to the I_CmsResourceCollector.getCreateLink(CmsObject, String, String) method.
int	getCreateTypeId(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns the id of the resource type for new collector items.
java.lang.String	getDefaultCollectorName() Returns the default collector name to use for collecting resources.
java.lang.String	getDefaultCollectorParam() Returns the default collector parameter to use for collecting resources.
protected CmsListItem	getDummyListItem(CmsHtmlList list) Returns a dummy list item.
protected java.util.List<CmsResource>	getInternalResources(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Wrapper method for caching the result of getResources(CmsObject, Map).
java.util.List<CmsListItem>	getListItems(java.lang.String parameter) Returns a list of list items from a list of resources.
int	getOrder() Returns the "order weight" of this collector.
CmsResource	getResource(CmsObject cms, CmsListItem item) Returns the resource for the given item.
protected java.util.List<java.lang.String>	getResourceNamesFromParam(java.util.Map<java.lang.String,java.lang.String> params) Returns the list of resource names from the parameter map.
abstract java.util.List<CmsResource>	getResources(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Returns all, unsorted and unfiltered, resources.
java.util.List<CmsResource>	getResults(CmsObject cms) Returns a list of CmsResource Objects that are gathered in the VFS using the default collector name and parameter.
java.util.List<CmsResource>	getResults(CmsObject cms, java.lang.String collectorName, java.lang.String parameter) The parameter must follow the syntax "page:nr" where nr is the number of the page to be displayed.
protected CmsListState	getState(java.util.Map<java.lang.String,java.lang.String> params) Returns the state of the parameter map.
A_CmsListExplorerDialog	getWp() Returns the workplace object.
protected abstract void	setAdditionalColumns(CmsListItem item, CmsResourceUtil resUtil) Set additional column entries for a resource.
void	setDefaultCollectorName(java.lang.String collectorName) Sets the default collector name to use for collecting resources.
void	setDefaultCollectorParam(java.lang.String param) The parameter must follow the syntax "mode|projectId" where mode is either "new", "changed", "deleted" or "modified" and projectId is the id of the project to be displayed.
void	setOrder(int order) Sets the "order weight" of this collector.
void	setPage(int page) Sets the current display page.
protected void	setResourcesParam(java.util.List<java.lang.String> resources) Sets the resources parameter.

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.opencms.file.collectors.I_CmsResourceCollector

getCollectorNames

字段详细资料

VFS_PATH_NONE

public static final java.lang.String VFS_PATH_NONE

VFS path to use for a dummy resource object.

另请参阅:

常量字段值

m_collectorParameter

protected java.lang.String m_collectorParameter

The collector parameter.

m_liCache

protected java.util.Map<java.lang.String,CmsListItem> m_liCache

List item cache.

m_resCache

protected java.util.Map<java.lang.String,CmsResource> m_resCache

Resource cache.

m_resources

protected java.util.List<CmsResource> m_resources

Cache for resource list result.

构造器详细资料

A_CmsListResourceCollector

protected A_CmsListResourceCollector(A_CmsListExplorerDialog wp)

Constructor, creates a new list collector.

参数:

wp - the workplace object where the collector is used from

方法详细资料

compareTo

public int compareTo(I_CmsResourceCollector arg0)

指定者:

compareTo 在接口中 java.lang.Comparable<I_CmsResourceCollector>

另请参阅:

Comparable.compareTo(java.lang.Object)

getCreateLink

public java.lang.String getCreateLink(CmsObject cms)

从接口复制的说明: I_CmsResourceCollector

Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the default collector.

If this method returns null, it indicated that the selected collector implementation does not support a "create link", and so no "new" button will should shown on lists generated with this collector.

指定者:

getCreateLink 在接口中 I_CmsResourceCollector

参数:

cms - the current CmsObject

返回:

the link to execute after a "new" button was clicked

另请参阅:

I_CmsResourceCollector.getCreateLink(org.opencms.file.CmsObject)

getCreateLink

public java.lang.String getCreateLink(CmsObject cms,
                             java.lang.String collectorName,
                             java.lang.String param)

从接口复制的说明: I_CmsResourceCollector

Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the named collector.

If this method returns null, it indicated that the selected collector implementation does not support a "create link", and so no "new" button will should shown on lists generated with this collector.

指定者:

getCreateLink 在接口中 I_CmsResourceCollector

参数:

cms - the current CmsObject

collectorName - the name of the collector to use

param - an optional collector parameter

返回:

the link to execute after a "new" button was clicked

另请参阅:

I_CmsResourceCollector.getCreateLink(org.opencms.file.CmsObject, java.lang.String, java.lang.String)

getCreateTypeId

public int getCreateTypeId(CmsObject cms,
                  java.lang.String collectorName,
                  java.lang.String param)

从接口复制的说明: I_CmsResourceCollector

Returns the id of the resource type for new collector items.

Returns -1 if creation of new items is not supported.

指定者:

getCreateTypeId 在接口中 I_CmsResourceCollector

参数:

cms - the current CmsObject

collectorName - the name of the collector to use

param - an optional collector parameter

返回:

the resource type id

另请参阅:

I_CmsResourceCollector.getCreateTypeId(org.opencms.file.CmsObject, java.lang.String, java.lang.String)

getCreateParam

public java.lang.String getCreateParam(CmsObject cms)

从接口复制的说明: I_CmsResourceCollector

Returns the default parameter that must be passed to the I_CmsResourceCollector.getCreateLink(CmsObject, String, String) method.

If this method returns null, it indicates that the selected collector implementation does not support a "create link", and so no "new" button will should shown on lists generated with this collector.

指定者:

getCreateParam 在接口中 I_CmsResourceCollector

参数:

cms - the current CmsObject

返回:

the parameter that will be passed to the I_CmsResourceCollector.getCreateLink(CmsObject, String, String) method, or null

另请参阅:

I_CmsResourceCollector.getCreateParam(org.opencms.file.CmsObject)

getCreateParam

public java.lang.String getCreateParam(CmsObject cms,
                              java.lang.String collectorName,
                              java.lang.String param)

从接口复制的说明: I_CmsResourceCollector

Returns the parameter that must be passed to the I_CmsResourceCollector.getCreateLink(CmsObject, String, String) method.

If this method returns null, it indicates that the selected collector implementation does not support a "create link", and so no "new" button will should shown on lists generated with this collector.

指定者:

getCreateParam 在接口中 I_CmsResourceCollector

参数:

cms - the current CmsObject

collectorName - the name of the collector to use

param - an optional collector parameter from the current page context

返回:

the parameter that will be passed to the I_CmsResourceCollector.getCreateLink(CmsObject, String, String) method, or null

另请参阅:

I_CmsResourceCollector.getCreateParam(org.opencms.file.CmsObject, java.lang.String, java.lang.String)

getDefaultCollectorName

public java.lang.String getDefaultCollectorName()

从接口复制的说明: I_CmsResourceCollector

Returns the default collector name to use for collecting resources.

指定者:

getDefaultCollectorName 在接口中 I_CmsResourceCollector

返回:

the default collector name

另请参阅:

I_CmsResourceCollector.getDefaultCollectorName()

getDefaultCollectorParam

public java.lang.String getDefaultCollectorParam()

从接口复制的说明: I_CmsResourceCollector

Returns the default collector parameter to use for collecting resources.

指定者:

getDefaultCollectorParam 在接口中 I_CmsResourceCollector

返回:

the default collector parameter

另请参阅:

I_CmsResourceCollector.getDefaultCollectorParam()

getListItems

public java.util.List<CmsListItem> getListItems(java.lang.String parameter)
                                         throws CmsException

Returns a list of list items from a list of resources.

指定者:

getListItems 在接口中 I_CmsListResourceCollector

参数:

parameter - the collector parameter or null for default.

返回:

a list of CmsListItem objects

抛出:

CmsException - if something goes wrong

getOrder

public int getOrder()

从接口复制的说明: I_CmsResourceCollector

Returns the "order weight" of this collector.

The "order weight" is important because two collector classes may provide a collector with the same name. If this is the case, the collector implementation with the higher order number "overrules" the lower order number class.

指定者:

getOrder 在接口中 I_CmsResourceCollector

返回:

the "order weight" of this collector

另请参阅:

I_CmsResourceCollector.getOrder()

getResource

public CmsResource getResource(CmsObject cms,
                      CmsListItem item)

Returns the resource for the given item.

指定者:

getResource 在接口中 I_CmsListResourceCollector

参数:

cms - the cms object

item - the item

返回:

the resource

getResources

public abstract java.util.List<CmsResource> getResources(CmsObject cms,
                                       java.util.Map<java.lang.String,java.lang.String> params)
                                                  throws CmsException

Returns all, unsorted and unfiltered, resources.

Be sure to cache the resources.

指定者:

getResources 在接口中 I_CmsListResourceCollector

参数:

cms - the cms object

params - the parameter map

返回:

a list of CmsResource objects

抛出:

CmsException - if something goes wrong

getResults

public java.util.List<CmsResource> getResults(CmsObject cms)
                                       throws CmsException

从接口复制的说明: I_CmsResourceCollector

Returns a list of CmsResource Objects that are gathered in the VFS using the default collector name and parameter.

指定者:

getResults 在接口中 I_CmsResourceCollector

参数:

cms - the current CmsObject

返回:

a list of CmsXmlContent objects

抛出:

CmsException - if something goes wrong

CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid

另请参阅:

I_CmsResourceCollector.getResults(org.opencms.file.CmsObject)

getResults

public java.util.List<CmsResource> getResults(CmsObject cms,
                                     java.lang.String collectorName,
                                     java.lang.String parameter)
                                       throws CmsException

The parameter must follow the syntax "page:nr" where nr is the number of the page to be displayed.

指定者:

getResults 在接口中 I_CmsResourceCollector

参数:

cms - the current CmsObject

collectorName - the name of the collector to use

parameter - an optional collector parameter

返回:

a list of CmsXmlContent objects

抛出:

CmsException - if something goes wrong

CmsDataAccessException - if the parameter attribute of the corresponding collector tag is invalid

另请参阅:

I_CmsResourceCollector.getResults(org.opencms.file.CmsObject, java.lang.String, java.lang.String)

getWp

public A_CmsListExplorerDialog getWp()

Returns the workplace object.

指定者:

getWp 在接口中 I_CmsListResourceCollector

返回:

the workplace object

setDefaultCollectorName

public void setDefaultCollectorName(java.lang.String collectorName)

从接口复制的说明: I_CmsResourceCollector

Sets the default collector name to use for collecting resources.

指定者:

setDefaultCollectorName 在接口中 I_CmsResourceCollector

参数:

collectorName - the default collector name

另请参阅:

I_CmsResourceCollector.setDefaultCollectorName(java.lang.String)

setDefaultCollectorParam

public void setDefaultCollectorParam(java.lang.String param)

The parameter must follow the syntax "mode|projectId" where mode is either "new", "changed", "deleted" or "modified" and projectId is the id of the project to be displayed.

指定者:

setDefaultCollectorParam 在接口中 I_CmsResourceCollector

参数:

param - the default collector parameter

另请参阅:

I_CmsResourceCollector.setDefaultCollectorParam(java.lang.String)

setOrder

public void setOrder(int order)

从接口复制的说明: I_CmsResourceCollector

Sets the "order weight" of this collector.

指定者:

setOrder 在接口中 I_CmsResourceCollector

参数:

order - the order weight to set

另请参阅:

I_CmsResourceCollector.setOrder(int)

setPage

public void setPage(int page)

Sets the current display page.

指定者:

setPage 在接口中 I_CmsListResourceCollector

参数:

page - the new display page

createResourceListItem

protected CmsListItem createResourceListItem(CmsResource resource,
                                 CmsHtmlList list,
                                 boolean showPermissions,
                                 boolean showDateLastMod,
                                 boolean showUserLastMod,
                                 boolean showDateCreate,
                                 boolean showUserCreate,
                                 boolean showDateRel,
                                 boolean showDateExp,
                                 boolean showState,
                                 boolean showLockedBy,
                                 boolean showSite)

Returns a list item created from the resource information, differs between valid resources and invalid resources.

参数:

resource - the resource to create the list item from

list - the list

showPermissions - if to show permissions

showDateLastMod - if to show the last modification date

showUserLastMod - if to show the last modification user

showDateCreate - if to show the creation date

showUserCreate - if to show the creation date

showDateRel - if to show the date released

showDateExp - if to show the date expired

showState - if to show the state

showLockedBy - if to show the lock user

showSite - if to show the site

返回:

a list item created from the resource information

getDummyListItem

protected CmsListItem getDummyListItem(CmsHtmlList list)

Returns a dummy list item.

参数:

list - the list object to create the entry for

返回:

a dummy list item

getInternalResources

protected java.util.List<CmsResource> getInternalResources(CmsObject cms,
                                               java.util.Map<java.lang.String,java.lang.String> params)
                                                    throws CmsException

Wrapper method for caching the result of getResources(CmsObject, Map).

参数:

cms - the cms object

params - the parameter map

返回:

the result of getResources(CmsObject, Map)

抛出:

CmsException - if something goes wrong

getResourceNamesFromParam

protected java.util.List<java.lang.String> getResourceNamesFromParam(java.util.Map<java.lang.String,java.lang.String> params)

Returns the list of resource names from the parameter map.

参数:

params - the parameter map

返回:

the list of resource names

另请参阅:

I_CmsListResourceCollector.PARAM_RESOURCES

getState

protected CmsListState getState(java.util.Map<java.lang.String,java.lang.String> params)

Returns the state of the parameter map.

参数:

params - the parameter map

返回:

the state of the list from the parameter map

setAdditionalColumns

protected abstract void setAdditionalColumns(CmsListItem item,
                        CmsResourceUtil resUtil)

Set additional column entries for a resource.

Overwrite this method to set additional column entries.

参数:

item - the current list item

resUtil - the resource util object for getting the info from

setResourcesParam

protected void setResourcesParam(java.util.List<java.lang.String> resources)

Sets the resources parameter.

参数:

resources - the list of resource names to use