Class ListResult

  • All Implemented Interfaces:
    IIconProvider, IResult, IResultTable, IStructuredResult

    public class ListResult
    extends java.lang.Object
    implements IResultTable, IIconProvider
    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

      Nested Classes 
      Modifier and Type Class Description
      static interface  ListResult.ValueProvider
      Converts a row to the needed value from the row
    • Constructor Summary

      Constructors 
      Constructor Description
      ListResult​(java.lang.Class<? extends L> type, java.util.List<L> subjects, java.lang.String... properties)
      Construct a displayable list from a List.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addColumn​(Column column, ListResult.ValueProvider valueProvider)  
      Column[] getColumns()
      The columns of the tree or table.
      java.lang.Object getColumnValue​(java.lang.Object row, int columnIndex)
      Returns the (unformatted) value of a table/tree cell.
      IContextObject getContext​(java.lang.Object row)
      The default context of the row which is used to display information in the object inspector.
      java.net.URL getIcon​(java.lang.Object row)  
      ResultMetaData getResultMetaData()
      (Optionally) Return meta data of the result needed to fine-tune the display of the result.
      java.lang.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

      • ListResult

        public ListResult​(java.lang.Class<? extends L> type,
                          java.util.List<L> subjects,
                          java.lang.String... properties)
        Construct a displayable list from a List.
        Type Parameters:
        L - type name of items in the list
        Parameters:
        type - class of items in the list
        subjects - the list
        properties - the field names (or Java Bean properties) to be extracted from the list entries