net.sf.ehcache.config
Class Searchable

java.lang.Object
  net.sf.ehcache.config.Searchable

public class Searchable
extends Object

Search configuration for a Cache

Author:

teck

Constructor Summary

Searchable()
Constructor

Method Summary

void	addSearchAttribute(SearchAttribute searchAttribute) Add the given search attribute
void	freezeConfiguration() Freeze this configuration.
Map<String,SearchAttribute>	getSearchAttributes() Get the defined search attributes indexed by attribute name
Map<String,SearchAttribute>	getUserDefinedSearchAttributes() Get the defined search attributes indexed by attribute name *excluding* any search attributes that are automatically/implicitly defined (eg.
Searchable	searchAttribute(SearchAttribute searchAttribute) Add a search attribute

Methods inherited from class java.lang.Object

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

Constructor Detail

Searchable

public Searchable()

Constructor

Method Detail

addSearchAttribute

public void addSearchAttribute(SearchAttribute searchAttribute)
                        throws InvalidConfigurationException

Add the given search attribute

Parameters:

searchAttribute - to add

Throws:

InvalidConfigurationException - if an attribute already exists for the same name

getSearchAttributes

public Map<String,SearchAttribute> getSearchAttributes()

Get the defined search attributes indexed by attribute name

Returns:

search attributes

searchAttribute

public Searchable searchAttribute(SearchAttribute searchAttribute)

Add a search attribute

Parameters:

searchAttribute - attribute to add

Returns:

this

freezeConfiguration

public void freezeConfiguration()

Freeze this configuration. Any subsequent changes will throw a CacheException

getUserDefinedSearchAttributes

public Map<String,SearchAttribute> getUserDefinedSearchAttributes()

Get the defined search attributes indexed by attribute name *excluding* any search attributes that are automatically/implicitly defined (eg. key and value attributes)

Returns:

search attributes