|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.mat.query.results.ListResult
public class ListResult
A list of items such as properties as a result table. Compare to
PropertyResult which extracts and displays from a single object.
Example:
int[] objectIds = myClass.getObjectIds();
List<NameValuePair> pairs = new ArrayList<NameValuePair>();
// loop over all instances and take the value of the field name and the field value
for (int id : objectIds)
{
IObject myObject = snapshot.getObject(id);
String name = ((IObject) myObject.resolveValue("name")).getClassSpecificName();
String value = ((IObject) myObject.resolveValue("value")).getClassSpecificName();
pairs.add(new NameValuePair(name, value));
}
// the NameValuePair is a bean with two properties - name and value
// the returned result will be a table with two columns - one for each of these properties
return new ListResult(NameValuePair.class, pairs, "name", "value")
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
type which provides a display name for the property descriptor.
| Nested Class Summary | |
|---|---|
static interface |
ListResult.ValueProvider
Converts a row to the needed value from the row |
| Field Summary |
|---|
| Fields inherited from interface org.eclipse.mat.query.IIconProvider |
|---|
EMPTY |
| Constructor Summary | |
|---|---|
ListResult(Class<? extends L> type,
List<L> subjects,
String... properties)
Construct a displayable list from a List. |
|
| Method Summary | |
|---|---|
void |
addColumn(Column column,
ListResult.ValueProvider valueProvider)
|
Column[] |
getColumns()
The columns of the tree or table. |
Object |
getColumnValue(Object row,
int columnIndex)
Returns the (unformatted) value of a table/tree cell. |
IContextObject |
getContext(Object row)
The default context of the row which is used to display information in the object inspector. |
URL |
getIcon(Object row)
|
ResultMetaData |
getResultMetaData()
(Optionally) Return meta data of the result needed to fine-tune the display of the result. |
Object |
getRow(int rowId)
Returns the object of the row with the given row number. |
int |
getRowCount()
Returns the number of rows in the result table. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ListResult(Class<? extends L> type,
List<L> subjects,
String... properties)
L - type name of items in the listtype - class of items in the listsubjects - the listproperties - the field names (or Java Bean properties) to be extracted from
the list entries| Method Detail |
|---|
public void addColumn(Column column,
ListResult.ValueProvider valueProvider)
public ResultMetaData getResultMetaData()
IResult
getResultMetaData in interface IResultpublic final Column[] getColumns()
IStructuredResult
getColumns in interface IStructuredResultpublic final int getRowCount()
IResultTable
getRowCount in interface IResultTablepublic final Object getRow(int rowId)
IResultTable
getRow in interface IResultTablerowId - The row number.
IStructuredResult.getContext(Object) or
IStructuredResult.getColumnValue(Object, int).
public final Object getColumnValue(Object row,
int columnIndex)
IStructuredResult
getColumnValue in interface IStructuredResultrow - The row object as returned by the
IResultTable.getRow(int) or
IResultTree.getElements() or
IResultTree.getChildren(Object) methodscolumnIndex - The index of the column.public URL getIcon(Object row)
getIcon in interface IIconProviderpublic IContextObject getContext(Object row)
IStructuredResultResultMetaData, it is also used for the context menu on a row.
getContext in interface IStructuredResultrow - The row object as returned by the
IResultTable.getRow(int) or
IResultTree.getElements() or
IResultTree.getChildren(Object) methods.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||