SMILA (incubation) API documentation

org.eclipse.smila.search.lucene
Class Plugin

java.lang.Object
  extended by org.eclipse.smila.search.plugin.Plugin
      extended by org.eclipse.smila.search.lucene.Plugin

public class Plugin
extends Plugin

Author:
GSchmidt To change this generated comment go to Window>Preferences>Java>Code Generation>Code and Comments

Constructor Summary
Plugin()
           
 
Method Summary
 boolean dataTypeMatches(java.lang.String indexDataType, java.lang.String searchDataType)
          Determines whether a given index data type and search data type are compatible.
 AdvSearchAccess getAdvSearchAccess()
          Get advanced search interface.
 java.lang.String getConfigurationBundleForEngineData()
          
 byte[] getConfigurationFileForEngineData(java.lang.String fileName)
          Get configuration file for engine data.
 DataDictionaryAccess getDataDictionaryAccess()
          Get data dictionary interface.
 IIndexAccess getIndexAccess()
          Get index access interface.
 IndexStructureAccess getIndexStructureAccess()
          Get index structure interface.
 SearchAccess getSearchAccess()
          Get search access interface.
 ITemplateAccess getTemplateAccess()
          Get template access interface.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Plugin

public Plugin()
Method Detail

getAdvSearchAccess

public AdvSearchAccess getAdvSearchAccess()
Get advanced search interface.

Specified by:
getAdvSearchAccess in class Plugin
Returns:
Advanced search interface.
See Also:
Plugin.getAdvSearchAccess()

getIndexStructureAccess

public IndexStructureAccess getIndexStructureAccess()
Get index structure interface.

Specified by:
getIndexStructureAccess in class Plugin
Returns:
Index structure interface.
See Also:
Plugin.getIndexStructureAccess()

getIndexAccess

public IIndexAccess getIndexAccess()
Get index access interface.

Specified by:
getIndexAccess in class Plugin
Returns:
Index access interface.
See Also:
Plugin.getIndexAccess()

getTemplateAccess

public ITemplateAccess getTemplateAccess()
Get template access interface.

Specified by:
getTemplateAccess in class Plugin
Returns:
Template access interface.
See Also:
Plugin.getTemplateAccess()

getDataDictionaryAccess

public DataDictionaryAccess getDataDictionaryAccess()
Get data dictionary interface.

Specified by:
getDataDictionaryAccess in class Plugin
Returns:
Data dictionary interface.
See Also:
Plugin.getDataDictionaryAccess()

getSearchAccess

public SearchAccess getSearchAccess()
Get search access interface.

Specified by:
getSearchAccess in class Plugin
Returns:
Search access interface.
See Also:
Plugin.getSearchAccess()

dataTypeMatches

public boolean dataTypeMatches(java.lang.String indexDataType,
                               java.lang.String searchDataType)
Determines whether a given index data type and search data type are compatible.

Specified by:
dataTypeMatches in class Plugin
Parameters:
indexDataType - Data type in index structure.
searchDataType - Data type in simple search.
Returns:
true if the two types can be converted to each other, false otherwise
See Also:
Plugin.dataTypeMatches(java.lang.String, java.lang.String)

getConfigurationFileForEngineData

public byte[] getConfigurationFileForEngineData(java.lang.String fileName)
                                         throws java.io.IOException
Get configuration file for engine data.

Specified by:
getConfigurationFileForEngineData in class Plugin
Parameters:
fileName - File name.
Returns:
Configuration file as byte[].
Throws:
java.io.IOException - Unable to load configuration file.
See Also:
Plugin.getConfigurationFileForEngineData(java.lang.String)

getConfigurationBundleForEngineData

public java.lang.String getConfigurationBundleForEngineData()

Specified by:
getConfigurationBundleForEngineData in class Plugin
Returns:
Configuration bundle.
See Also:
Plugin.getConfigurationBundleForEngineData()

SMILA (incubation) API documentation