com.facebook.buck.query

Class FilterFunction<NODE_TYPE>

java.lang.Object

com.facebook.buck.query.FilterFunction<NODE_TYPE>

All Implemented Interfaces:

QueryEnvironment.QueryFunction<QueryTarget,NODE_TYPE>

public class FilterFunction<NODE_TYPE>
extends Object

A filter(pattern, argument) expression, evaluates its argument and filters the resulting targets by applying the given regular expression pattern to the targets' names.

expr ::= FILTER '(' WORD ',' expr ')'

Constructor Summary

Constructors

Constructor and Description
FilterFunction()

Method Summary

Modifier and Type	Method and Description
Set<T>	eval(QueryEvaluator<ENV_NODE_TYPE> evaluator, QueryEnvironment<ENV_NODE_TYPE> env, com.google.common.collect.ImmutableList<QueryEnvironment.Argument<ENV_NODE_TYPE>> args) Called when a user-defined function is to be evaluated.
com.google.common.collect.ImmutableList<QueryEnvironment.ArgumentType>	getArgumentTypes() The types of the arguments of the function.
protected QueryExpression<NODE_TYPE>	getExpressionToEval(com.google.common.collect.ImmutableList<QueryEnvironment.Argument<NODE_TYPE>> args)
int	getMandatoryArguments() The number of arguments that are required.
String	getName() Name of the function as it appears in the query language.
protected String	getPattern(com.google.common.collect.ImmutableList<QueryEnvironment.Argument<NODE_TYPE>> args)
protected String	getStringToFilter(QueryEnvironment<NODE_TYPE> env, com.google.common.collect.ImmutableList<QueryEnvironment.Argument<NODE_TYPE>> args, QueryTarget target)

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterFunction

public FilterFunction()

Method Detail

getName

public String getName()

Description copied from interface: QueryEnvironment.QueryFunction

Name of the function as it appears in the query language.

getMandatoryArguments

public int getMandatoryArguments()

Description copied from interface: QueryEnvironment.QueryFunction

The number of arguments that are required. The rest is optional.

This should be greater than or equal to zero and at smaller than or equal to the length of the list returned by QueryEnvironment.QueryFunction.getArgumentTypes().

getArgumentTypes

public com.google.common.collect.ImmutableList<QueryEnvironment.ArgumentType> getArgumentTypes()

Description copied from interface: QueryEnvironment.QueryFunction

The types of the arguments of the function.

getExpressionToEval

protected QueryExpression<NODE_TYPE> getExpressionToEval(com.google.common.collect.ImmutableList<QueryEnvironment.Argument<NODE_TYPE>> args)

getPattern

protected String getPattern(com.google.common.collect.ImmutableList<QueryEnvironment.Argument<NODE_TYPE>> args)

getStringToFilter

protected String getStringToFilter(QueryEnvironment<NODE_TYPE> env,
                                   com.google.common.collect.ImmutableList<QueryEnvironment.Argument<NODE_TYPE>> args,
                                   QueryTarget target)

eval

public Set<T> eval(QueryEvaluator<ENV_NODE_TYPE> evaluator,
                   QueryEnvironment<ENV_NODE_TYPE> env,
                   com.google.common.collect.ImmutableList<QueryEnvironment.Argument<ENV_NODE_TYPE>> args)
            throws QueryException

Description copied from interface: QueryEnvironment.QueryFunction

Called when a user-defined function is to be evaluated.

Specified by:

eval in interface QueryEnvironment.QueryFunction<T extends QueryTarget,ENV_NODE_TYPE>

Parameters:

evaluator - the evaluator for evaluating argument expressions.

env - the query environment this function is evaluated in.

args - the input arguments. These are type-checked against the specification returned by QueryEnvironment.QueryFunction.getArgumentTypes() and QueryEnvironment.QueryFunction.getMandatoryArguments()

Returns:

results of evaluating the query expression. The result type is mutable Set to enable actual implementation to avoid making unnecessary copies, but resulting set is not supposed to be mutated afterwards so implementation is ok to return ImmutableSet.

Throws:

QueryException