org.eclipse.smila.search.utils.indexstructure
Class IndexStructureAccess

java.lang.Object
  org.eclipse.smila.search.utils.indexstructure.IndexStructureAccess

Direct Known Subclasses:

IndexStructureAccess

public abstract class IndexStructureAccess
extends java.lang.Object

Author:

brox IT-Solutions GmbH To change this generated comment go to Window>Preferences>Java>Code Generation>Code and Comments

Field Summary

static java.lang.String

EXTENSION_POINT_NAME_INDEX_STRUCTURE_ACCESS Extension point name for Index Structure Access.

Constructor Summary

protected

IndexStructureAccess() Constructor.

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 DIndexStructure	decode(org.w3c.dom.Element eIndexStructure)
abstract org.w3c.dom.Element	encode(DIndexStructure dIndexStructure, org.w3c.dom.Element element)
static IndexStructureAccess	getInstance()
static IndexStructureAccess[]	getTypes() Get all available IRM types.
static java.lang.String	parseType(IConfigurationElement configurationElement, int ordinal) Parse configuration and return according IRMType.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXTENSION_POINT_NAME_INDEX_STRUCTURE_ACCESS

public static final java.lang.String EXTENSION_POINT_NAME_INDEX_STRUCTURE_ACCESS

Extension point name for Index Structure Access.

See Also:

Constant Field Values

Constructor Detail

IndexStructureAccess

protected IndexStructureAccess()

Constructor.

Method Detail

getInstance

public static IndexStructureAccess getInstance()

getTypes

public static IndexStructureAccess[] getTypes()
                                       throws ISException

Get all available IRM types.

Returns:

IRM types.

Throws:

ISException - -

parseType

public static java.lang.String parseType(IConfigurationElement configurationElement,
                                         int ordinal)

Parse configuration and return according IRMType.

Parameters:

configurationElement - Configuration element.

ordinal - Ordinal.

Returns:

Type name.

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

decode

public abstract DIndexStructure decode(org.w3c.dom.Element eIndexStructure)
                                throws ISException

Throws:

ISException

encode

public abstract org.w3c.dom.Element encode(DIndexStructure dIndexStructure,
                                           org.w3c.dom.Element element)
                                    throws ISException

Throws:

ISException