quoggles.deprecated.stdboxes.flatten
Class Flatten_Box

java.lang.Object
  |
  +--quoggles.boxes.Box
        |
        +--quoggles.deprecated.stdboxes.flatten.Flatten_Box
All Implemented Interfaces:
IBox

public class Flatten_Box
extends Box

Input: an object

Output: null if the input has been null. If the input is a collection, a flat structure of that collection is returned (this flattenig is applied recursively)

From its hierarchical input (a Collection holding Collections), a flat structure is retrieved.

Example: If the input is a list of the form

[ [A1, A2], B, [C1, A1, C2] ]

then the result list will look like this:

[ A1, A2, B, C1, A1, C2 ]

null values are removed.

The order will be preserved (if the given Collectionss guarantee an order).

Duplicates are not removed.

null as input is passed on.

A non-collection input is put into a one element list.


Field Summary
private  java.util.Collection inputCol
           
private  java.lang.Object singleInput
          Only set if input is not a collection
 
Fields inherited from class quoggles.boxes.Box
boxExecuted, iBoxGRep, inputs, outputs, parameters
 
Constructor Summary
Flatten_Box()
           
 
Method Summary
 void execute()
          Should be overridden and called first by subclasses.
private  java.lang.Object flatten(java.lang.Object in)
          Flattens a hierarchical structure.
 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

inputCol

private java.util.Collection inputCol

singleInput

private java.lang.Object singleInput
Only set if input is not a collection

Constructor Detail

Flatten_Box

public Flatten_Box()
Method Detail

flatten

private java.lang.Object flatten(java.lang.Object in)
Flattens a hierarchical structure.

Parameters:
in - the object to flatten
Returns:
Collection that does not hold any Collection as element; the input object itself if it had not been a collection

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()