org.opencms.relations

类 CmsCategory

java.lang.Object

org.opencms.relations.CmsCategory

所有已实现的接口:

java.io.Serializable, java.lang.Comparable<CmsCategory>

public class CmsCategory
extends java.lang.Object
implements java.lang.Comparable<CmsCategory>, java.io.Serializable

Represents a category, that is just a folder.

The category can be centralized under /system/categories/, or decentralized in every folder.

For instance, you can have a category folder under /sites/default/ so, any file under /sites/default/ could be assigned to any category defined under /system/categories/ or /sites/default/categories.

But a file under /sites/othersite/ will only be assignable to categories defined in /system/categories/.

从以下版本开始:

6.9.2

另请参阅:

序列化表格

构造器概要

构造器

限定符	构造器和说明
protected	CmsCategory() Empty default constructor which is only used for serialization.
	CmsCategory(CmsUUID structureId, java.lang.String rootPath, java.lang.String title, java.lang.String description, java.lang.String baseFolder) Default constructor.

方法概要

方法

限定符和类型	方法和说明
int	compareTo(CmsCategory cat)
boolean	equals(java.lang.Object obj)
java.lang.String	getBasePath() Returns the category's base path.
static java.lang.String	getCategoryPath(java.lang.String rootPath, java.lang.String baseFolder) Returns the category path for the given root path.
java.lang.String	getDescription() Returns the description.
CmsUUID	getId() Returns the id.
java.lang.String	getName() Returns the mere category name without it's complete path and without the trailing folder - slash.
java.lang.String	getPath() Returns the path.
java.lang.String	getRootPath() Returns the category's root path.
java.lang.String	getTitle() Returns the title.
int	hashCode()

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

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

构造器详细资料

CmsCategory

public CmsCategory(CmsUUID structureId,
           java.lang.String rootPath,
           java.lang.String title,
           java.lang.String description,
           java.lang.String baseFolder)
            throws CmsException

Default constructor.

参数:

structureId - the structure id of the resource that this category represents

rootPath - the root path of the category folder

title - the title of the category

description - the description of the category

baseFolder - the base categories folder

抛出:

CmsException - if the root path does not match the given base folder

CmsCategory

protected CmsCategory()

Empty default constructor which is only used for serialization.

方法详细资料

getCategoryPath

public static java.lang.String getCategoryPath(java.lang.String rootPath,
                               java.lang.String baseFolder)
                                        throws CmsException

Returns the category path for the given root path.

参数:

rootPath - the root path

baseFolder - the categories base folder name

返回:

the category path

抛出:

CmsException - if the root path does not match the given base folder

compareTo

public int compareTo(CmsCategory cat)

指定者:

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

另请参阅:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(java.lang.Object obj)

覆盖:

equals 在类中 java.lang.Object

另请参阅:

Object.equals(java.lang.Object)

getBasePath

public java.lang.String getBasePath()

Returns the category's base path.

返回:

the category's base path

getDescription

public java.lang.String getDescription()

Returns the description.

返回:

the description

getId

public CmsUUID getId()

Returns the id.

返回:

the id

getName

public java.lang.String getName()

Returns the mere category name without it's complete path and without the trailing folder - slash.

返回:

the mere category name without it's complete path and without the trailing folder - slash

getPath

public java.lang.String getPath()

Returns the path.

返回:

the path

getRootPath

public java.lang.String getRootPath()

Returns the category's root path.

返回:

the category's root path

getTitle

public java.lang.String getTitle()

Returns the title.

返回:

the title

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

另请参阅:

Object.hashCode()