/*
* Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* bstefanescu
*/
package org.eclipse.ecr.automation.core.operations.document;
import java.util.HashSet;
import java.util.Set;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.eclipse.ecr.automation.OperationContext;
import org.eclipse.ecr.automation.core.Constants;
import org.eclipse.ecr.automation.core.annotations.Context;
import org.eclipse.ecr.automation.core.annotations.Operation;
import org.eclipse.ecr.automation.core.annotations.OperationMethod;
import org.eclipse.ecr.automation.core.annotations.Param;
import org.eclipse.ecr.automation.core.events.DocumentAttributeFilterFactory;
import org.eclipse.ecr.automation.core.scripting.Expression;
import org.eclipse.ecr.automation.core.scripting.Scripting;
import org.eclipse.ecr.core.api.DocumentModel;
import org.eclipse.ecr.core.api.DocumentModelList;
import org.eclipse.ecr.core.api.Filter;
import org.eclipse.ecr.core.api.impl.DocumentModelListImpl;
import org.nuxeo.common.utils.StringUtils;
/**
*
* @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
*/
@Operation(id = FilterDocuments.ID, category = Constants.CAT_DOCUMENT, label = "Filter List", description = "Filter the input list of documents given a condition. The condition can be expressed using 4 parameters: types, facets, lifecycle and condition. If more than one parameter is specified an AND will be used to group conditions. <br>The 'types' paramter can take a comma separated list of document type: File,Note.<br>The 'facet' parameter can take a single facet name.<br> The 'life cycle' parameter takes a name of a life cycle state the document should have.<br>The 'condition' parameter can take any EL expression.<p>Returns the list of documents that match the filter condition.")
public class FilterDocuments {
private static final Log log = LogFactory.getLog(FilterDocuments.class);
public static final String ID = "Document.Filter";
@Context
protected OperationContext ctx;
@Param(name = "types", required = false)
protected String types; // comma separated list.
@Param(name = "facet", required = false)
protected String facet;
@Param(name = "lifecycle", required = false)
protected String lifeCycle;
@Param(name = "pathStartsWith", required = false)
protected String pathStartsWith;
@Param(name = "condition", required = false)
protected String condition;
@Param(name = "class", required = false, widget = Constants.W_OPTION, values = {
DocumentAttributeFilterFactory.ANY_DOC,
DocumentAttributeFilterFactory.REGULAR_DOC,
DocumentAttributeFilterFactory.LINK_DOC,
DocumentAttributeFilterFactory.PUBLISHED_DOC,
DocumentAttributeFilterFactory.PROXY_DOC,
DocumentAttributeFilterFactory.VERSION_DOC,
DocumentAttributeFilterFactory.IMMUTABLE_DOC,
DocumentAttributeFilterFactory.MUTABLE_DOC })
protected String attr;
@OperationMethod
public DocumentModelList run(DocumentModelList docs) {
Condition cond = new Condition();
DocumentModelList result = new DocumentModelListImpl();
for (DocumentModel doc : docs) {
if (cond.accept(doc)) {
result.add(doc);
}
}
return result;
}
protected class Condition implements Filter {
private static final long serialVersionUID = 1L;
Set<String> types;
String facet;
String lc;
Expression expr;
Filter attr;
Condition() {
String v = FilterDocuments.this.types;
if (v != null) {
v = v.trim();
if (v.length() > 0) {
types = new HashSet<String>();
for (String t : StringUtils.split(v, ',', true)) {
types.add(t);
}
}
}
v = FilterDocuments.this.facet;
if (v != null) {
v = v.trim();
if (v.length() > 0) {
facet = v;
}
}
v = FilterDocuments.this.lifeCycle;
if (v != null) {
v = v.trim();
if (v.length() > 0) {
lc = v;
}
}
v = FilterDocuments.this.condition;
if (v != null) {
v = v.trim();
if (v.length() > 0) {
expr = Scripting.newExpression(v);
}
}
v = FilterDocuments.this.attr;
if (v != null) {
attr = DocumentAttributeFilterFactory.getFilter(v);
}
}
public boolean accept(DocumentModel doc) {
if (types != null) {
if (!types.contains(doc.getType())) {
return false;
}
}
if (facet != null) {
if (!doc.getFacets().contains(facet)) {
return false;
}
}
if (lc != null) {
try {
if (!lc.equals(doc.getCurrentLifeCycleState())) {
return false;
}
} catch (Exception e) {
log.error(e, e);
}
}
if (attr != null) {
if (!attr.accept(doc)) {
return false;
}
}
if (expr != null) {
try {
if (!(Boolean) expr.eval(ctx)) {
return false;
}
} catch (Exception e) {
log.error(e, e);
}
}
return true;
}
}
}