Package org.eclipse.mat.query.results
Class PropertyResult
- java.lang.Object
-
- org.eclipse.mat.query.results.PropertyResult
-
- All Implemented Interfaces:
IIconProvider,IResult,IResultTable,IStructuredResult
public class PropertyResult extends java.lang.Object implements IResultTable, IIconProvider
Extract properties from an object and display as a result table. Compare toListResultwhich extracts and displays from a list of objects. The column names are derived from the property names. If the names are required to be internationalized then a BeanInfo can be provided for the subject class which provides a display name for the property descriptor.
-
-
Field Summary
-
Fields inherited from interface org.eclipse.mat.query.IIconProvider
EMPTY
-
-
Constructor Summary
Constructors Constructor Description PropertyResult(java.lang.Object subject, java.lang.String... properties)Generate a result from a single object
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Column[]getColumns()The columns of the tree or table.java.lang.ObjectgetColumnValue(java.lang.Object row, int columnIndex)Returns the (unformatted) value of a table/tree cell.IContextObjectgetContext(java.lang.Object row)The default context of the row which is used to display information in the object inspector.java.net.URLgetIcon(java.lang.Object row)ResultMetaDatagetResultMetaData()(Optionally) Return meta data of the result needed to fine-tune the display of the result.java.lang.ObjectgetRow(int rowId)Returns the object of the row with the given row number.intgetRowCount()Returns the number of rows in the result table.
-
-
-
Constructor Detail
-
PropertyResult
public PropertyResult(java.lang.Object subject, java.lang.String... properties)Generate a result from a single object- Type Parameters:
L- The type of PropertyResult- Parameters:
subject- the objectproperties- the field names or Java Bean properties to extract, or null or none to extract them all.
-
-
Method Detail
-
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 final Column[] getColumns()
Description copied from interface:IStructuredResultThe columns of the tree or table.- Specified by:
getColumnsin interfaceIStructuredResult- Returns:
- an array of all the columns
-
getRowCount
public final int getRowCount()
Description copied from interface:IResultTableReturns the number of rows in the result table.- Specified by:
getRowCountin interfaceIResultTable- Returns:
- the number of rows
-
getRow
public final java.lang.Object getRow(int rowId)
Description copied from interface:IResultTableReturns the object of the row with the given row number.- Specified by:
getRowin interfaceIResultTable- Parameters:
rowId- The row number.- Returns:
- an opaque row object representing this row
which can be passed to
IStructuredResult.getContext(Object)orIStructuredResult.getColumnValue(Object, int).
-
getColumnValue
public final java.lang.Object getColumnValue(java.lang.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
-
getIcon
public java.net.URL getIcon(java.lang.Object row)
- Specified by:
getIconin interfaceIIconProvider
-
getContext
public IContextObject getContext(java.lang.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
-
-