quoggles.auxboxes.attributefilter
Class AttributeFilter_Box

java.lang.Object
  |
  +--quoggles.boxes.Box
        |
        +--quoggles.auxboxes.attributefilter.AttributeFilter_Box
All Implemented Interfaces:
IBox

public class AttributeFilter_Box
extends Box

Input: One or several Attributables.

Output: Empty list, one or several Attributables that match the attribute specification given by the parameters.

If the input is null, the output is null as well.

Any values within the input list that are not Attributables (this includes null values) are ignored.

If the input is not a list and the input object does not match the criteria, the output is null.


Field Summary
private  OptionParameter attrPath
           
private  OptionParameter attrType
           
private  org.graffiti.plugin.parameter.StringParameter attrValue
           
private  java.util.Collection inputCol
           
private  OptionParameter relation
           
private  java.lang.Object[] relSymbols
           
private  org.graffiti.attributes.Attributable singleInput
           
private  java.lang.Object[] types
           
 
Fields inherited from class quoggles.boxes.Box
boxExecuted, iBoxGRep, inputs, outputs, parameters
 
Constructor Summary
AttributeFilter_Box()
          Constructs the box.
 
Method Summary
 void execute()
          Should be overridden and called first by subclasses.
 IBoxRepresentation getGraphicalRepresentation()
          This implementation returns a new instance of DefaultBoxRepresentation.
 int[] getInputTypes()
          This implementation returns ONE element, the most general type.
 void setInputs(java.lang.Object[] inputs)
          Checks if the number of inputs is correct and sets the inputs.
 
Methods inherited from class quoggles.boxes.Box
areAllInputsNull, getClassName, getId, getNode, getNumberOfInputs, getNumberOfOutputs, getOutputAt, getOutputs, getOutputTypes, getParameters, hasBeenExecuted, ignoreBox, isGraphicalRepNull, isInputSet, isInputSetAt, needsQueryRunner, removeNullValues, reset, reset, setBoxNumber, setCurrentNodesTodo, setCurrentResult, setDefaultParameters, setIgnoreBox, setInputAt, setNode, setParameters, setQueryRunner
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

attrPath

private OptionParameter attrPath

types

private java.lang.Object[] types

attrType

private OptionParameter attrType

relSymbols

private java.lang.Object[] relSymbols

relation

private OptionParameter relation

attrValue

private org.graffiti.plugin.parameter.StringParameter attrValue

inputCol

private java.util.Collection inputCol

singleInput

private org.graffiti.attributes.Attributable singleInput
Constructor Detail

AttributeFilter_Box

public AttributeFilter_Box()
Constructs the box.

Method Detail

execute

public void execute()
             throws QueryExecutionException
Description copied from class: Box
Should be overridden and called first by subclasses. Throws InputNotSetException if the inputSet flag indicates the no input has been set for this box. May throw other QueryExecutionExceptions. The implementation of this abstract sets the output to be equal to the input.

Specified by:
execute in interface IBox
Overrides:
execute in class Box
QueryExecutionException
See Also:
IBox.execute()

getInputTypes

public int[] getInputTypes()
Description copied from class: Box
This implementation returns ONE element, the most general type. Override this method to specify more restricted types for the input(s) of the box. The size of the returned array must be consistent with the return value of getNumberOfInputs.

Specified by:
getInputTypes in interface IBox
Overrides:
getInputTypes in class Box
See Also:
IBox.getInputTypes()

setInputs

public void setInputs(java.lang.Object[] inputs)
               throws InvalidInputException
Description copied from class: Box
Checks if the number of inputs is correct and sets the inputs. Subclasses probably will want to override this method to avoid many casts necessary when working with the input array. They should however first call this method (via super.setInputs(inputs)) so that consistency checks are done and some flags are correctly set.

Specified by:
setInputs in interface IBox
Overrides:
setInputs in class Box
InvalidInputException
See Also:
IBox.setInputs(java.lang.Object[])

getGraphicalRepresentation

public IBoxRepresentation getGraphicalRepresentation()
Description copied from class: Box
This implementation returns a new instance of DefaultBoxRepresentation. If your subclass has any parameters, you will probably have to design your own representation and override this method for example as follows: if (iBoxGRep == null || !(iBoxGRep instanceof MYOWNBOX_Rep)) { iBoxGRep = new MYOWNBOX_Rep(this); } return iBoxGRep;

Specified by:
getGraphicalRepresentation in interface IBox
Overrides:
getGraphicalRepresentation in class Box
See Also:
IBox.getGraphicalRepresentation()