net.ggtools.grand.tasks
Class FilterType

java.lang.Object
  net.ggtools.grand.tasks.FilterType

public class FilterType
extends java.lang.Object

A meta class for graph filters. This class will be instanciated and configure by Ant and passed to graph task. On execution, the enclosing task need to call the checkParameters() method to check if the filter is properly configured and getFilter() to get the actual graph filter.

Author:

Christophe Labouisse

Constructor Summary

FilterType(org.apache.tools.ant.Project prj)
Creates a new filter typ.

Method Summary

(package private) void	checkParameters() Cheks if the filter parameters are correct.
GraphFilter	getFilter() Return the actual filter after creating it if needed.
java.lang.String	getFilterName()
void	setName(java.lang.String name) Sets the filter's name
void	setNode(java.lang.String node) Sets the filter's node name.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterType

public FilterType(org.apache.tools.ant.Project prj)

Creates a new filter typ.

Parameters:

prj - the owner's project.

Method Detail

checkParameters

void checkParameters()
               throws org.apache.tools.ant.BuildException

Cheks if the filter parameters are correct.

Throws:

org.apache.tools.ant.BuildException - if the parameters are not ok

getFilter

public GraphFilter getFilter()

Return the actual filter after creating it if needed.

Returns:

the actual filter.

setName

public void setName(java.lang.String name)

Sets the filter's name

Parameters:

name - filter's name

setNode

public void setNode(java.lang.String node)

Sets the filter's node name.

Parameters:

node - node's name.

getFilterName

public java.lang.String getFilterName()

Returns:

Returns the filterName.