Package org.eclipse.mat.query.refined
Class RefinedStructuredResult
- java.lang.Object
-
- org.eclipse.mat.query.refined.RefinedStructuredResult
-
- All Implemented Interfaces:
IIconProvider,IResult,ISelectionProvider,IStructuredResult
- Direct Known Subclasses:
RefinedTable,RefinedTree
public abstract class RefinedStructuredResult extends Object implements IStructuredResult, ISelectionProvider, IIconProvider
The result from refining a table or tree.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classRefinedStructuredResult.DerivedDataJobDefinitionstatic interfaceRefinedStructuredResult.ICalculationProgress
-
Field Summary
-
Fields inherited from interface org.eclipse.mat.query.IIconProvider
EMPTY
-
Fields inherited from interface org.eclipse.mat.query.ISelectionProvider
EMPTY
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ColumnaddDerivedDataColumn(ContextProvider provider, ContextDerivedData.DerivedColumn derivedColumn)TotalsRowbuildTotalsRow(List<?> elements)voidcalculate(ContextProvider provider, ContextDerivedData.DerivedOperation operation, List<?> elements, RefinedStructuredResult.ICalculationProgress progress, IProgressListener listener)voidcalculateTotals(List<?> elements, TotalsRow totals, IProgressListener listener)voidfilterChanged(Filter filter)ColumngetColumnFor(ContextProvider provider, ContextDerivedData.DerivedColumn derivedColumn)Column[]getColumns()The columns of the tree or table.ObjectgetColumnValue(Object row, int columnIndex)Returns the (unformatted) value of a table/tree cell.IContextObjectgetContext(Object row)The default context of the row which is used to display information in the object inspector.Filter[]getFilter()intgetFilteredCount(List<?> elements)StringgetFormattedColumnValue(Object row, int columnIndex)URLgetIcon(Object row)List<RefinedStructuredResult.DerivedDataJobDefinition>getJobs()ResultMetaDatagetResultMetaData()(Optionally) Return meta data of the result needed to fine-tune the display of the result.intgetSortColumn()Column.SortDirectiongetSortDirection()booleanhasActiveFilter()booleanisDecorated(int columnIndex)booleanisExpanded(Object row)Should this node be expanded.booleanisSelected(Object row)Has the user selected this row?voidsetSelectionProvider(ISelectionProvider provider)voidsetSortOrder(Column queryColumn, Column.SortDirection direction)voidsort(List<?> elements)IStructuredResultunwrap()
-
-
-
Method Detail
-
setSelectionProvider
public void setSelectionProvider(ISelectionProvider provider)
-
isDecorated
public boolean isDecorated(int columnIndex)
-
getFilter
public Filter[] getFilter()
-
hasActiveFilter
public boolean hasActiveFilter()
-
getFilteredCount
public int getFilteredCount(List<?> elements)
-
filterChanged
public void filterChanged(Filter filter)
-
getSortColumn
public int getSortColumn()
-
getSortDirection
public Column.SortDirection getSortDirection()
-
setSortOrder
public void setSortOrder(Column queryColumn, Column.SortDirection direction)
-
sort
public void sort(List<?> elements)
-
calculateTotals
public void calculateTotals(List<?> elements, TotalsRow totals, IProgressListener listener)
-
getJobs
public List<RefinedStructuredResult.DerivedDataJobDefinition> getJobs()
-
addDerivedDataColumn
public Column addDerivedDataColumn(ContextProvider provider, ContextDerivedData.DerivedColumn derivedColumn)
-
getColumnFor
public Column getColumnFor(ContextProvider provider, ContextDerivedData.DerivedColumn derivedColumn)
-
calculate
public void calculate(ContextProvider provider, ContextDerivedData.DerivedOperation operation, List<?> elements, RefinedStructuredResult.ICalculationProgress progress, IProgressListener listener) throws SnapshotException
- Throws:
SnapshotException
-
unwrap
public IStructuredResult unwrap()
-
getResultMetaData
public ResultMetaData getResultMetaData()
Description copied from interface:IResult(Optionally) Return meta data of the result needed to fine-tune the display of the result. This could include an additional context, an additional query to run on selected data from the result , additional calculated columns, or an indication that the results are already presorted.- Specified by:
getResultMetaDatain interfaceIResult- Returns:
- the metadata for the result, used to obtain extra data
-
getColumns
public Column[] getColumns()
Description copied from interface:IStructuredResultThe columns of the tree or table.- Specified by:
getColumnsin interfaceIStructuredResult- Returns:
- an array of all the columns
-
getColumnValue
public Object getColumnValue(Object row, int columnIndex)
Description copied from interface:IStructuredResultReturns the (unformatted) value of a table/tree cell.- Specified by:
getColumnValuein interfaceIStructuredResult- Parameters:
row- The row object as returned by theIResultTable.getRow(int)orIResultTree.getElements()orIResultTree.getChildren(Object)methodscolumnIndex- The index of the column.- Returns:
- the cell value
-
getContext
public IContextObject getContext(Object row)
Description copied from interface:IStructuredResultThe default context of the row which is used to display information in the object inspector. Unless no context provider is given via theResultMetaData, it is also used for the context menu on a row.- Specified by:
getContextin interfaceIStructuredResult- Parameters:
row- The row object as returned by theIResultTable.getRow(int)orIResultTree.getElements()orIResultTree.getChildren(Object)methods.- Returns:
- a context object holding details about that row
-
getIcon
public URL getIcon(Object row)
- Specified by:
getIconin interfaceIIconProvider
-
isExpanded
public boolean isExpanded(Object row)
Description copied from interface:ISelectionProviderShould this node be expanded.- Specified by:
isExpandedin interfaceISelectionProvider- Parameters:
row- the chosen row- Returns:
- true if it should be expanded.
-
isSelected
public boolean isSelected(Object row)
Description copied from interface:ISelectionProviderHas the user selected this row?- Specified by:
isSelectedin interfaceISelectionProvider- Parameters:
row- the chosen row- Returns:
- true if selected
-
-