CmsLink

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

```
public class CmsLink
extends java.lang.Object
```
A single link entry in the link table.

从以下版本开始:

6.0.0

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`ATTRIBUTE_INTERNAL` Name of the internal attribute of the link node.
`static java.lang.String`	`ATTRIBUTE_NAME` Name of the name attribute of the elements node.
`static java.lang.String`	`ATTRIBUTE_TYPE` Name of the type attribute of the elements node.
`static java.lang.String`	`DEFAULT_NAME` Default link name.
`static CmsRelationType`	`DEFAULT_TYPE` Default link type.
`static java.lang.String`	`DUMMY_URI` A dummy uri.
`static java.lang.String`	`NODE_ANCHOR` Name of the anchor node.
`static java.lang.String`	`NODE_QUERY` Name of the query node.
`static java.lang.String`	`NODE_TARGET` Name of the target node.
`static java.lang.String`	`NODE_UUID` Name of the UUID node.
`static CmsLink`	`NULL_LINK` Constant for the NULL link.

构造器概要

构造器
构造器和说明
`CmsLink(org.dom4j.Element element)` Reconstructs a link object from the given XML node.
`CmsLink(java.lang.String name, CmsRelationType type, CmsUUID structureId, java.lang.String uri, boolean internal)` Creates a new link object without a reference to the xml page link element.
`CmsLink(java.lang.String name, CmsRelationType type, java.lang.String uri, boolean internal)` Creates a new link object without a reference to the xml page link element.

方法概要

方法
限定符和类型	方法和说明
`void`	`checkConsistency(CmsObject cms)` Checks and updates the structure id or the path of the target.
`boolean`	`equals(java.lang.Object obj)` A link is considered equal if the link target and the link type is equal.
`java.lang.String`	`getAnchor()` Returns the anchor of this link.
`org.dom4j.Element`	`getElement()` Returns the xml node element representing this link object.
`java.lang.String`	`getLink(CmsObject cms)` Returns the processed link.
`java.lang.String`	`getLink(CmsObject cms, boolean processEditorLinks)` 已过时。 use `getLink(CmsObject)` instead, the process editor option is set using the OpenCms request context attributes
`java.lang.String`	`getName()` Returns the macro name of this link.
`java.lang.String`	`getParameter(java.lang.String name)` Returns the first parameter value for the given parameter name.
`java.util.Map<java.lang.String,java.lang.String[]>`	`getParameterMap()` Returns the map of parameters of this link.
`java.util.Set<java.lang.String>`	`getParameterNames()` Returns the set of available parameter names for this link.
`java.lang.String[]`	`getParameterValues(java.lang.String name)` Returns all parameter values for the given name.
`java.lang.String`	`getQuery()` Returns the query of this link.
`java.lang.String`	`getSitePath()` Returns the vfs link of the target if it is internal.
`protected java.lang.String`	`getSitePath(java.lang.String uri)` Helper method for getting the site path for a uri.
`java.lang.String`	`getSiteRoot()` Return the site root if the target of this link is internal, or `null` otherwise.
`CmsUUID`	`getStructureId()` The structure id of the linked resource.
`java.lang.String`	`getTarget()` Returns the target (destination) of this link.
`CmsRelationType`	`getType()` Returns the type of this link.
`java.lang.String`	`getUri()` Returns the raw uri of this link.
`java.lang.String`	`getVfsUri()` 已过时。 Use `getSitePath()` instead
`int`	`hashCode()`
`boolean`	`isInternal()` Returns if the link is internal.
`java.lang.String`	`toString()`
`void`	`updateLink(java.lang.String uri)` Updates the uri of this link with a new value.
`void`	`updateLink(java.lang.String target, java.lang.String anchor, java.lang.String query)` Updates the uri of this link with a new target, anchor and query.

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

- 字段详细资料
  - ATTRIBUTE_INTERNAL
```
public static final java.lang.String ATTRIBUTE_INTERNAL
```
    Name of the internal attribute of the link node.
    
    另请参阅:
    常量字段值
  - ATTRIBUTE_NAME
```
public static final java.lang.String ATTRIBUTE_NAME
```
    Name of the name attribute of the elements node.
    
    另请参阅:
    常量字段值
  - ATTRIBUTE_TYPE
```
public static final java.lang.String ATTRIBUTE_TYPE
```
    Name of the type attribute of the elements node.
    
    另请参阅:
    常量字段值
  - DEFAULT_NAME
```
public static final java.lang.String DEFAULT_NAME
```
    Default link name.
    
    另请参阅:
    常量字段值
  - DEFAULT_TYPE
```
public static final CmsRelationType DEFAULT_TYPE
```
    Default link type.
  - DUMMY_URI
```
public static final java.lang.String DUMMY_URI
```
    A dummy uri.
    
    另请参阅:
    常量字段值
  - NODE_ANCHOR
```
public static final java.lang.String NODE_ANCHOR
```
    Name of the anchor node.
    
    另请参阅:
    常量字段值
  - NODE_QUERY
```
public static final java.lang.String NODE_QUERY
```
    Name of the query node.
    
    另请参阅:
    常量字段值
  - NODE_TARGET
```
public static final java.lang.String NODE_TARGET
```
    Name of the target node.
    
    另请参阅:
    常量字段值
  - NODE_UUID
```
public static final java.lang.String NODE_UUID
```
    Name of the UUID node.
    
    另请参阅:
    常量字段值
  - NULL_LINK
```
public static final CmsLink NULL_LINK
```
    Constant for the NULL link.
- 构造器详细资料
  - CmsLink
```
public CmsLink(org.dom4j.Element element)
```
    Reconstructs a link object from the given XML node.
    
    参数:
    element - the XML node containing the link information
  - CmsLink
```
public CmsLink(java.lang.String name,
       CmsRelationType type,
       CmsUUID structureId,
       java.lang.String uri,
       boolean internal)
```
    Creates a new link object without a reference to the xml page link element.
    
    参数:
    name - the internal name of this link
    type - the type of this link
    structureId - the structure id of the link
    uri - the link uri
    internal - indicates if the link is internal within OpenCms
  - CmsLink
```
public CmsLink(java.lang.String name,
       CmsRelationType type,
       java.lang.String uri,
       boolean internal)
```
    Creates a new link object without a reference to the xml page link element.
    
    参数:
    name - the internal name of this link
    type - the type of this link
    uri - the link uri
    internal - indicates if the link is internal within OpenCms
- 方法详细资料
  - checkConsistency
```
public void checkConsistency(CmsObject cms)
```
    Checks and updates the structure id or the path of the target.
    
    参数:
    cms - the cms context
  - equals
```
public boolean equals(java.lang.Object obj)
```
    A link is considered equal if the link target and the link type is equal.
    
    覆盖:
    
    equals 在类中 java.lang.Object
    
    另请参阅:
    Object.equals(java.lang.Object)
  - getAnchor
```
public java.lang.String getAnchor()
```
    Returns the anchor of this link.
    
    返回:
    the anchor or null if undefined
  - getElement
```
public org.dom4j.Element getElement()
```
    Returns the xml node element representing this link object.
    
    返回:
    the xml node element representing this link object
  - getLink
```
public java.lang.String getLink(CmsObject cms)
```
    Returns the processed link.
    
    参数:
    cms - the current OpenCms user context, can be null
    
    返回:
    the processed link
  - getLink
```
@Deprecated
public java.lang.String getLink(CmsObject cms,
                                  boolean processEditorLinks)
```
    已过时。 use getLink(CmsObject) instead, the process editor option is set using the OpenCms request context attributes
    
    Returns the processed link.
    
    参数:
    cms - the current OpenCms user context, can be null
    processEditorLinks - this parameter is not longer used
    
    返回:
    the processed link
  - getName
```
public java.lang.String getName()
```
    Returns the macro name of this link.
    
    返回:
    the macro name name of this link
  - getParameter
```
public java.lang.String getParameter(java.lang.String name)
```
    Returns the first parameter value for the given parameter name.
    
    参数:
    name - the name of the parameter
    
    返回:
    the first value for this name or null
  - getParameterMap
```
public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
```
    Returns the map of parameters of this link.
    
    返回:
    the map of parameters
  - getParameterNames
```
public java.util.Set<java.lang.String> getParameterNames()
```
    Returns the set of available parameter names for this link.
    
    返回:
    the parameter names
  - getParameterValues
```
public java.lang.String[] getParameterValues(java.lang.String name)
```
    Returns all parameter values for the given name.
    
    参数:
    name - the name of the parameter
    
    返回:
    all parameter values or null
  - getQuery
```
public java.lang.String getQuery()
```
    Returns the query of this link.
    
    返回:
    the query or null if undefined
  - getSitePath
```
public java.lang.String getSitePath()
```
    Returns the vfs link of the target if it is internal.
    
    返回:
    the full link destination or null if the link is not internal
  - getSiteRoot
```
public java.lang.String getSiteRoot()
```
    Return the site root if the target of this link is internal, or null otherwise.
    
    返回:
    the site root if the target of this link is internal, or null otherwise
  - getStructureId
```
public CmsUUID getStructureId()
```
    The structure id of the linked resource.
    
    返回:
    structure id of the linked resource
  - getTarget
```
public java.lang.String getTarget()
```
    Returns the target (destination) of this link.
    
    返回:
    the target the target (destination) of this link
  - getType
```
public CmsRelationType getType()
```
    Returns the type of this link.
    
    返回:
    the type of this link
  - getUri
```
public java.lang.String getUri()
```
    Returns the raw uri of this link.
    
    返回:
    the uri
  - getVfsUri
```
@Deprecated
public java.lang.String getVfsUri()
```
    已过时。 Use getSitePath() instead
    
    Returns the vfs link of the target if it is internal.
    
    返回:
    the full link destination or null if the link is not internal
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    另请参阅:
    Object.hashCode()
  - isInternal
```
public boolean isInternal()
```
    Returns if the link is internal.
    
    返回:
    true if the link is a local link
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
    
    另请参阅:
    Object.toString()
  - updateLink
```
public void updateLink(java.lang.String uri)
```
    Updates the uri of this link with a new value.
    Also updates the structure of the underlying XML page document this link belongs to.
    Note that you can not update the "internal" or "type" values of the link, so the new link must be of same type (A, IMG) and also remain either an internal or external link.
    
    参数:
    uri - the uri to update this link with scheme://authority/path#anchor?query
  - updateLink
```
public void updateLink(java.lang.String target,
              java.lang.String anchor,
              java.lang.String query)
```
    Updates the uri of this link with a new target, anchor and query.
    If anchor and/or query are null, this features are not used.
    Note that you can not update the "internal" or "type" values of the link, so the new link must be of same type (A, IMG) and also remain either an internal or external link.
    Also updates the structure of the underlying XML page document this link belongs to.
    
    参数:
    target - the target (destination) of this link
    anchor - the anchor or null if undefined
    query - the query or null if undefined
  - getSitePath
```
protected java.lang.String getSitePath(java.lang.String uri)
```
    Helper method for getting the site path for a uri.
    
    参数:
    uri - a VFS uri
    
    返回:
    the site path

类 CmsLink

字段概要

构造器概要

方法概要

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

字段详细资料

ATTRIBUTE_INTERNAL

ATTRIBUTE_NAME

ATTRIBUTE_TYPE

DEFAULT_NAME

DEFAULT_TYPE

DUMMY_URI

NODE_ANCHOR

NODE_QUERY

NODE_TARGET

NODE_UUID

NULL_LINK

构造器详细资料

CmsLink

CmsLink

CmsLink

方法详细资料

checkConsistency

equals

getAnchor

getElement

getLink

getLink

getName

getParameter

getParameterMap

getParameterNames

getParameterValues

getQuery

getSitePath

getSiteRoot

getStructureId

getTarget

getType

getUri

getVfsUri

hashCode

isInternal

toString

updateLink

updateLink

getSitePath