Filter Classes

This section describes information that is specific to the Java API. See User-Defined Filter for general information about implementing the UDFilter and FilterFactory classes.

UDFilter API

The API provides the following methods for extension by subclasses:

public void setup(ServerInterface srvInterface) throws UdfException;
				
public abstract StreamState process(ServerInterface srvInterface, DataBuffer input, 
				InputState input_state, DataBuffer output) 
	throws UdfException;
				
protected void cancel(ServerInterface srvInterface);
				
public void destroy(ServerInterface srvInterface) throws UdfException;

FilterFactory API

The API provides the following methods for extension by subclasses:

public void plan(ServerInterface srvInterface, PlanContext planCtxt)
	throws UdfException;
				
public abstract UDFilter prepare(ServerInterface srvInterface, PlanContext planCtxt) 
	throws UdfException;
				
public void getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes);