edu.mayo.informatics.lexgrid.convert.formats.outputFormats
Class IndexLexGridDatabase

java.lang.Object
  extended by edu.mayo.informatics.lexgrid.convert.formats.outputFormats.IndexLexGridDatabase
All Implemented Interfaces:
OutputFormatInterface
Direct Known Subclasses:
IndexLexGridDatabaseSWT

public class IndexLexGridDatabase
extends java.lang.Object
implements OutputFormatInterface

Output format for building a lucene index..

Version:
subversion $Revision: $ checked in on $Date: $
Author:
Dan Armbrust

Field Summary
static java.lang.String description
           
protected  java.lang.String indexLocation_
           
protected  java.lang.String indexName_
           
protected  java.lang.String normConfigFile_
           
protected  boolean normEnabled_
           
 
Constructor Summary
IndexLexGridDatabase()
           
IndexLexGridDatabase(java.lang.String indexLocation, java.lang.String indexName, boolean normEnabled, java.lang.String normConfigFile)
           
 
Method Summary
 java.lang.String getConnectionSummary()
          Get a summary of the connection parameters.
 java.lang.String getDescription()
          The description of the output type.
 java.lang.String getIndexLocation()
           
 java.lang.String getIndexName()
           
 java.lang.String getNormConfigFile()
           
 Option[] getOptions()
           
 boolean isNormEnabled()
           
 java.lang.String testConnection()
          See if the provided parameters make a valid connection
 
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

indexLocation_

protected java.lang.String indexLocation_

indexName_

protected java.lang.String indexName_

normEnabled_

protected boolean normEnabled_

normConfigFile_

protected java.lang.String normConfigFile_
Constructor Detail

IndexLexGridDatabase

public IndexLexGridDatabase()

IndexLexGridDatabase

public IndexLexGridDatabase(java.lang.String indexLocation,
                            java.lang.String indexName,
                            boolean normEnabled,
                            java.lang.String normConfigFile)
Method Detail

getConnectionSummary

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

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

getDescription

public java.lang.String getDescription()
Description copied from interface: OutputFormatInterface
The description of the output type.

Specified by:
getDescription in interface OutputFormatInterface
Returns:

testConnection

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

Specified by:
testConnection in interface OutputFormatInterface
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.

getOptions

public Option[] getOptions()
Specified by:
getOptions in interface OutputFormatInterface

getIndexLocation

public java.lang.String getIndexLocation()

getIndexName

public java.lang.String getIndexName()

getNormConfigFile

public java.lang.String getNormConfigFile()

isNormEnabled

public boolean isNormEnabled()

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.