org.knime.base.node.viz.aggregation
Interface AggregationModel<S,H extends Shape>

Type Parameters:
S - the basic shape
H - the optional hilite shape
All Known Implementing Classes:
AggregationValModel, AggregationValSubModel, BarDataModel, BarElementDataModel, InteractiveBarDataModel, InteractiveBarElementDataModel, PieSectionDataModel, PieSubSectionDataModel

public interface AggregationModel<S,H extends Shape>

This interface provides methods which are common to the aggregation model and sub model.

Author:
Tobias Koetter, University of Konstanz

Method Summary
 double getAggregationSum()
           
 double getAggregationValue(AggregationMethod method)
           
 Color getColor()
           
 int getHiliteRowCount()
          Call the supportsHiliting() method to check if hiliting is supported.
 H getHiliteShape()
          Call the supportsHiliting() method to check if hiliting is supported.
 String getName()
           
 int getRowCount()
           
 S getShape()
           
 int getValueCount()
           
 boolean isEmpty()
           
 boolean isHilited()
           
 boolean isPresentable()
           
 boolean isSelected()
           
 boolean supportsHiliting()
           
 

Method Detail

getName

String getName()
Returns:
the optional name of this element (could be null)

getColor

Color getColor()
Returns:
the color to use for this element

getAggregationValue

double getAggregationValue(AggregationMethod method)
Parameters:
method - the AggregationMethod to use
Returns:
the aggregation value of this element

getAggregationSum

double getAggregationSum()
Returns:
the sum of all aggregation values

getShape

S getShape()
Returns:
the shape of this element

isPresentable

boolean isPresentable()
Returns:
true if the sub elements should be drawn

isSelected

boolean isSelected()
Returns:
true if this element is selected

isEmpty

boolean isEmpty()
Returns:
true if this model contains no rows

supportsHiliting

boolean supportsHiliting()
Returns:
true if hiliting is supported

isHilited

boolean isHilited()
Returns:
true if at least one row of this element is hilited

getHiliteShape

H getHiliteShape()
Call the supportsHiliting() method to check if hiliting is supported.

Returns:
the hilite shape of this element

getHiliteRowCount

int getHiliteRowCount()
Call the supportsHiliting() method to check if hiliting is supported.

Returns:
the number of hilited rows in this element

getRowCount

int getRowCount()
Returns:
the number of rows of this element

getValueCount

int getValueCount()
Returns:
the number of real values (without missing values)


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.