org.nuxeo.ecm.core.api.tree

Class DefaultDocumentTreeFilter

java.lang.Object

org.nuxeo.ecm.core.api.tree.DefaultDocumentTreeFilter

All Implemented Interfaces:

Serializable, Filter, DocumentTreeFilter

public class DefaultDocumentTreeFilter
extends Object
implements DocumentTreeFilter

Default filter for tree elements.

Filters using facets and types criteria. Also filters documents that are in the "deleted" life cycle state.

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	excludedFacets
protected List<String>	excludedTypes
protected List<String>	includedFacets

Constructor Summary

Constructors

Constructor and Description
DefaultDocumentTreeFilter()

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentModel document) Filters data models objects.
List<String>	getExcludedFacets()
List<String>	getExcludedTypes()
List<String>	getIncludedFacets()
void	setExcludedFacets(List<String> excludedFacets)
void	setExcludedTypes(List<String> excludedTypes)
void	setIncludedFacets(List<String> includedFacets)

Methods inherited from class java.lang.Object

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

Field Detail

includedFacets

protected List<String> includedFacets

excludedFacets

protected List<String> excludedFacets

excludedTypes

protected List<String> excludedTypes

Constructor Detail

DefaultDocumentTreeFilter

public DefaultDocumentTreeFilter()

Method Detail

accept

public boolean accept(DocumentModel document)

Description copied from interface: Filter

Filters data models objects.

Specified by:

accept in interface Filter

Returns:

true if accepting the object false otherwise

getIncludedFacets

public List<String> getIncludedFacets()

Specified by:

getIncludedFacets in interface DocumentTreeFilter

setIncludedFacets

public void setIncludedFacets(List<String> includedFacets)

Specified by:

setIncludedFacets in interface DocumentTreeFilter

getExcludedFacets

public List<String> getExcludedFacets()

Specified by:

getExcludedFacets in interface DocumentTreeFilter

setExcludedFacets

public void setExcludedFacets(List<String> excludedFacets)

Specified by:

setExcludedFacets in interface DocumentTreeFilter

getExcludedTypes

public List<String> getExcludedTypes()

Specified by:

getExcludedTypes in interface DocumentTreeFilter

setExcludedTypes

public void setExcludedTypes(List<String> excludedTypes)

Specified by:

setExcludedTypes in interface DocumentTreeFilter