org.eclipse.smila.search.utils.advsearch
Class AdvSearchAccess

java.lang.Object
  org.eclipse.smila.search.utils.advsearch.AdvSearchAccess

Direct Known Subclasses:

AdvSearchAccess

public abstract class AdvSearchAccess
extends java.lang.Object

Author:

brox IT-Solutions GmbH

Field Summary

static java.lang.String	EXTENSION_POINT_NAME_ADV_SEARCH_ACCESS Extension point name for Search Access.
static java.lang.String	NS Namespace.

Constructor Summary

protected

AdvSearchAccess()

Method Summary

abstract IAdvSearch	decode(org.w3c.dom.Element eAdvSearch) Decode advanced search.
abstract ITerm	decodeTerm(org.w3c.dom.Element eTerm) Decode term.
abstract org.w3c.dom.Document	encode(IAdvSearch dAnyFinderAdvSearch) Encode advanced search.
abstract org.w3c.dom.Element	encode(IAdvSearch dAnyFinderAdvSearch, org.w3c.dom.Element element) Encode advanced search.
abstract org.w3c.dom.Element	encodeTerm(ITerm dTerm, org.w3c.dom.Element element) Encode term.
static AdvSearchAccess	getInstance()
static AdvSearchAccess[]	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_ADV_SEARCH_ACCESS

public static final java.lang.String EXTENSION_POINT_NAME_ADV_SEARCH_ACCESS

Extension point name for Search Access.

See Also:

Constant Field Values

NS

public static java.lang.String NS

Namespace.

Constructor Detail

AdvSearchAccess

protected AdvSearchAccess()

Method Detail

getInstance

public static AdvSearchAccess getInstance()

getTypes

public static AdvSearchAccess[] getTypes()
                                  throws AdvSearchException

Get all available IRM types.

Returns:

IRM types.

Throws:

AdvSearchException

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.

decode

public abstract IAdvSearch decode(org.w3c.dom.Element eAdvSearch)
                           throws AdvSearchException

Decode advanced search.

Parameters:

eAdvSearch - Advanced search element.

Returns:

Decoded advanced search.

Throws:

AdvSearchException - Unable to decode advanced search.

decodeTerm

public abstract ITerm decodeTerm(org.w3c.dom.Element eTerm)
                          throws AdvSearchException

Decode term.

Parameters:

eTerm - Term element.

Returns:

Decoded term.

Throws:

AdvSearchException - Unable to decode term.

encode

public abstract org.w3c.dom.Document encode(IAdvSearch dAnyFinderAdvSearch)
                                     throws AdvSearchException

Encode advanced search.

Parameters:

dAnyFinderAdvSearch - Advanced search.

Returns:

Encoded advanced search.

Throws:

AdvSearchException - Unable to encode advanced search.

encode

public abstract org.w3c.dom.Element encode(IAdvSearch dAnyFinderAdvSearch,
                                           org.w3c.dom.Element element)
                                    throws AdvSearchException

Encode advanced search.

Parameters:

dAnyFinderAdvSearch - Advanced search.

element - Parent element.

Returns:

Encoded advanced search.

Throws:

AdvSearchException - Unable to encode advanced search.

encodeTerm

public abstract org.w3c.dom.Element encodeTerm(ITerm dTerm,
                                               org.w3c.dom.Element element)
                                        throws AdvSearchException

Encode term.

Parameters:

dTerm - Term to encode.

element - Parent element.

Returns:

Encoded element.

Throws:

AdvSearchException - Unable to encode element.