Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.table
Interface TableContext

All Known Implementing Classes:
DateColumnContext, DayContext, MonthContext, QuarterContext, SingleColumnContext, SingleGroupContext, WeekContext, YearContext

public interface TableContext

TableContext is an interface used for dynamically creating an olap hierarchy.


Method Summary
 int compareMemberValues(Object memberValue1, Object memberValue2)
          Compares two values that have been previously extracted in the extractMemberValue method.
 Object extractMemberValue(List row)
          Extracts a member value from a row that corresponds to the underlying table model.
 String getCaption(Object memberValue, List row, Locale locale)
          Determines the caption that will be displayed for the given member value and locale.
 String getDescription(Object memberValue, List row, Locale locale)
          Determines the description that will be displayed for the given member value and locale.
 String getName(Object memberValue, List row)
          Determines the name that will be displayed for the given member value.
 

Method Detail

compareMemberValues

int compareMemberValues(Object memberValue1,
                        Object memberValue2)
Compares two values that have been previously extracted in the extractMemberValue method.

Parameters:
memberValue1 - the first value to compare
memberValue2 - the second value to compare
Returns:
the comparison result

extractMemberValue

Object extractMemberValue(List row)
Extracts a member value from a row that corresponds to the underlying table model.

Parameters:
row - the row to the table model
Returns:
the extracted value that will be used as the member value

getCaption

String getCaption(Object memberValue,
                  List row,
                  Locale locale)
Determines the caption that will be displayed for the given member value and locale.

Parameters:
memberValue - the member value
row - the row to the table model
locale - the locale for which the caption is returned
Returns:
the member's caption

getDescription

String getDescription(Object memberValue,
                      List row,
                      Locale locale)
Determines the description that will be displayed for the given member value and locale.

Parameters:
memberValue - the member value
row - the row to the table model
locale - the locale for which the description is returned
Returns:
the member's description

getName

String getName(Object memberValue,
               List row)
Determines the name that will be displayed for the given member value.

Parameters:
memberValue - the member value
row - the row to the table model
Returns:
the member's name

Copyright © 2011 Citra Technologies. All Rights Reserved.