edu.mayo.informatics.lexgrid.convert.formats
Interface InputFormatInterface

All Known Subinterfaces:
InputFormatSWTInterface
All Known Implementing Classes:
HL7SQL, LexGridDelimitedText, LexGridDelimitedTextSWT, LexGridLDAP, LexGridLDAPSWT, LexGridSQL, LexGridSQLLite, LexGridSQLLiteSWT, LexGridSQLSWT, LexGridXML, LexGridXMLSWT, NCIMetaThesaurusSQL, NCIMetaThesaurusSQLSWT, NCIOwl, NCIOwlSWT, NCIThesaurusHistoryFile, NCIThesaurusHistoryFileSWT, OBO, OBOSWT, Owl, OwlSWT, ProtegeFrames, ProtegeFramesSWT, RRFFiles, RRFFilesSWT, SemNetFiles, SemNetFilesSWT, SnodentSQL, SnodentSQLSWT, UMLSHistoryFile, UMLSSQL, UMLSSQLSWT

public interface InputFormatInterface

Defines the interface for input formats.

Version:
subversion $Revision: 7198 $ checked in on $Date: 2008-02-15 18:08:36 +0000 (Fri, 15 Feb 2008) $
Author:
Dan Armbrust

Method Summary
 java.lang.String[] getAvailableTerminologies()
           
 java.lang.String getConnectionSummary()
          Get a summary of the connection parameters.
 java.lang.String getDescription()
          Get the description of the input type.
 Option[] getOptions()
          Get the additional options that must be supplied before the reading can happen.
 java.lang.String[] getSupportedOutputFormats()
          Get the supported Output formats for this input format.
 java.lang.String testConnection()
          See if the provided parameters make a valid connection
 

Method Detail

getSupportedOutputFormats

java.lang.String[] getSupportedOutputFormats()
Get the supported Output formats for this input format.

Returns:

getDescription

java.lang.String getDescription()
Get the description of the input type.

Returns:

getOptions

Option[] getOptions()
Get the additional options that must be supplied before the reading can happen.

Returns:

getConnectionSummary

java.lang.String getConnectionSummary()
Get a summary of the connection parameters.

Returns:
the summary.

testConnection

java.lang.String testConnection()
                                throws ConnectionFailure
See if the provided parameters make a valid connection

Returns:
An optional warning about the connection - for example, SQL implementations may want to return a warning if the existing sql tables are a different version than what is expected.
Throws:
ConnectionFailure - If a connection can't be made.

getAvailableTerminologies

java.lang.String[] getAvailableTerminologies()
                                             throws ConnectionFailure,
                                                    UnexpectedError
Throws:
ConnectionFailure
UnexpectedError

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.