Package org.alfresco.repo.node.getchildren

Class GetChildrenCannedQuery

java.lang.Object

org.alfresco.query.AbstractCannedQuery<R>

org.alfresco.repo.security.permissions.impl.acegi.AbstractCannedQueryPermissions<NodeRef>

org.alfresco.repo.node.getchildren.GetChildrenCannedQuery

All Implemented Interfaces:

org.alfresco.query.CannedQuery<NodeRef>

Direct Known Subclasses:

GetChildrenCannedQuery

public class GetChildrenCannedQuery
extends AbstractCannedQueryPermissions<NodeRef>

GetChildren canned query To get paged list of children of a parent node filtered by child type. Also optionally filtered and/or sorted by one or more properties (up to three).

Since:

4.0

Author:

janv

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	GetChildrenCannedQuery.DefaultFilterSortChildQueryCallback
protected class	GetChildrenCannedQuery.DefaultUnsortedChildQueryCallback
protected static interface	GetChildrenCannedQuery.FilterSortChildQueryCallback
protected class	GetChildrenCannedQuery.FilterSortNode
protected class	GetChildrenCannedQuery.FilterSortResultHandler
protected static interface	GetChildrenCannedQuery.UnsortedChildQueryCallback

Field Summary

Fields

Modifier and Type	Field	Description
protected CannedQueryDAO	cannedQueryDAO
static final QName	FILTER_QNAME_NODE_IS_PRIMARY
static final int	MAX_FILTER_SORT_PROPS
protected NodeDAO	nodeDAO
protected NodePropertyHelper	nodePropertyHelper
protected NodeService	nodeService
protected QNameDAO	qnameDAO
protected static final String	QUERY_NAMESPACE
protected static final String	QUERY_SELECT_GET_CHILDREN_WITH_PROPS
protected static final String	QUERY_SELECT_GET_CHILDREN_WITHOUT_PROPS
static final QName	SORT_QNAME_CONTENT_MIMETYPE
static final QName	SORT_QNAME_CONTENT_SIZE
static final QName	SORT_QNAME_NODE_IS_FOLDER
static final QName	SORT_QNAME_NODE_TYPE
protected TenantService	tenantService

Fields inherited from class org.alfresco.query.AbstractCannedQuery

parameters, queryExecutionId

Constructor Summary

Constructors

Constructor	Description
GetChildrenCannedQuery(NodeDAO nodeDAO, QNameDAO qnameDAO, CannedQueryDAO cannedQueryDAO, NodePropertyHelper nodePropertyHelper, TenantService tenantService, NodeService nodeService, MethodSecurityBean<NodeRef> methodSecurity, org.alfresco.query.CannedQueryParameters params)

Method Summary

Modifier and Type	Method	Description
protected List<NodeRef>	applyPostQueryPermissions(List<NodeRef> results, int requestedCount)
protected List<NodeRef>	executeQuery(List<FilterProp> filterProps, List<Pair<QName,org.alfresco.query.CannedQuerySortDetails.SortOrder>> sortPairs, FilterSortNodeEntity params, GetChildrenCannedQueryParams paramBean, int filterSortPropCnt)
protected GetChildrenCannedQuery.FilterSortChildQueryCallback	getFilterSortChildQuery(List<GetChildrenCannedQuery.FilterSortNode> children, List<FilterProp> filterProps, GetChildrenCannedQueryParams paramBean)
protected GetChildrenCannedQuery.UnsortedChildQueryCallback	getUnsortedChildQueryCallback(List<NodeRef> rawResult, int requestedCount, GetChildrenCannedQueryParams paramBean)
protected boolean	includeAspects(NodeRef nodeRef, Set<QName> inclusiveAspects, Set<QName> exclusiveAspects)
protected boolean	isApplyPostQueryPermissions()
protected boolean	isApplyPostQuerySorting()
protected List<NodeRef>	queryAndFilter(org.alfresco.query.CannedQueryParameters parameters)

Methods inherited from class org.alfresco.repo.security.permissions.impl.acegi.AbstractCannedQueryPermissions

getTotalResultCount

Methods inherited from class org.alfresco.query.AbstractCannedQuery

applyPostQueryPaging, applyPostQuerySorting, createCannedQueryResults, execute, getParameters, isApplyPostQueryPaging, toString

Methods inherited from class java.lang.Object

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

Field Details

QUERY_NAMESPACE

protected static final String QUERY_NAMESPACE

See Also:

• Constant Field Values

QUERY_SELECT_GET_CHILDREN_WITH_PROPS

protected static final String QUERY_SELECT_GET_CHILDREN_WITH_PROPS

See Also:

• Constant Field Values

QUERY_SELECT_GET_CHILDREN_WITHOUT_PROPS

protected static final String QUERY_SELECT_GET_CHILDREN_WITHOUT_PROPS

See Also:

• Constant Field Values

MAX_FILTER_SORT_PROPS

public static final int MAX_FILTER_SORT_PROPS

See Also:

• Constant Field Values

SORT_QNAME_CONTENT_SIZE

public static final QName SORT_QNAME_CONTENT_SIZE

SORT_QNAME_CONTENT_MIMETYPE

public static final QName SORT_QNAME_CONTENT_MIMETYPE

SORT_QNAME_NODE_TYPE

public static final QName SORT_QNAME_NODE_TYPE

SORT_QNAME_NODE_IS_FOLDER

public static final QName SORT_QNAME_NODE_IS_FOLDER

FILTER_QNAME_NODE_IS_PRIMARY

public static final QName FILTER_QNAME_NODE_IS_PRIMARY

nodeDAO

protected NodeDAO nodeDAO

qnameDAO

protected QNameDAO qnameDAO

cannedQueryDAO

protected CannedQueryDAO cannedQueryDAO

nodePropertyHelper

protected NodePropertyHelper nodePropertyHelper

tenantService

protected TenantService tenantService

nodeService

protected NodeService nodeService

Constructor Details

GetChildrenCannedQuery

public GetChildrenCannedQuery(NodeDAO nodeDAO,
 QNameDAO qnameDAO,
 CannedQueryDAO cannedQueryDAO,
 NodePropertyHelper nodePropertyHelper,
 TenantService tenantService,
 NodeService nodeService,
 MethodSecurityBean<NodeRef> methodSecurity,
 org.alfresco.query.CannedQueryParameters params)

Method Details

getFilterSortChildQuery

protected GetChildrenCannedQuery.FilterSortChildQueryCallback getFilterSortChildQuery(List<GetChildrenCannedQuery.FilterSortNode> children,
 List<FilterProp> filterProps,
 GetChildrenCannedQueryParams paramBean)

getUnsortedChildQueryCallback

protected GetChildrenCannedQuery.UnsortedChildQueryCallback getUnsortedChildQueryCallback(List<NodeRef> rawResult,
 int requestedCount,
 GetChildrenCannedQueryParams paramBean)

queryAndFilter

protected List<NodeRef> queryAndFilter(org.alfresco.query.CannedQueryParameters parameters)

Specified by:

queryAndFilter in class org.alfresco.query.AbstractCannedQuery<NodeRef>

executeQuery

protected List<NodeRef> executeQuery(List<FilterProp> filterProps,
 List<Pair<QName,org.alfresco.query.CannedQuerySortDetails.SortOrder>> sortPairs,
 FilterSortNodeEntity params,
 GetChildrenCannedQueryParams paramBean,
 int filterSortPropCnt)

isApplyPostQuerySorting

protected boolean isApplyPostQuerySorting()

Overrides:

isApplyPostQuerySorting in class org.alfresco.query.AbstractCannedQuery<NodeRef>

includeAspects

protected boolean includeAspects(NodeRef nodeRef,
 Set<QName> inclusiveAspects,
 Set<QName> exclusiveAspects)

isApplyPostQueryPermissions

protected boolean isApplyPostQueryPermissions()

Description copied from class: AbstractCannedQueryPermissions

By default, the is a permission checking class. Override the method if you wish to switch the behaviour at runtime.

Overrides:

isApplyPostQueryPermissions in class AbstractCannedQueryPermissions<NodeRef>

Returns:

true always

applyPostQueryPermissions

protected List<NodeRef> applyPostQueryPermissions(List<NodeRef> results,
 int requestedCount)

Overrides:

applyPostQueryPermissions in class AbstractCannedQueryPermissions<NodeRef>