|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.peace_tools.workspace.Filter
public class Filter
This class is meant to encapsulate the information and parameters for various filters used to filter out ESTs that may negatively impact clustering. Similar to many of the other classes, this class provides a convenient interface to marshall, unmarshall, and use work space configuration information. This class is a generic Filter class that is used to store information regarding all the filters used within a Job element.
Nested Class Summary | |
---|---|
static class |
Filter.FilterType
Different enumerations defining the different types of Filters that are currently supported. |
Field Summary | |
---|---|
private Filter.FilterType |
filterType
The name/type of this filter. |
private java.util.ArrayList<Param> |
parameters
The list of parameters that are simply managed as a name-value pair within this class. |
Constructor Summary | |
---|---|
Filter(Filter.FilterType filterType)
The only constructor for this class. |
Method Summary | |
---|---|
void |
addParameter(Param p)
Add a parameter to the filter. |
static Filter |
create(org.w3c.dom.Element filter)
Helper method to utilize data from a DOM tree to create a suitable Filter entry. |
java.lang.String |
getName()
Obtain the type of filter represented by this class. |
java.util.ArrayList<Param> |
getParameters()
Obtain the full list of parameters passed to this filter. |
java.lang.String |
getSummary()
Provides a multi-line information about this filter. |
void |
marshall(org.w3c.dom.Element filterList)
Method to marshall the data stored in this object to become part of a DOM tree element passed in. |
void |
marshall(java.io.PrintWriter out)
Method to marshall the data stored in this object directly to a XML fragment. |
java.lang.String |
toCmdLine()
Return the information in the form of a partial PEACE command line parameter. |
java.lang.String |
toString()
Provides a one line information about this heuristics. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private final Filter.FilterType filterType
private java.util.ArrayList<Param> parameters
Constructor Detail |
---|
public Filter(Filter.FilterType filterType)
filterType
- The type of filter that this object is expected
to represent.Method Detail |
---|
public static Filter create(org.w3c.dom.Element filter) throws java.lang.Exception
filter
- The DOM element to be used for creating the
entry and populating with the needed data.
java.lang.Exception
- This method throws an exception when errors occur
during reading and processing elements from the DOM node.public java.lang.String getName()
public java.util.ArrayList<Param> getParameters()
public void addParameter(Param p)
p
- The parameter to be added to the list. This value
must not be null.public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getSummary()
public java.lang.String toCmdLine()
public final void marshall(org.w3c.dom.Element filterList)
filterList
- The DOM element corresponding to the "FilterList"
node that contains this entry.public final void marshall(java.io.PrintWriter out)
out
- The stream to which the XML must be serialized.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |