src/core/net/sf/basedb/util/parser/ConfigureByExample.java

Code
Comments
Other
Rev Date Author Line
2655 22 Sep 06 nicklas 1 /**
2655 22 Sep 06 nicklas 2   $Id$
2655 22 Sep 06 nicklas 3
3675 16 Aug 07 jari 4   Copyright (C) 2006 Nicklas Nordborg
2655 22 Sep 06 nicklas 5
2655 22 Sep 06 nicklas 6   This file is part of BASE - BioArray Software Environment.
2655 22 Sep 06 nicklas 7   Available at http://base.thep.lu.se/
2655 22 Sep 06 nicklas 8
2655 22 Sep 06 nicklas 9   BASE is free software; you can redistribute it and/or
2655 22 Sep 06 nicklas 10   modify it under the terms of the GNU General Public License
4479 05 Sep 08 jari 11   as published by the Free Software Foundation; either version 3
2655 22 Sep 06 nicklas 12   of the License, or (at your option) any later version.
2655 22 Sep 06 nicklas 13
2655 22 Sep 06 nicklas 14   BASE is distributed in the hope that it will be useful,
2655 22 Sep 06 nicklas 15   but WITHOUT ANY WARRANTY; without even the implied warranty of
2655 22 Sep 06 nicklas 16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
2655 22 Sep 06 nicklas 17   GNU General Public License for more details.
2655 22 Sep 06 nicklas 18
2655 22 Sep 06 nicklas 19   You should have received a copy of the GNU General Public License
4515 11 Sep 08 jari 20   along with BASE. If not, see <http://www.gnu.org/licenses/>.
2655 22 Sep 06 nicklas 21 */
2655 22 Sep 06 nicklas 22 package net.sf.basedb.util.parser;
2655 22 Sep 06 nicklas 23
2655 22 Sep 06 nicklas 24 import net.sf.basedb.core.plugin.Plugin;
2655 22 Sep 06 nicklas 25
2655 22 Sep 06 nicklas 26 /**
2655 22 Sep 06 nicklas 27    This is a tagging interface for all plugins that use
2655 22 Sep 06 nicklas 28    the {@link FlatFileParser} and wants easier configuration
2655 22 Sep 06 nicklas 29    of the regular expressions used to parse the file.
2655 22 Sep 06 nicklas 30    <p>
2655 22 Sep 06 nicklas 31    The web interface checks for plugins that implements this interface
2655 22 Sep 06 nicklas 32    and create a "Test with file" button if the 
2655 22 Sep 06 nicklas 33    {@link net.sf.basedb.plugins.AbstractFlatFileImporter#parserSection} parameter is present.
2655 22 Sep 06 nicklas 34    The web interface expects plugin parameters for the regular expressions as defined by the 
2655 22 Sep 06 nicklas 35    {@link net.sf.basedb.plugins.AbstractFlatFileImporter} class. Parameters for
2655 22 Sep 06 nicklas 36    columns mappings must have the string "Mapping" in the parameter name. For
2655 22 Sep 06 nicklas 37    example <code>reporterIdColumnMapping</code>, <code>extendedColumnMapping.species</code>
2655 22 Sep 06 nicklas 38    and <code>propertyMapping.ch1FgMedian</code>.
2655 22 Sep 06 nicklas 39    <p>
2655 22 Sep 06 nicklas 40    All core plugins follow these directions.
2655 22 Sep 06 nicklas 41
2655 22 Sep 06 nicklas 42   @author nicklas
2655 22 Sep 06 nicklas 43   @version 2.0
2655 22 Sep 06 nicklas 44   @base.modified $Date$
2655 22 Sep 06 nicklas 45   @see net.sf.basedb.plugins.ReporterFlatFileImporter
2655 22 Sep 06 nicklas 46 */
2655 22 Sep 06 nicklas 47 public interface ConfigureByExample
2655 22 Sep 06 nicklas 48   extends Plugin
2655 22 Sep 06 nicklas 49 {}

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