2.17.2: 2011-06-17

net.sf.basedb.plugins
Class BaseFileExporterPlugin.ExtendedDynamicField

java.lang.Object
  extended by net.sf.basedb.plugins.BaseFileExporterPlugin.ExtendedDynamicField
All Implemented Interfaces:
DynamicField, ExportableField
Enclosing class:
BaseFileExporterPlugin

public static class BaseFileExporterPlugin.ExtendedDynamicField
extends Object
implements DynamicField


Field Summary
private  String guiTitle
           
private  String id
           
private  DynamicField parent
           
private  boolean reporterField
           
 
Constructor Summary
BaseFileExporterPlugin.ExtendedDynamicField(String id, boolean reporterField, DynamicField parent)
           
BaseFileExporterPlugin.ExtendedDynamicField(String id, String guiTitle, boolean reporterField, DynamicField parent)
           
 
Method Summary
 boolean equals(Object obj)
          An extended dynamic field is equal to another field if their parent fields equal.
 Expression getExpression(DbControl dc, DynamicQuery query, BioAssaySet source, boolean forAverage)
          Get an expression that selects the data that should be exported.
 Formatter<?> getFormatter()
          Get a formatter that converts the values in this field to strings.
 String getGuiTitle()
           
 String getId()
           
 String getTitle()
          Get the column header.
 Type getType()
          Get the data type of the field.
 int hashCode()
           
 boolean isReporterField()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

id

private final String id

parent

private final DynamicField parent

guiTitle

private final String guiTitle

reporterField

private final boolean reporterField
Constructor Detail

BaseFileExporterPlugin.ExtendedDynamicField

public BaseFileExporterPlugin.ExtendedDynamicField(String id,
                                                   boolean reporterField,
                                                   DynamicField parent)

BaseFileExporterPlugin.ExtendedDynamicField

public BaseFileExporterPlugin.ExtendedDynamicField(String id,
                                                   String guiTitle,
                                                   boolean reporterField,
                                                   DynamicField parent)
Method Detail

getExpression

public Expression getExpression(DbControl dc,
                                DynamicQuery query,
                                BioAssaySet source,
                                boolean forAverage)
Description copied from interface: DynamicField
Get an expression that selects the data that should be exported.

Specified by:
getExpression in interface DynamicField
Parameters:
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
Returns:
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)

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
Returns:
A formatter or null to use default formatting (normally this means calling the toString() method).

getTitle

public String getTitle()
Description copied from interface: ExportableField
Get the column header.

Specified by:
getTitle in interface ExportableField

getType

public Type getType()
Description copied from interface: ExportableField
Get the data type of the field.

Specified by:
getType in interface ExportableField
Returns:
A type object or null if not known

equals

public boolean equals(Object obj)
An extended dynamic field is equal to another field if their parent fields equal.

Overrides:
equals in class Object
Since:
2.15

hashCode

public int hashCode()
Overrides:
hashCode in class Object
Since:
2.15

getId

public String getId()

getGuiTitle

public String getGuiTitle()

isReporterField

public boolean isReporterField()

2.17.2: 2011-06-17