Class SimpleDynamicField

All Implemented Interfaces:
DynamicField, ExportableField

public class SimpleDynamicField extends Object implements DynamicField
Represents an exported data field. The object consists of a predefined query expression that can be used in the export query to select the data that is going to be exported, and a title that is exported as part of the table header. One instance of this class is considered to be equal to another if they are configured with the same expression and title.
Last modified
$Date: 2010-08-13 12:48:17 +0200 (fr, 13 aug 2010) $
  • Field Details

  • Constructor Details

    • SimpleDynamicField

      public SimpleDynamicField()
      Create a new object. Before it can be used it must be configured.
  • Method Details

    • getTitle

      public String getTitle()
      Description copied from interface: ExportableField
      Get the column header.
      Specified by:
      getTitle in interface ExportableField
    • getExpression

      public Expression getExpression(DbControl dc, DynamicQuery query, BioAssaySet source, boolean forAverage)
      Returns the configured expression. If 'forAverage' is TRUE the confgured Formula.AverageMethod is allowed to transform the expression. If no average method has been configured the average method specified by the IntensityTransform from the 'source' bioassay set is used.
      Specified by:
      getExpression in interface DynamicField
      dc - The DbControl that is used for database access
      query - The query the expression will be used with
      source - The source bioassay set
      forAverage - TRUE if the expression should generate an average of multiple values
      An expression, or null if it is not possible to create an expression in the given case (this will normally be replaced with an empty column in the output)
    • getType

      public Type getType()
      Description copied from interface: ExportableField
      Get the data type of the field.
      Specified by:
      getType in interface ExportableField
      A type object or null if not known
    • getFormatter

      public Formatter<?> getFormatter()
      Description copied from interface: ExportableField
      Get a formatter that converts the values in this field to strings.
      Specified by:
      getFormatter in interface ExportableField
      A formatter or null to use default formatting (normally this means calling the toString() method).
    • equals

      public boolean equals(Object obj)
      A dynamic field is equal to another field if it uses the same expression and has the same title.
      equals in class Object
    • hashCode

      public int hashCode()
      hashCode in class Object
    • toString

      public String toString()
      toString in class Object
    • getExpression

      public Expression getExpression()
      Get the configured express.
    • setExpression

      public void setExpression(Expression expression)
      Set the expression used to select data in the query.
    • setTitle

      public void setTitle(String title)
      Set the column header title.
    • setType

      public void setType(Type type)
      Set the data type of the exported field.
    • getAverageMethod

      public Formula.AverageMethod getAverageMethod()
      Get the average method to use if the exporter is exporting averaged data. If no average method has been configured, the everage method specified by the IntensityTransform of the source bioassay set is used.
    • setAverageMethod

      public void setAverageMethod(Formula.AverageMethod averageMethod)
      Set the average method to use when exporting averaged data.
    • setFormatter

      public void setFormatter(Formatter<?> formatter)
      Set a formatter to use for formatting the exported values.