org.geotools.filter
Class FilterBuilder2

Object
  FilterBuilder2

public class FilterBuilder2
extends Object

Facilitate the building of Filters and Expressions by maintaining state.

This builder let's you chain together expressions using Java methods:

 FilterBuilder build = new FilterBuilder();
 
 Expression expression = build.name( "cos" ).attribute( "theta" ).function().add().attribute( "x" ) ).expr();
 Filter filter = build.attribute( "y" ).greater().literal( 1.0 ) ).filter();
 

It also supports nested use:

 Expression expression = build.name("cos").property("theta").add(
                build.attribute("x"));
 
 Filter filter = build.attribute("y").greater(build.literal(1.0));
 

This works in the following ways:

• state is maintained, expression "pile up" in a stack until used
• infix operations, such as add() transfer the existing expression to the right hand side, all The following state is of interest:

  Author:

  Jody Garnett, Refractions Research Inc.

  method	left	right
  and

  Constructor Summary

  FilterBuilder2()
  Create a FilterBuilder with the "default" FilterFactory.

  FilterBuilder2(FilterFactory filterFactory)
  Create a FilterBuilder using the provided Factory.

  FilterBuilder2(Hints hints)
  Create a FilterBuilder using the provided Hints.

  Method Summary

  FilterBuilder2	add()
  FilterBuilder2	add(double number)
  FilterBuilder2	add(Expression right)
  FilterBuilder2	add(FilterBuilder2 build)
  FilterBuilder2	add(int number)
  FilterBuilder2	add(long number)
  FilterBuilder2	add(Object number)
  FilterBuilder2	and() Collapse all built filters into a single AND filter.
  FilterBuilder2	and(Filter right) A.and( B )
  FilterBuilder2	and(FilterBuilder build) A.and( B )
  Object	build() Churns through builder state building as much as is completed.
  FilterBuilder2	divide() Example: build.literal(1.0).literal("2").divide();
  FilterBuilder2	divide(double number)
  FilterBuilder2	divide(Expression right)
  FilterBuilder2	divide(FilterBuilder build)
  FilterBuilder2	divide(long number)
  Expression	expr()
  FilterBuilder2	expression(int position, Expression expr)
  Filter	filter() Create a Filter based on builder state.
  FilterBuilder2	filter(Filter filter)
  void	init()
  FilterBuilder2	left(Expression left)
  FilterBuilder2	literal(byte number)
  FilterBuilder2	literal(double number)
  FilterBuilder2	literal(int number)
  FilterBuilder2	literal(long number)
  FilterBuilder2	literal(Object object)
  FilterBuilder2	literal(short number)
  FilterBuilder2	multiply()
  FilterBuilder2	multiply(double number)
  FilterBuilder2	multiply(Expression right)
  FilterBuilder2	multiply(FilterBuilder build)
  FilterBuilder2	multiply(long number)
  FilterBuilder2	multiply(Object number)
  FilterBuilder2	or() Take all built filters and return a single OR statement.
  FilterBuilder2	or(Filter right) A.and( B )
  FilterBuilder2	or(FilterBuilder build) A.and( B )
  FilterBuilder2	right(Expression right) Set the right expression (usually in refernece to an infix operator such as ADD.
  void	setExpression(int position, Expression expr)
  void	setFilterFactory(FilterFactory factory)
  void	setLeft(Expression left)
  void	setRight(Expression right) Set the right expression (in reference to an infix operator such as ADD).
  FilterBuilder2	subtract() Sets the builder into "subtract" mode.
  FilterBuilder2	subtract(double number)
  FilterBuilder2	subtract(Expression right)
  FilterBuilder2	subtract(FilterBuilder build)
  FilterBuilder2	subtract(long number)
  FilterBuilder2	subtract(Object number)

  Methods inherited from class Object

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

  Constructor Detail

  FilterBuilder2

  public FilterBuilder2()

  Create a FilterBuilder with the "default" FilterFactory.

  The default filter factory is produced using: CommonFactoryFinder.getFilterFactory(null)

  FilterBuilder2

  public FilterBuilder2(Hints hints)

  Create a FilterBuilder using the provided Hints.

  The filter factory is produced using: CommonFactoryFinder.getFilterFactory(hints)

  Parameters:

  hints - Used to control the selection of a FilterFactory implementation

  FilterBuilder2

  public FilterBuilder2(FilterFactory filterFactory)

  Create a FilterBuilder using the provided Factory.

  Parameters:

  filterFactory -

  Method Detail

  literal

  public FilterBuilder2 literal(byte number)

  literal

  public FilterBuilder2 literal(short number)

  literal

  public FilterBuilder2 literal(int number)

  literal

  public FilterBuilder2 literal(long number)

  literal

  public FilterBuilder2 literal(double number)

  literal

  public FilterBuilder2 literal(Object object)

  setFilterFactory

  public void setFilterFactory(FilterFactory factory)

  init

  public void init()

  expr

  public Expression expr()

  filter

  public Filter filter()

  Create a Filter based on builder state.

  build

  public Object build()

  Churns through builder state building as much as is completed.

  Returns:

  Value represented by builder

  left

  public FilterBuilder2 left(Expression left)

  setLeft

  public void setLeft(Expression left)

  right

  public FilterBuilder2 right(Expression right)

  Set the right expression (usually in refernece to an infix operator such as ADD.

  Example:build.left( expr1 ).right( expr2 ).add();

  Parameters:

  right -

  Returns:

  Builder for use in chaining

  setRight

  public void setRight(Expression right)

  Set the right expression (in reference to an infix operator such as ADD).

  Parameters:

  right -

  expression

  public FilterBuilder2 expression(int position,
                                   Expression expr)

  setExpression

  public void setExpression(int position,
                            Expression expr)

  filter

  public FilterBuilder2 filter(Filter filter)

  add

  public FilterBuilder2 add()

  add

  public FilterBuilder2 add(Object number)

  add

  public FilterBuilder2 add(int number)

  add

  public FilterBuilder2 add(long number)

  add

  public FilterBuilder2 add(double number)

  add

  public FilterBuilder2 add(FilterBuilder2 build)

  add

  public FilterBuilder2 add(Expression right)

  subtract

  public FilterBuilder2 subtract()

  Sets the builder into "subtract" mode.

  Example use (from nothing):

  • prefix: build.subtract().literal(1).literal(1);
  • infix: build.literal(1).subtract().literal(1);
  • postfix: build.literal(1).literal(2).subtract();

  Returns:

  builder with modified state

  subtract

  public FilterBuilder2 subtract(Object number)

  subtract

  public FilterBuilder2 subtract(long number)

  subtract

  public FilterBuilder2 subtract(double number)

  subtract

  public FilterBuilder2 subtract(FilterBuilder build)

  subtract

  public FilterBuilder2 subtract(Expression right)

  multiply

  public FilterBuilder2 multiply()

  multiply

  public FilterBuilder2 multiply(Object number)

  multiply

  public FilterBuilder2 multiply(long number)

  multiply

  public FilterBuilder2 multiply(double number)

  multiply

  public FilterBuilder2 multiply(FilterBuilder build)

  multiply

  public FilterBuilder2 multiply(Expression right)

  divide

  public FilterBuilder2 divide()

  Example: build.literal(1.0).literal("2").divide();

  Returns:

  division of the last two expressions

  divide

  public FilterBuilder2 divide(long number)

  divide

  public FilterBuilder2 divide(double number)

  divide

  public FilterBuilder2 divide(FilterBuilder build)

  divide

  public FilterBuilder2 divide(Expression right)

  and

  public FilterBuilder2 and()

  Collapse all built filters into a single AND filter.

  Example:

   build.property("age").less( build.literal( 23 );
   build.property("sex").equal( build.literal("male") );
   build.and();
   

  Returns all filters as an *And* filter.

  and

  public FilterBuilder2 and(FilterBuilder build)

  A.and( B )

  and

  public FilterBuilder2 and(Filter right)

  A.and( B )

  or

  public FilterBuilder2 or()

  Take all built filters and return a single OR statement.

  Examples:

  • build.or().filter( filter1 ).filter( filter2 ).filter( filter3);
  • build.filter( filter1 ).or().filter( filter2 );

  Returns:

  OR filter based on all previous content.

  or

  public FilterBuilder2 or(FilterBuilder build)

  A.and( B )

  or

  public FilterBuilder2 or(Filter right)

  A.and( B )