CmsRelationFilter

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

所有已实现的接口:

java.lang.Cloneable
```
public final class CmsRelationFilter
extends java.lang.Object
implements java.lang.Cloneable
```
A filter to retrieve the relations for a given resource.

从以下版本开始:

6.0.0

字段概要

字段
限定符和类型	字段和说明
`static CmsRelationFilter`	`ALL` To filter all sources and targets.
`static CmsRelationFilter`	`SOURCES` To filter all sources.
`static CmsRelationFilter`	`TARGETS` To filter all targets.

方法概要

方法
限定符和类型	方法和说明
`java.lang.Object`	`clone()`
`CmsRelationFilter`	`filterDefinedInContent()` Returns an extended filter with defined in content type restriction.
`CmsRelationFilter`	`filterIncludeChildren()` Returns an extended filter that will extend the result to the given path and all its subresources.
`CmsRelationFilter`	`filterInternal()` Returns an extended filter with internal type restriction.
`CmsRelationFilter`	`filterNotDefinedInContent()` Returns an extended filter with not defined in content type restriction.
`CmsRelationFilter`	`filterPath(java.lang.String path)` Returns an extended filter with the given source relation path restriction.
`CmsRelationFilter`	`filterResource(CmsResource resource)` Returns an extended filter with the given resource (path and id) restriction.
`CmsRelationFilter`	`filterStrong()` Returns an extended filter with strong type restriction.
`CmsRelationFilter`	`filterStructureId(CmsUUID structureId)` Returns an extended filter with the given structure id restriction.
`CmsRelationFilter`	`filterType(CmsRelationType type)` Returns an extended filter with the given type restriction.
`CmsRelationFilter`	`filterUserDefined()` Returns an extended filter with user defined type restriction.
`CmsRelationFilter`	`filterWeak()` Returns an extended filter with weak type restriction.
`java.lang.String`	`getPath()` Returns the source relation path restriction.
`CmsUUID`	`getStructureId()` Returns the structure Id of the resource to filter.
`java.util.Set<CmsRelationType>`	`getTypes()` Returns the types to filter.
`boolean`	`includesDefinedInContent()` Checks if this filter includes relations defined in the content.
`boolean`	`isIncludeSubresources()` Returns the include subresources flag.
`boolean`	`isSource()` Returns the source flag.
`boolean`	`isTarget()` Returns the target flag.
`boolean`	`matchType(CmsRelationType type)` Returns `true` if the given relation type matches this filter.
`static CmsRelationFilter`	`relationsFromStructureId(CmsUUID structureId)` Utility method which prepares a filter for relations which point from a given structure id.
`static CmsRelationFilter`	`relationsToStructureId(CmsUUID structureId)` Utility method which prepares a filter for relations which point to a given structure id.
`java.lang.String`	`toString()`

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

- 字段详细资料
  - ALL
```
public static final CmsRelationFilter ALL
```
    To filter all sources and targets.
  - SOURCES
```
public static final CmsRelationFilter SOURCES
```
    To filter all sources.
  - TARGETS
```
public static final CmsRelationFilter TARGETS
```
    To filter all targets.
- 方法详细资料
  - relationsFromStructureId
```
public static CmsRelationFilter relationsFromStructureId(CmsUUID structureId)
```
    Utility method which prepares a filter for relations which point *from* a given structure id.
    
    参数:
    structureId - the structure id
    
    返回:
    the new relation filter
  - relationsToStructureId
```
public static CmsRelationFilter relationsToStructureId(CmsUUID structureId)
```
    Utility method which prepares a filter for relations which point *to* a given structure id.
    
    参数:
    structureId - the structure id
    
    返回:
    the new relation filter
  - clone
```
public java.lang.Object clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object
    
    另请参阅:
    Object.clone()
  - filterDefinedInContent
```
public CmsRelationFilter filterDefinedInContent()
```
    Returns an extended filter with defined in content type restriction.
    
    返回:
    an extended filter with defined in content type restriction
  - filterIncludeChildren
```
public CmsRelationFilter filterIncludeChildren()
```
    Returns an extended filter that will extend the result to the given path and all its subresources.
    
    返回:
    an extended filter with including subresources
  - filterInternal
```
public CmsRelationFilter filterInternal()
```
    Returns an extended filter with internal type restriction.
    
    返回:
    an extended filter with internal type restriction
  - filterNotDefinedInContent
```
public CmsRelationFilter filterNotDefinedInContent()
```
    Returns an extended filter with not defined in content type restriction.
    
    返回:
    an extended filter with not defined in content type restriction
  - filterPath
```
public CmsRelationFilter filterPath(java.lang.String path)
```
    Returns an extended filter with the given source relation path restriction.
    
    参数:
    path - the source relation path to filter
    
    返回:
    an extended filter with the given source relation path restriction
  - filterResource
```
public CmsRelationFilter filterResource(CmsResource resource)
```
    Returns an extended filter with the given resource (path and id) restriction.
    
    参数:
    resource - the resource to filter
    
    返回:
    an extended filter with the given resource (path and id) restriction
  - filterStrong
```
public CmsRelationFilter filterStrong()
```
    Returns an extended filter with strong type restriction.
    
    返回:
    an extended filter with strong type restriction
  - filterStructureId
```
public CmsRelationFilter filterStructureId(CmsUUID structureId)
```
    Returns an extended filter with the given structure id restriction.
    
    参数:
    structureId - the structure id to filter
    
    返回:
    an extended filter with the given structure id restriction
  - filterType
```
public CmsRelationFilter filterType(CmsRelationType type)
```
    Returns an extended filter with the given type restriction.
    
    参数:
    type - the relation type to filter
    
    返回:
    an extended filter with the given type restriction
  - filterUserDefined
```
public CmsRelationFilter filterUserDefined()
```
    Returns an extended filter with user defined type restriction.
    
    返回:
    an extended filter with user defined type restriction
  - filterWeak
```
public CmsRelationFilter filterWeak()
```
    Returns an extended filter with weak type restriction.
    
    返回:
    an extended filter with weak type restriction
  - getPath
```
public java.lang.String getPath()
```
    Returns the source relation path restriction.
    
    返回:
    the source relation path restriction
  - getStructureId
```
public CmsUUID getStructureId()
```
    Returns the structure Id of the resource to filter.
    
    返回:
    the structure Id of the resource to filter
  - getTypes
```
public java.util.Set<CmsRelationType> getTypes()
```
    Returns the types to filter.
    
    返回:
    the types to filter
  - includesDefinedInContent
```
public boolean includesDefinedInContent()
```
    Checks if this filter includes relations defined in the content.
    
    返回:
    true if this filter includes relations defined in the content
  - isIncludeSubresources
```
public boolean isIncludeSubresources()
```
    Returns the include subresources flag.
    
    返回:
    if set the filter extends the result to the given path and all its subresources
  - isSource
```
public boolean isSource()
```
    Returns the source flag.
    
    返回:
    if set the filter looks for matching targets
  - isTarget
```
public boolean isTarget()
```
    Returns the target flag.
    
    返回:
    if set the filter looks for matching sources
  - matchType
```
public boolean matchType(CmsRelationType type)
```
    Returns true if the given relation type matches this filter.
    
    参数:
    type - the relation type to test
    
    返回:
    if the given relation type matches this filter
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
    
    另请参阅:
    Object.toString()

类 CmsRelationFilter

字段概要

方法概要

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

字段详细资料

ALL

SOURCES

TARGETS

方法详细资料

relationsFromStructureId

relationsToStructureId

clone

filterDefinedInContent

filterIncludeChildren

filterInternal

filterNotDefinedInContent

filterPath

filterResource

filterStrong

filterStructureId

filterType

filterUserDefined

filterWeak

getPath

getStructureId

getTypes

includesDefinedInContent

isIncludeSubresources

isSource

isTarget

matchType

toString