|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
|
+--quoggles.boxes.Box
|
+--quoggles.stdboxes.getattributevalue.GetAttributeValue_Box
Input: one or several Attributables
Output: one or several values of an attribute of the input(s). The attribute
is specified via a parameter. null values are passed on.
null if the input itself is null
Takes one or a collection of Attributables and returns the
value(s) of the attribute specified via the parameter.
If an Attributable does not have the specified attribute, a
null value is inserted in the output.
If the resulting list contains only one element, this element is returned (not a one-element list).
| Field Summary | |
private OptionParameter |
attrPath
A parameter of the box |
private java.util.Collection |
inputCol
The input collection |
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 | |
GetAttributeValue_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. |
int[] |
getOutputTypes()
Override this method to specify more restricted types for the output(s) of the box. |
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, 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 |
private OptionParameter attrPath
private java.util.Collection inputCol
private java.lang.Object singleInput
| Constructor Detail |
public GetAttributeValue_Box()
| Method Detail |
public int[] getInputTypes()
BoxgetNumberOfInputs.
getInputTypes in interface IBoxgetInputTypes in class BoxIBox.getInputTypes()public int[] getOutputTypes()
BoxgetNumberOfOutputs.
This implementation returns the same as a call to
getInputTypes yields.
getOutputTypes in interface IBoxgetOutputTypes in class BoxIBox.getOutputTypes()
public void setInputs(java.lang.Object[] inputs)
throws InvalidInputException
Boxsuper.setInputs(inputs)) so that consistency checks are
done and some flags are correctly set.
setInputs in interface IBoxsetInputs in class BoxInvalidInputExceptionIBox.setInputs(java.lang.Object[])public IBoxRepresentation getGraphicalRepresentation()
BoxDefaultBoxRepresentation.
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;
getGraphicalRepresentation in interface IBoxgetGraphicalRepresentation in class Boxquoggles.boxes.IGraphicalBox#getGraphicalRepresentation()
public void execute()
throws QueryExecutionException
BoxInputNotSetException 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.
execute in interface IBoxexecute in class BoxQueryExecutionExceptionIBox.execute()
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||