org.geotools.filter.expression
Class FormatDateTimezoneFunction

Object
  extended by FormatDateTimezoneFunction
All Implemented Interfaces:
Expression, Function

public class FormatDateTimezoneFunction
extends Object
implements Function

Function to format a time given as a Date using a SimpleDateFormat pattern in a time zone supported by TimeZone.

Arguments:

  1. pattern: formatting pattern supported by SimpleDateFormat, for example "yyyy-MM-dd".
  2. date: the Date for the time to be formatted or its string representation, for example "1948-01-01T00:00:00Z". A RuntimeException with be thrown if the date is invalid.
  3. timezone: the name of a time zone supported by TimeZone, for example "UTC" or "Canada/Mountain". Note that unrecognised timezones will silently be converted to UTC.

Author:
Ben Caradoc-Davies (CSIRO Earth Science and Resource Engineering)

Field Summary
static FunctionName NAME
           
 
Fields inherited from interface Expression
NIL
 
Constructor Summary
FormatDateTimezoneFunction()
           
FormatDateTimezoneFunction(List<Expression> parameters, Literal fallback)
           
 
Method Summary
 Object accept(ExpressionVisitor visitor, Object extraData)
          Accepts a visitor.
 Object evaluate(Object object)
          Evaluates the given expression based on the content of the given object.
<T> T
evaluate(Object object, Class<T> context)
          Evaluates the given expressoin based on the content of the given object and the context type.
 Literal getFallbackValue()
          The value of the fallbackValue attribute is used as a default value, if the SE implementation does not support the function.
 FunctionName getFunctionName()
          Access to the FunctionName description as used in a FilterCapabilities document.
 String getName()
          Returns the name of the function to be called.
 List<Expression> getParameters()
          Returns the list subexpressions that will be evaluated to provide the parameters to the function.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME

public static final FunctionName NAME
Constructor Detail

FormatDateTimezoneFunction

public FormatDateTimezoneFunction()

FormatDateTimezoneFunction

public FormatDateTimezoneFunction(List<Expression> parameters,
                                  Literal fallback)
Method Detail

accept

public Object accept(ExpressionVisitor visitor,
                     Object extraData)
Description copied from interface: Expression
Accepts a visitor. Subclasses must implement with a method whose content is the following:
return visitor.visit(this, extraData);

Specified by:
accept in interface Expression

evaluate

public Object evaluate(Object object)
Description copied from interface: Expression
Evaluates the given expression based on the content of the given object.

Specified by:
evaluate in interface Expression

evaluate

public <T> T evaluate(Object object,
                      Class<T> context)
Description copied from interface: Expression
Evaluates the given expressoin based on the content of the given object and the context type.

The context parameter is used to control the type of the result of the expression. A particular expression may not be able to evaluate to an instance of context. Therefore to be safe calling code should do a null check on the return value of this method, and call Expression.evaluate(Object) if neccessary. Example:

  Object input = ...;
  String result = expression.evaluate( input, String.class );
  if ( result == null ) {
     result = expression.evalute( input ).toString();
  }
  ...
 

Implementations that can not return a result as an instance of context should return null.

Specified by:
evaluate in interface Expression
Type Parameters:
T - The type of the returned object.
Parameters:
object - The object to evaluate the expression against.
context - The type of the resulting value of the expression.
Returns:
Evaluates the given expression based on the content of the given object an an instance of context.

getFallbackValue

public Literal getFallbackValue()
Description copied from interface: Function
The value of the fallbackValue attribute is used as a default value, if the SE implementation does not support the function. If the implementation supports the function, then the result value is determined by executing the function.

Specified by:
getFallbackValue in interface Function
Returns:
Optional literal to use if an implementation for this function is not available.

getFunctionName

public FunctionName getFunctionName()
Description copied from interface: Function
Access to the FunctionName description as used in a FilterCapabilities document.

Specified by:
getFunctionName in interface Function
Returns:
FunctionName description, if available.

getName

public String getName()
Description copied from interface: Function
Returns the name of the function to be called. For example, this might be "cos" or "atan2".

You can use this name to look up the number of required parameters in a FilterCapabilities data structure. For the specific meaning of the required parameters you will need to consult the documentation.

Specified by:
getName in interface Function

getParameters

public List<Expression> getParameters()
Description copied from interface: Function
Returns the list subexpressions that will be evaluated to provide the parameters to the function.

Specified by:
getParameters in interface Function


Copyright © 1996-2014 Geotools. All Rights Reserved.