src/core/net/sf/basedb/util/export/spotdata/ExportableFieldConverter.java

Code
Comments
Other
Rev Date Author Line
5277 22 Mar 10 nicklas 1 /**
5277 22 Mar 10 nicklas 2   $Id $
5277 22 Mar 10 nicklas 3
5277 22 Mar 10 nicklas 4   Copyright (C) 2010 Nicklas Nordborg
5277 22 Mar 10 nicklas 5
5277 22 Mar 10 nicklas 6   This file is part of BASE - BioArray Software Environment.
5277 22 Mar 10 nicklas 7   Available at http://base.thep.lu.se/
5277 22 Mar 10 nicklas 8
5277 22 Mar 10 nicklas 9   BASE is free software; you can redistribute it and/or
5277 22 Mar 10 nicklas 10   modify it under the terms of the GNU General Public License
5277 22 Mar 10 nicklas 11   as published by the Free Software Foundation; either version 3
5277 22 Mar 10 nicklas 12   of the License, or (at your option) any later version.
5277 22 Mar 10 nicklas 13
5277 22 Mar 10 nicklas 14   BASE is distributed in the hope that it will be useful,
5277 22 Mar 10 nicklas 15   but WITHOUT ANY WARRANTY; without even the implied warranty of
5277 22 Mar 10 nicklas 16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
5277 22 Mar 10 nicklas 17   GNU General Public License for more details.
5277 22 Mar 10 nicklas 18
5277 22 Mar 10 nicklas 19   You should have received a copy of the GNU General Public License
5277 22 Mar 10 nicklas 20   along with BASE. If not, see <http://www.gnu.org/licenses/>.
5277 22 Mar 10 nicklas 21 */
5277 22 Mar 10 nicklas 22 package net.sf.basedb.util.export.spotdata;
5277 22 Mar 10 nicklas 23
5277 22 Mar 10 nicklas 24 /**
5277 22 Mar 10 nicklas 25   Defines method for converting a string representation to
5277 22 Mar 10 nicklas 26   an exportable assay or dynamic field that can be used with
5277 22 Mar 10 nicklas 27   {@link AbstractBioAssaySetExporter} implementations. String
5277 22 Mar 10 nicklas 28   representations are useful for plug-ins that need to store
5277 22 Mar 10 nicklas 29   multiple fields related to different types of properties.
5277 22 Mar 10 nicklas 30   For example, a converter may lookup experimental factors, 
5277 22 Mar 10 nicklas 31   formulas or reporter properties based on the name.
5277 22 Mar 10 nicklas 32   
5277 22 Mar 10 nicklas 33   @author nicklas
5277 22 Mar 10 nicklas 34   @since 2.15
5277 22 Mar 10 nicklas 35 */
5277 22 Mar 10 nicklas 36 public interface ExportableFieldConverter
5277 22 Mar 10 nicklas 37 {
5277 22 Mar 10 nicklas 38   /**
5277 22 Mar 10 nicklas 39     Create a reporter dynamic field for the given name. The 
5277 22 Mar 10 nicklas 40     interpretation of the name is implementation-specific.
5277 22 Mar 10 nicklas 41     The returned field is typically added to the exporter with
5277 22 Mar 10 nicklas 42     {@link AbstractBioAssaySetExporter#addReporterField(DynamicField)}.
5277 22 Mar 10 nicklas 43     
5277 22 Mar 10 nicklas 44     @param name The name to look for
5277 22 Mar 10 nicklas 45     @param required TRUE if this field is required
5277 22 Mar 10 nicklas 46     @return A dynamic field or null if no field is found, but
5277 22 Mar 10 nicklas 47       if required = TRUE an exception is thrown instead
5277 22 Mar 10 nicklas 48   */
5277 22 Mar 10 nicklas 49   public DynamicField getReporterField(String name, boolean required);
5277 22 Mar 10 nicklas 50   
5277 22 Mar 10 nicklas 51   /**
5277 22 Mar 10 nicklas 52     Create a spot dynamic field for the given name. The 
5277 22 Mar 10 nicklas 53     interpretation of the name is implementation-specific. 
5277 22 Mar 10 nicklas 54     The returned field is typically added to the exporter with
5277 22 Mar 10 nicklas 55     {@link AbstractBioAssaySetExporter#addSpotField(DynamicField)}.
5277 22 Mar 10 nicklas 56     
5277 22 Mar 10 nicklas 57     @param name The name to look for
5277 22 Mar 10 nicklas 58     @param required TRUE if this field is required
5277 22 Mar 10 nicklas 59     @return A dynamic field or null if no field is found, but
5277 22 Mar 10 nicklas 60       if required = TRUE an exception is thrown instead
5277 22 Mar 10 nicklas 61   */
5277 22 Mar 10 nicklas 62   public DynamicField getSpotField(String name, boolean required);
5277 22 Mar 10 nicklas 63   
5277 22 Mar 10 nicklas 64   /**
5277 22 Mar 10 nicklas 65     Create an assay field for the given name. The 
5277 22 Mar 10 nicklas 66     interpretation of the name is implementation-specific. 
5277 22 Mar 10 nicklas 67     The returned field is typically added to the exporter with
5277 22 Mar 10 nicklas 68     {@link AbstractBioAssaySetExporter#addAssayField(AssayField)}.
5277 22 Mar 10 nicklas 69     
5277 22 Mar 10 nicklas 70     @param name The name to look for
5277 22 Mar 10 nicklas 71     @param required TRUE if this field is required
5277 22 Mar 10 nicklas 72     @return A dynamic field or null if no field is found, but
5277 22 Mar 10 nicklas 73       if required = TRUE an exception is thrown instead
5277 22 Mar 10 nicklas 74   */
5277 22 Mar 10 nicklas 75   public AssayField getAssayField(String name, boolean required);
5277 22 Mar 10 nicklas 76   
5277 22 Mar 10 nicklas 77 }

Generated on Sat Oct  7 02:36:34 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)