|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.relations.CmsRelationFilter
A filter to retrieve the relations for a given resource.
Field Summary | |
static CmsRelationFilter |
ALL
To filter all sources and targets. |
static CmsRelationFilter |
SOURCES
To filter all sources. |
static CmsRelationFilter |
TARGETS
To filter all targets. |
Method Summary | |
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 |
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. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final CmsRelationFilter ALL
public static final CmsRelationFilter SOURCES
public static final CmsRelationFilter TARGETS
Method Detail |
public java.lang.Object clone()
Object.clone()
public CmsRelationFilter filterDefinedInContent()
public CmsRelationFilter filterIncludeChildren()
public CmsRelationFilter filterInternal()
public CmsRelationFilter filterNotDefinedInContent()
public CmsRelationFilter filterPath(java.lang.String path)
path
- the source relation path to filter
public CmsRelationFilter filterResource(CmsResource resource)
resource
- the resource to filter
public CmsRelationFilter filterStrong()
public CmsRelationFilter filterStructureId(CmsUUID structureId)
structureId
- the structure id to filter
public CmsRelationFilter filterType(CmsRelationType type)
type
- the relation type to filter
public CmsRelationFilter filterUserDefined()
public CmsRelationFilter filterWeak()
public java.lang.String getPath()
public CmsUUID getStructureId()
public java.util.Set getTypes()
public boolean includesDefinedInContent()
true
if this filter includes relations defined in the contentpublic boolean isIncludeSubresources()
public boolean isSource()
public boolean isTarget()
public boolean matchType(CmsRelationType type)
true
if the given relation type matches this filter.
type
- the relation type to test
public java.lang.String toString()
Object.toString()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |