edu.mayo.informatics.lexgrid.convert.formats.inputFormats
Class NCIOwl

java.lang.Object
  extended by edu.mayo.informatics.lexgrid.convert.formats.baseFormats.CommonBase
      extended by edu.mayo.informatics.lexgrid.convert.formats.baseFormats.FileBase
          extended by edu.mayo.informatics.lexgrid.convert.formats.inputFormats.NCIOwl
All Implemented Interfaces:
InputFormatInterface
Direct Known Subclasses:
NCIOwlSWT

public class NCIOwl
extends FileBase
implements InputFormatInterface

Details for reading from NCI Owl files.

Version:
subversion $Revision: 8668 $ checked in on $Date: 2008-06-09 19:35:33 +0000 (Mon, 09 Jun 2008) $
Author:
Dan Armbrust

Field Summary
static java.lang.String description
           
protected  java.net.URI manifestLocation
           
 
Fields inherited from class edu.mayo.informatics.lexgrid.convert.formats.baseFormats.FileBase
fileLocation
 
Fields inherited from class edu.mayo.informatics.lexgrid.convert.formats.baseFormats.CommonBase
codingSchemeManifest
 
Constructor Summary
NCIOwl()
           
NCIOwl(java.lang.String fileLocation, java.net.URI manifestLocation)
           
 
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.
 java.net.URI getManifestLocation()
           
 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.
 void setManifestLocation(java.net.URI manifestLocation)
           
 java.lang.String testConnection()
          See if the provided parameters make a valid connection
 
Methods inherited from class edu.mayo.informatics.lexgrid.convert.formats.baseFormats.FileBase
getConnectionSummary, getFileLocation, setFileLocation
 
Methods inherited from class edu.mayo.informatics.lexgrid.convert.formats.baseFormats.CommonBase
getCodingSchemeManifest, getLoaderPreferences, setCodingSchemeManifest, setLoaderPreferences
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

description

public static final java.lang.String description
See Also:
Constant Field Values

manifestLocation

protected java.net.URI manifestLocation
Constructor Detail

NCIOwl

public NCIOwl(java.lang.String fileLocation,
              java.net.URI manifestLocation)

NCIOwl

public NCIOwl()
Method Detail

getDescription

public java.lang.String getDescription()
Description copied from interface: InputFormatInterface
Get the description of the input type.

Specified by:
getDescription in interface InputFormatInterface
Returns:

getSupportedOutputFormats

public java.lang.String[] getSupportedOutputFormats()
Description copied from interface: InputFormatInterface
Get the supported Output formats for this input format.

Specified by:
getSupportedOutputFormats in interface InputFormatInterface
Returns:

getConnectionSummary

public java.lang.String getConnectionSummary()
Description copied from interface: InputFormatInterface
Get a summary of the connection parameters.

Specified by:
getConnectionSummary in interface InputFormatInterface
Returns:
the summary.

getOptions

public Option[] getOptions()
Description copied from interface: InputFormatInterface
Get the additional options that must be supplied before the reading can happen.

Specified by:
getOptions in interface InputFormatInterface
Returns:

getAvailableTerminologies

public java.lang.String[] getAvailableTerminologies()
Specified by:
getAvailableTerminologies in interface InputFormatInterface

getManifestLocation

public java.net.URI getManifestLocation()
Overrides:
getManifestLocation in class CommonBase
Returns:
the manifestLocation

setManifestLocation

public void setManifestLocation(java.net.URI manifestLocation)
Overrides:
setManifestLocation in class CommonBase
Parameters:
manifestLocation - the manifestLocation to set

testConnection

public java.lang.String testConnection()
                                throws ConnectionFailure
Description copied from interface: InputFormatInterface
See if the provided parameters make a valid connection

Specified by:
testConnection in interface InputFormatInterface
Overrides:
testConnection in class FileBase
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.

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.