org.eclipse.smila.search.plugin
Class Plugin

java.lang.Object
  org.eclipse.smila.search.plugin.Plugin

Direct Known Subclasses:

Plugin

public abstract class Plugin
extends java.lang.Object

Author:

August Georg Schmidt (BROX) To change this generated comment go to Window>Preferences>Java>Code Generation>Code and Comments

Constructor Summary

Plugin()

Method Summary

abstract boolean	dataTypeMatches(java.lang.String indexDataType, java.lang.String searchDataType) Determines whether a given index data type and search data type are compatible.
abstract AdvSearchAccess	getAdvSearchAccess() Get advanced search interface.
abstract java.lang.String	getConfigurationBundleForEngineData()
abstract byte[]	getConfigurationFileForEngineData(java.lang.String fileName) Get configuration file for engine data.
abstract DataDictionaryAccess	getDataDictionaryAccess() Get data dictionary interface.
abstract IIndexAccess	getIndexAccess() Get index access interface.
abstract IndexStructureAccess	getIndexStructureAccess() Get index structure interface.
abstract SearchAccess	getSearchAccess() Get search access interface.
abstract 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 abstract AdvSearchAccess getAdvSearchAccess()

Get advanced search interface.

Returns:

Advanced search interface.

getSearchAccess

public abstract SearchAccess getSearchAccess()

Get search access interface.

Returns:

Search access interface.

getIndexStructureAccess

public abstract IndexStructureAccess getIndexStructureAccess()

Get index structure interface.

Returns:

Index structure interface.

getIndexAccess

public abstract IIndexAccess getIndexAccess()

Get index access interface.

Returns:

Index access interface.

getTemplateAccess

public abstract ITemplateAccess getTemplateAccess()

Get template access interface.

Returns:

Template access interface.

getDataDictionaryAccess

public abstract DataDictionaryAccess getDataDictionaryAccess()

Get data dictionary interface.

Returns:

Data dictionary interface.

dataTypeMatches

public abstract boolean dataTypeMatches(java.lang.String indexDataType,
                                        java.lang.String searchDataType)

Determines whether a given index data type and search data type are compatible.

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

getConfigurationFileForEngineData

public abstract byte[] getConfigurationFileForEngineData(java.lang.String fileName)
                                                  throws java.io.IOException

Get configuration file for engine data.

Parameters:

fileName - File name.

Returns:

Configuration file as byte[].

Throws:

java.io.IOException - Unable to load configuration file.

getConfigurationBundleForEngineData

public abstract java.lang.String getConfigurationBundleForEngineData()

Returns:

Configuration bundle.