org.geotools.filter
Class FilterBuilder

Object
  extended by FilterBuilder
All Implemented Interfaces:
Builder<Filter>
Direct Known Subclasses:
SubFilterBuilder

public class FilterBuilder
extends Object
implements Builder<Filter>

FitlerBuilder acting as a simple wrapper around an Expression.

Module:
modules/extension/brewer (gt-brewer.jar)

Field Summary
protected  Builder<? extends Filter> delegate
           
protected  FilterFactory ff
           
protected  Filter filter
           
protected  boolean unset
           
 
Constructor Summary
FilterBuilder()
           
FilterBuilder(Filter filter)
           
 
Method Summary
 Filter build()
          Build the expression.
 FilterBuilder reset()
          Configure the Builder to produce a default result.
 FilterBuilder reset(Filter filter)
          Configure the Builder to produce a copy of the provided original.
 FilterBuilder unset()
          Configure the Builder to produce null.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

filter

protected Filter filter

ff

protected FilterFactory ff

unset

protected boolean unset

delegate

protected Builder<? extends Filter> delegate
Constructor Detail

FilterBuilder

public FilterBuilder()

FilterBuilder

public FilterBuilder(Filter filter)
Method Detail

build

public Filter build()
Build the expression.

Specified by:
build in interface Builder<Filter>
Returns:
Created object may be null if unset()

reset

public FilterBuilder reset()
Description copied from interface: Builder
Configure the Builder to produce a default result.

Specified by:
reset in interface Builder<Filter>
Returns:
Builder configured to produce a default result.

reset

public FilterBuilder reset(Filter filter)
Description copied from interface: Builder
Configure the Builder to produce a copy of the provided original.

Specified by:
reset in interface Builder<Filter>
Returns:
Builder configured to produce the provided original

unset

public FilterBuilder unset()
Description copied from interface: Builder
Configure the Builder to produce null.

This method allows a Builder to be used as a placeholder; in its unset state the build() method will produce null. If any of the builder methods are used the builder will produce a result.

Specified by:
unset in interface Builder<Filter>
Returns:
Builder configured to build null


Copyright © 1996-2009 Geotools. All Rights Reserved.