org.opencms.file.collectors

类 A_CmsResourceCollector

java.lang.Object

org.opencms.file.collectors.A_CmsResourceCollector

所有已实现的接口:

java.lang.Comparable<I_CmsResourceCollector>, I_CmsResourceCollector

直接已知子类:

CmsCategoryResourceCollector, CmsChangedResourceCollector, CmsDateResourceCollector, CmsDefaultResourceCollector, CmsPriorityResourceCollector, CmsSolrCollector, CmsSubscriptionCollector, CmsTimeFrameCategoryCollector

public abstract class A_CmsResourceCollector
extends java.lang.Object
implements I_CmsResourceCollector

Provides some helpful base implementations for resource collector classes.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
protected int	m_order The collector order of this collector.
static java.lang.String	SEPARATOR_TEMPLATEFILE The template file separator string for creating a new resource in direct edit mode, can be used to append an explicit template file name in I_CmsResourceCollector.getCreateParam(CmsObject, String, String).

构造器概要

构造器

构造器和说明
A_CmsResourceCollector() Constructor to initialize some default values.

方法概要

方法

限定符和类型	方法和说明
protected void	checkParams() Checks if the required parameters have been set.
int	compareTo(I_CmsResourceCollector obj)
static java.lang.String	createResourceForCollector(CmsObject cms, java.lang.String newLink, java.util.Locale locale, java.lang.String referenceResource, java.lang.String modelFile) Creates a new content collector resource.
boolean	equals(java.lang.Object obj) Two collectors are considered to be equal if they are sharing the same implementation class.
protected java.lang.String	getCreateInFolder(CmsObject cms, CmsCollectorData data) Returns the link to create a new XML content item in the folder pointed to by the parameter.
protected java.lang.String	getCreateInFolder(CmsObject cms, java.lang.String param) Returns the link to create a new XML content item in the folder pointed to by the parameter.
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	getCreateParam(CmsObject cms) Returns the default 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.
int	getOrder() Returns the "order weight" of this collector.
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.
int	hashCode()
void	setDefaultCollectorName(java.lang.String collectorName) Sets the default collector name to use for collecting resources.
void	setDefaultCollectorParam(java.lang.String param) Sets the default collector parameter to use for collecting resources.
void	setOrder(int order) Sets the "order weight" of this collector.
protected java.util.List<CmsResource>	shrinkToFit(java.util.List<CmsResource> result, int maxSize) Shrinks a List to fit a maximum size.

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

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

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

getCollectorNames, getCreateLink, getCreateParam, getResults

字段详细资料

SEPARATOR_TEMPLATEFILE

public static final java.lang.String SEPARATOR_TEMPLATEFILE

The template file separator string for creating a new resource in direct edit mode, can be used to append an explicit template file name in I_CmsResourceCollector.getCreateParam(CmsObject, String, String).

另请参阅:

常量字段值

m_order

protected int m_order

The collector order of this collector.

构造器详细资料

A_CmsResourceCollector

public A_CmsResourceCollector()

Constructor to initialize some default values.

方法详细资料

createResourceForCollector

public static java.lang.String createResourceForCollector(CmsObject cms,
                                          java.lang.String newLink,
                                          java.util.Locale locale,
                                          java.lang.String referenceResource,
                                          java.lang.String modelFile)
                                                   throws CmsException

Creates a new content collector resource.

参数:

cms - the cms context

newLink - the new resource link

locale - the content locale

referenceResource - the reference resource

modelFile - the model file

返回:

the new file name

抛出:

CmsException - if something goes wrong

compareTo

public int compareTo(I_CmsResourceCollector obj)

指定者:

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

另请参阅:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(java.lang.Object obj)

Two collectors are considered to be equal if they are sharing the same implementation class.

覆盖:

equals 在类中 java.lang.Object

另请参阅:

Object.equals(java.lang.Object)

getCreateLink

public java.lang.String getCreateLink(CmsObject cms)
                               throws CmsException,
                                      CmsDataAccessException

从接口复制的说明: 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

抛出:

CmsException - if something goes wrong

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

另请参阅:

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

getCreateParam

public java.lang.String getCreateParam(CmsObject cms)
                                throws CmsDataAccessException

从接口复制的说明: 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

抛出:

CmsDataAccessException - if the param attrib of the corresponding collector tag is invalid

另请参阅:

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

getCreateTypeId

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

从接口复制的说明: 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

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsResourceCollector.getCreateTypeId(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()

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()

getResults

public java.util.List<CmsResource> getResults(CmsObject cms)
                                       throws CmsDataAccessException,
                                              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

抛出:

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

CmsException - if something goes wrong

另请参阅:

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

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

另请参阅:

Object.hashCode()

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)

从接口复制的说明: I_CmsResourceCollector

Sets the default collector parameter to use for collecting resources.

指定者:

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)

checkParams

protected void checkParams()

Checks if the required parameters have been set.

另请参阅:

setDefaultCollectorName(String), setDefaultCollectorParam(String)

getCreateInFolder

protected java.lang.String getCreateInFolder(CmsObject cms,
                                 CmsCollectorData data)
                                      throws CmsException

Returns the link to create a new XML content item in the folder pointed to by the parameter.

参数:

cms - the current CmsObject

data - the collector data to use

返回:

the link to create a new XML content item in the folder

抛出:

CmsException - if something goes wrong

从以下版本开始:

7.0.2

getCreateInFolder

protected java.lang.String getCreateInFolder(CmsObject cms,
                                 java.lang.String param)
                                      throws CmsException

Returns the link to create a new XML content item in the folder pointed to by the parameter.

参数:

cms - the current CmsObject

param - the folder name to use

返回:

the link to create a new XML content item in the folder

抛出:

CmsException - if something goes wrong

shrinkToFit

protected java.util.List<CmsResource> shrinkToFit(java.util.List<CmsResource> result,
                                      int maxSize)

Shrinks a List to fit a maximum size.

参数:

result - a List

maxSize - the maximum size of the List

返回:

the reduced list