CmsRelationType

java.lang.Object
- org.opencms.relations.CmsRelationType

所有已实现的接口:

java.io.Serializable
```
public final class CmsRelationType
extends java.lang.Object
implements java.io.Serializable
```
Wrapper class for the different types of relations.
The possibles values are:
User defined relation types are also available.
从以下版本开始:

6.3.0

另请参阅:
序列化表格

字段概要

字段
限定符和类型	字段和说明
`static CmsRelationType`	`CATEGORY` Constant for the category of an `OpenCmsVfsFile`.
`static CmsRelationType`	`EMBEDDED_IMAGE` Constant for the `<img src=''>` tag in a html page/element.
`static CmsRelationType`	`EMBEDDED_OBJECT` Constant for the `<embed src=''>` tag in a html page/element.
`static CmsRelationType`	`HYPERLINK` Constant for the `<a href=''>` tag in a html page/element.
`static CmsRelationType`	`JSP_STRONG` Constant for the all types of links in a jsp file using the `link.strong` macro.
`static CmsRelationType`	`JSP_WEAK` Constant for the all types of links in a jsp file using the `link.weak` macro.
`static CmsRelationType`	`OU_RESOURCE` Constant for the organizational units resource associations.
`static CmsRelationType`	`XML_STRONG` Constant for the `OpenCmsVfsFile` values in xml content that were defined as 'strong' links.
`static CmsRelationType`	`XML_WEAK` Constant for the `OpenCmsVfsFile` values in xml content that were defined as 'weak' links.
`static CmsRelationType`	`XSD` Constant for the weak links from xmlcontent to the used xsd.

构造器概要

构造器
构造器和说明

CmsRelationType(int id, java.lang.String name, java.lang.String type)
Public constructor for user defined relation types.

构造器
构造器和说明
`CmsRelationType(int id, java.lang.String name, java.lang.String type)` Public constructor for user defined relation types.

方法概要

方法
限定符和类型	方法和说明
`boolean`	`equals(java.lang.Object obj)`
`static java.util.List<CmsRelationType>`	`filterDefinedInContent(java.util.Collection<CmsRelationType> relationTypes)` Returns all relation types in the given list that define relations in the content.
`static java.util.List<CmsRelationType>`	`filterInternal(java.util.Collection<CmsRelationType> relationTypes)` Returns all internal defined relation types in the given list.
`static java.util.List<CmsRelationType>`	`filterNotDefinedInContent(java.util.Collection<CmsRelationType> relationTypes)` Returns all relation types in the given list that are not defined in the content.
`static java.util.List<CmsRelationType>`	`filterStrong(java.util.Collection<CmsRelationType> relationTypes)` Returns all strong relation types in the given list.
`static java.util.List<CmsRelationType>`	`filterUserDefined(java.util.Collection<CmsRelationType> relationTypes)` Returns all user defined relation types in the given list.
`static java.util.List<CmsRelationType>`	`filterWeak(java.util.Collection<CmsRelationType> relationTypes)` Returns all weak relation types in the given list.
`static java.util.List<CmsRelationType>`	`getAll()` Returns all relation types.
`static java.util.List<CmsRelationType>`	`getAllDefinedInContent()` Returns all relation types for relations defined in the content.
`static java.util.List<CmsRelationType>`	`getAllInternal()` Returns all internally defined relation types.
`static java.util.List<CmsRelationType>`	`getAllNotDefinedInContent()` Returns all relation types for relations that are not defined in the content.
`static java.util.List<CmsRelationType>`	`getAllStrong()` Returns all strong relation types.
`static java.util.List<CmsRelationType>`	`getAllUserDefined()` Returns all user defined relation types.
`static java.util.List<CmsRelationType>`	`getAllWeak()` Returns all weak relation types.
`int`	`getId()` Returns the internal representation of this type.
`java.lang.String`	`getLocalizedName(CmsMessages messages)` Returns a localized name for the given relation type.
`java.lang.String`	`getLocalizedName(java.util.Locale locale)` Returns a localized name for the given relation type.
`java.lang.String`	`getName()` Returns the type name.
`java.lang.String`	`getNameForXml()` Returns the type name for xml output.
`java.lang.String`	`getType()` Returns the string strong or weak.
`int`	`hashCode()`
`boolean`	`isDefinedInContent()` Checks if this relation type is defined in the content of a resource or not.
`boolean`	`isInternal()` Checks if this is an internal relation type.
`boolean`	`isStrong()` Checks if the relation type is strong or weak.
`java.lang.String`	`toString()`
`static CmsRelationType`	`valueOf(int id)` Parses an `int` into a relation type.
`static CmsRelationType`	`valueOf(java.lang.String name)` Parses an `String` into a relation type.
`static CmsRelationType`	`valueOfJsp(java.lang.String name)` Parses the given value into a valid enumeration element for a JSP relation type.
`static CmsRelationType`	`valueOfXml(java.lang.String name)` Parses the given value into a valid enumeration element for a XML relation type.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - CATEGORY
```
public static final CmsRelationType CATEGORY
```
    Constant for the category of an OpenCmsVfsFile.
  - EMBEDDED_IMAGE
```
public static final CmsRelationType EMBEDDED_IMAGE
```
    Constant for the <img src=''> tag in a html page/element.
  - EMBEDDED_OBJECT
```
public static final CmsRelationType EMBEDDED_OBJECT
```
    Constant for the <embed src=''> tag in a html page/element.
  - HYPERLINK
```
public static final CmsRelationType HYPERLINK
```
    Constant for the <a href=''> tag in a html page/element.
  - JSP_STRONG
```
public static final CmsRelationType JSP_STRONG
```
    Constant for the all types of links in a jsp file using the link.strong macro.
  - JSP_WEAK
```
public static final CmsRelationType JSP_WEAK
```
    Constant for the all types of links in a jsp file using the link.weak macro.
  - OU_RESOURCE
```
public static final CmsRelationType OU_RESOURCE
```
    Constant for the organizational units resource associations.
  - XML_STRONG
```
public static final CmsRelationType XML_STRONG
```
    Constant for the OpenCmsVfsFile values in xml content that were defined as 'strong' links.
  - XML_WEAK
```
public static final CmsRelationType XML_WEAK
```
    Constant for the OpenCmsVfsFile values in xml content that were defined as 'weak' links.
  - XSD
```
public static final CmsRelationType XSD
```
    Constant for the weak links from xmlcontent to the used xsd.
- 构造器详细资料
  - CmsRelationType
```
public CmsRelationType(int id,
               java.lang.String name,
               java.lang.String type)
```
    Public constructor for user defined relation types.
    
    参数:
    id - the id of the relation type
    name - the name of the relation
    type - the type of relation type, strong or weak
- 方法详细资料
  - filterDefinedInContent
```
public static java.util.List<CmsRelationType> filterDefinedInContent(java.util.Collection<CmsRelationType> relationTypes)
```
    Returns all relation types in the given list that define relations in the content.
    
    参数:
    relationTypes - the collection of relation types to filter
    
    返回:
    a list of CmsRelationType objects
  - filterInternal
```
public static java.util.List<CmsRelationType> filterInternal(java.util.Collection<CmsRelationType> relationTypes)
```
    Returns all internal defined relation types in the given list.
    
    参数:
    relationTypes - the collection of relation types to filter
    
    返回:
    a list of CmsRelationType objects
  - filterNotDefinedInContent
```
public static java.util.List<CmsRelationType> filterNotDefinedInContent(java.util.Collection<CmsRelationType> relationTypes)
```
    Returns all relation types in the given list that are not defined in the content.
    
    参数:
    relationTypes - the collection of relation types to filter
    
    返回:
    a list of CmsRelationType objects
  - filterStrong
```
public static java.util.List<CmsRelationType> filterStrong(java.util.Collection<CmsRelationType> relationTypes)
```
    Returns all strong relation types in the given list.
    
    参数:
    relationTypes - the collection of relation types to filter
    
    返回:
    a list of CmsRelationType objects
  - filterUserDefined
```
public static java.util.List<CmsRelationType> filterUserDefined(java.util.Collection<CmsRelationType> relationTypes)
```
    Returns all user defined relation types in the given list.
    
    参数:
    relationTypes - the collection of relation types to filter
    
    返回:
    a list of CmsRelationType objects
  - filterWeak
```
public static java.util.List<CmsRelationType> filterWeak(java.util.Collection<CmsRelationType> relationTypes)
```
    Returns all weak relation types in the given list.
    
    参数:
    relationTypes - the collection of relation types to filter
    
    返回:
    a list of CmsRelationType objects
  - getAll
```
public static java.util.List<CmsRelationType> getAll()
```
    Returns all relation types.
    
    返回:
    a list of CmsRelationType objects
  - getAllDefinedInContent
```
public static java.util.List<CmsRelationType> getAllDefinedInContent()
```
    Returns all relation types for relations defined in the content.
    
    返回:
    a list of CmsRelationType objects
  - getAllInternal
```
public static java.util.List<CmsRelationType> getAllInternal()
```
    Returns all internally defined relation types.
    
    返回:
    a list of CmsRelationType objects
  - getAllNotDefinedInContent
```
public static java.util.List<CmsRelationType> getAllNotDefinedInContent()
```
    Returns all relation types for relations that are not defined in the content.
    
    返回:
    a list of CmsRelationType objects
  - getAllStrong
```
public static java.util.List<CmsRelationType> getAllStrong()
```
    Returns all strong relation types.
    
    返回:
    a list of CmsRelationType objects
  - getAllUserDefined
```
public static java.util.List<CmsRelationType> getAllUserDefined()
```
    Returns all user defined relation types.
    
    返回:
    a list of CmsRelationType objects
  - getAllWeak
```
public static java.util.List<CmsRelationType> getAllWeak()
```
    Returns all weak relation types.
    
    返回:
    a list of CmsRelationType objects
  - valueOf
```
public static CmsRelationType valueOf(int id)
                               throws CmsIllegalArgumentException
```
    Parses an int into a relation type.
    
    参数:
    id - the internal representation number to parse
    
    返回:
    the enumeration element
    
    抛出:
    
    CmsIllegalArgumentException - if the given value could not be matched against a CmsRelationType object.
  - valueOf
```
public static CmsRelationType valueOf(java.lang.String name)
                               throws CmsIllegalArgumentException
```
    Parses an String into a relation type.
    
    参数:
    name - the relation type name
    
    返回:
    the enumeration element
    
    抛出:
    
    CmsIllegalArgumentException - if the given value could not be matched against a CmsRelationType object
    另请参阅:
    valueOfXml(String), valueOfJsp(String)
  - valueOfJsp
```
public static CmsRelationType valueOfJsp(java.lang.String name)
```
    Parses the given value into a valid enumeration element for a JSP relation type.
    This should be used to extend Strings like "weak" or "strong" to full relation type descriptors for JSP pages like "JSP_WEAK" or "JSP_STRONG".
    
    参数:
    name - the name to get the JSP type for
    
    返回:
    the JSP enumeration element
    另请参阅:
    valueOf(String)
  - valueOfXml
```
public static CmsRelationType valueOfXml(java.lang.String name)
```
    Parses the given value into a valid enumeration element for a XML relation type.
    This should be used to extend Strings like "weak" or "strong" to full relation type descriptors for XML documents like "XML_WEAK" or "XML_STRONG".
    
    参数:
    name - the name to get the XML type for
    
    返回:
    the XML enumeration element
    另请参阅:
    valueOf(String)
  - equals
```
public boolean equals(java.lang.Object obj)
```
    覆盖:
    
    equals 在类中 java.lang.Object
    
    另请参阅:
    Object.equals(java.lang.Object)
  - getId
```
public int getId()
```
    Returns the internal representation of this type.
    
    返回:
    the internal representation of this type
  - getLocalizedName
```
public java.lang.String getLocalizedName(CmsMessages messages)
```
    Returns a localized name for the given relation type.
    
    参数:
    messages - the message bundle to use to resolve the name
    
    返回:
    a localized name
  - getLocalizedName
```
public java.lang.String getLocalizedName(java.util.Locale locale)
```
    Returns a localized name for the given relation type.
    
    参数:
    locale - the locale
    
    返回:
    a localized name
  - getName
```
public java.lang.String getName()
```
    Returns the type name.
    
    返回:
    the type name
    另请参阅:
    valueOf(String)
  - getNameForXml
```
public java.lang.String getNameForXml()
```
    Returns the type name for xml output.
    The short type name of XML or JSP types is only "WEAK" or "STRONG". For other types the short name is equal to the name.
    In case you need the full type name, use getName().
    
    返回:
    the short type name
    另请参阅:
    getName(), valueOfJsp(String), valueOfXml(String)
  - getType
```
public java.lang.String getType()
```
    Returns the string strong or weak.
    
    返回:
    the string strong or weak
    另请参阅:
    isStrong()
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    另请参阅:
    Object.hashCode()
  - isDefinedInContent
```
public boolean isDefinedInContent()
```
    Checks if this relation type is defined in the content of a resource or not.
    
    返回:
    true if this relation type is defined in the content of a resource
  - isInternal
```
public boolean isInternal()
```
    Checks if this is an internal relation type.
    
    返回:
    true if this is an internal relation type
  - isStrong
```
public boolean isStrong()
```
    Checks if the relation type is strong or weak.
    
    返回:
    true if the relation type is strong
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
    
    另请参阅:
    Object.toString()

类 CmsRelationType

字段概要

构造器概要

方法概要

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

字段详细资料

CATEGORY

EMBEDDED_IMAGE

EMBEDDED_OBJECT

HYPERLINK

JSP_STRONG

JSP_WEAK

OU_RESOURCE

XML_STRONG

XML_WEAK

XSD

构造器详细资料

CmsRelationType

方法详细资料

filterDefinedInContent

filterInternal

filterNotDefinedInContent

filterStrong

filterUserDefined

filterWeak

getAll

getAllDefinedInContent

getAllInternal

getAllNotDefinedInContent

getAllStrong

getAllUserDefined

getAllWeak

valueOf

valueOf

valueOfJsp

valueOfXml

equals

getId

getLocalizedName

getLocalizedName

getName

getNameForXml

getType

hashCode

isDefinedInContent

isInternal

isStrong

toString