oracle.ecsf.meta
Interface Configuration

public interface Configuration

Method Summary

java.lang.String	getDisplayName(java.lang.Object obj, long id) Returns the display name of a search group, search object, for field definition
java.util.List<MetaEngineInstance>	getEngineInstances() Returns all search engine instances, regardless engine types
java.util.List<MetaEngineInstance>	getEngineInstances(long engineTypeId) Returns all search engine instances of a given type by type id
java.util.Map	getEngineParameters(long engineId) Returns engine parameters in a hashmap for a given engine instance.
java.util.List<FacetDef>	getFacetDefs(SearchableObject obj) Returns a list of facet definitions for the searchable object.
SearchableGroup	getSearchableGroup(long engineId, java.lang.String name) Returns a searchable group for a given search engine instance, by name.
java.util.List<SearchableGroup>	getSearchableGroups(long engineId) Returns a list of searchable groups for a given search engine instance.
SearchableObject	getSearchableObject(long engineId, java.lang.String name) Returns a searchable object for a given search engine instance by class name.
void	invalidateCacheItem(java.lang.String type, java.lang.Object obj) Invalidates the cached item.
void	reload() Request a reload the configuration.
void	updateCacheItem(java.lang.String type, java.lang.Object obj) Notifies the config that an object has changed.

Method Detail

getEngineInstances

java.util.List<MetaEngineInstance> getEngineInstances()

Returns all search engine instances, regardless engine types

Returns:

a list of search engine instances available.

getEngineInstances

java.util.List<MetaEngineInstance> getEngineInstances(long engineTypeId)

Returns all search engine instances of a given type by type id

Parameters:

engineTypeId - - engine type id. If engine type with engineTypeId doesn't exist, throws RuntimeMetadataException.

Returns:

a list of search engine instances available.

getEngineParameters

java.util.Map getEngineParameters(long engineId)

Returns engine parameters in a hashmap for a given engine instance.

Parameters:

engineId - - the engine instance id. If engine with engineId doesn't exist, throws RuntimeMetadataException.

Returns:

Hashmap configration parameter

getSearchableGroup

SearchableGroup getSearchableGroup(long engineId,
                                   java.lang.String name)

Returns a searchable group for a given search engine instance, by name.

Parameters:

engineId - - The identification of the engine instance.

name - - The name of the searchable group. If engine with engineId doesn't exist, or name doesn't exist, throws RuntimeMetadataException.

Returns:

a searchable group. Null if not found.

getSearchableObject

SearchableObject getSearchableObject(long engineId,
                                     java.lang.String name)

Returns a searchable object for a given search engine instance by class name.

Parameters:

engineId - The identification of the engine instance.

name - The class name of the searchable object. If engine with engineId, or name doesn't exist, throws RuntimeMetadataException.

Returns:

a searchable object, null if not found.

getSearchableGroups

java.util.List<SearchableGroup> getSearchableGroups(long engineId)

Returns a list of searchable groups for a given search engine instance.

Parameters:

engineId - The indentification of the engine instance. If engine with engineId doesn't exist, throws RuntimeMetadataException.

Returns:

a list of searchable groups, empty if not found.

getFacetDefs

java.util.List<FacetDef> getFacetDefs(SearchableObject obj)

Returns a list of facet definitions for the searchable object. An empty list must be returned if there are no facet definitions for the object.

Parameters:

obj - - The seachable object whose facet definition is returned.

Returns:

a list of facet definitions for a searchable object.

getDisplayName

java.lang.String getDisplayName(java.lang.Object obj,
                                long id)

Returns the display name of a search group, search object, for field definition

Parameters:

obj - object to get display name for

id - id of object

Returns:

String display name

reload

void reload()

Request a reload the configuration. Implementation should reload the objects from persistent storage.

updateCacheItem

void updateCacheItem(java.lang.String type,
                     java.lang.Object obj)

Notifies the config that an object has changed.

Parameters:

type - - the type of object (SearchableObject, etc).

obj - - the object

invalidateCacheItem

void invalidateCacheItem(java.lang.String type,
                         java.lang.Object obj)

Invalidates the cached item.

Parameters:

type - - the type of object (SearchableObject, etc).

obj - - the object