org.geotools.filter.expression
Class FunctionBuilder

java.lang.Object
  extended by org.geotools.filter.expression.FunctionBuilder
All Implemented Interfaces:
Builder<org.opengis.filter.expression.Function>

public class FunctionBuilder
extends java.lang.Object
implements Builder<org.opengis.filter.expression.Function>


Field Summary
protected  org.opengis.filter.FilterFactory2 ff
           
 
Constructor Summary
FunctionBuilder()
           
FunctionBuilder(org.opengis.filter.expression.Function origional)
           
 
Method Summary
 org.opengis.filter.expression.Function build()
          Created object, may be null if unset()
 LiteralBuilder fallback()
          Literal fallback value to use if named function is not implemented
 FunctionBuilder fallback(java.lang.Object obj)
          Inline fallback value to use if named function is not implemented
 FunctionBuilder literal(java.lang.Object literal)
           
 FunctionBuilder name(java.lang.String function)
           
 org.geotools.filter.expression.FunctionBuilder.ParamBuilder param()
           
 org.geotools.filter.expression.FunctionBuilder.ParamBuilder param(int index)
           
 FunctionBuilder property(java.lang.String xpath)
           
 FunctionBuilder reset()
          Configure the Builder to produce a default result.
 FunctionBuilder reset(org.opengis.filter.expression.Function original)
          Configure the Builder to produce a copy of the provided original.
 FunctionBuilder unset()
          Configure the Builder to produce null.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ff

protected org.opengis.filter.FilterFactory2 ff
Constructor Detail

FunctionBuilder

public FunctionBuilder()

FunctionBuilder

public FunctionBuilder(org.opengis.filter.expression.Function origional)
Method Detail

param

public org.geotools.filter.expression.FunctionBuilder.ParamBuilder param()

literal

public FunctionBuilder literal(java.lang.Object literal)

property

public FunctionBuilder property(java.lang.String xpath)

param

public org.geotools.filter.expression.FunctionBuilder.ParamBuilder param(int index)

name

public FunctionBuilder name(java.lang.String function)

fallback

public FunctionBuilder fallback(java.lang.Object obj)
Inline fallback value to use if named function is not implemented


fallback

public LiteralBuilder fallback()
Literal fallback value to use if named function is not implemented


build

public org.opengis.filter.expression.Function build()
Description copied from interface: Builder
Created object, may be null if unset()

Specified by:
build in interface Builder<org.opengis.filter.expression.Function>
Returns:
Created object may be null if unset()

reset

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

Specified by:
reset in interface Builder<org.opengis.filter.expression.Function>
Returns:
Builder configured to produce a default result.

reset

public FunctionBuilder reset(org.opengis.filter.expression.Function original)
Description copied from interface: Builder
Configure the Builder to produce a copy of the provided original.

Specified by:
reset in interface Builder<org.opengis.filter.expression.Function>
Returns:
Builder configured to produce the provided original

unset

public FunctionBuilder 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<org.opengis.filter.expression.Function>
Returns:
Builder configured to build null


Copyright © 1996-2010 Geotools. All Rights Reserved.