SMILA (incubation) API documentation

org.eclipse.smila.search.datadictionary
Class DataDictionaryAccess

java.lang.Object
  extended by org.eclipse.smila.search.datadictionary.DataDictionaryAccess
Direct Known Subclasses:
DataDictionaryAccess

public abstract class DataDictionaryAccess
extends java.lang.Object

Author:
brox IT-Solutions GmbH

Field Summary
static java.lang.String EXTENSION_POINT_NAME_DATA_DICTIONARY_ACCESS
          Extension point name for Data Dictionary Accesss.
 
Constructor Summary
DataDictionaryAccess()
          Constructor.
 
Method Summary
abstract  DConnection decodeConnection(org.w3c.dom.Element eConnection)
          Connection object.
abstract  org.w3c.dom.Element encodeConnection(DConnection dConnection, org.w3c.dom.Element element)
           
static DataDictionaryAccess getInstance()
          DataDicitonaryAccess.
static DataDictionaryAccess[] 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_DATA_DICTIONARY_ACCESS

public static final java.lang.String EXTENSION_POINT_NAME_DATA_DICTIONARY_ACCESS
Extension point name for Data Dictionary Accesss.

See Also:
Constant Field Values
Constructor Detail

DataDictionaryAccess

public DataDictionaryAccess()
Constructor.

Method Detail

getInstance

public static DataDictionaryAccess getInstance()
DataDicitonaryAccess.

Returns:
- an access object.

getTypes

public static DataDictionaryAccess[] getTypes()
                                       throws DataDictionaryException
Get all available IRM types.

Returns:
IRM types.
Throws:
DataDictionaryException - DataDictionaryException.

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.

decodeConnection

public abstract DConnection decodeConnection(org.w3c.dom.Element eConnection)
                                      throws DDException
Connection object.

Parameters:
eConnection - - element connection.
Returns:
- DConnection object.
Throws:
DDException - - a possible exception.

encodeConnection

public abstract org.w3c.dom.Element encodeConnection(DConnection dConnection,
                                                     org.w3c.dom.Element element)
                                              throws DDException
Parameters:
dConnection - - dConnection object.
element - - a connection element.
Returns:
- the element.
Throws:
DDException - - a exception.

SMILA (incubation) API documentation