Top Description Fields Constructors Methods
net.sf.ehcache.config

public Class Searchable

extends Object
Class Inheritance
Imports
java.util.Collections, .HashMap, .Map, net.sf.ehcache.CacheException, net.sf.ehcache.search.Query, net.sf.ehcache.search.attribute.KeyObjectAttributeExtractor, .ValueObjectAttributeExtractor
Search configuration for a Cache
Author
teck

Field Summary

Modifier and TypeField and Description
private boolean
allowDynamicIndexing

public static final boolean
DYNAMIC_INDEXING_DEFAULT

Default for allowing dynamic indexing

private boolean
frozen

private boolean
keys

public static final boolean
KEYS_DEFAULT

Default for auto-searchable keys

private final Map<String, SearchAttribute>
searchAttributes

The defined search attributes (if any) indexed by name

private boolean
values

public static final boolean
VALUES_DEFAULT

Default for auto-searchable values

Constructor Summary

AccessConstructor and Description
public
Searchable()

Constructor

Method Summary

Modifier and TypeMethod and Description
public void
addSearchAttribute(SearchAttribute
to add
searchAttribute)

Add the given search attribute

public void
allowDynamicIndexing(boolean allow)

Allow or disallow dynamic search attribute extraction

private void
checkDynamicChange()

private void
disallowBuiltins(String attributeName)

public void
freezeConfiguration()

Freeze this configuration.

public Map<String, SearchAttribute>

Returns:

search attributes
getSearchAttributes()

Get the defined search attributes indexed by attribute name

public Map<String, SearchAttribute>

Returns:

search attributes
getUserDefinedSearchAttributes()

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

public boolean
isDynamicIndexingAllowed()

Is dynamic indexing allowed?

public boolean

Returns:

true if keys are searchable
keys()

Are keys searchable?

public void
keys(boolean b)

Toggle searchable keys

public Searchable

Returns:

this
searchAttribute(SearchAttribute
attribute to add
searchAttribute)

Add a search attribute

public void
setAllowDynamicIndexing(boolean allow)

Allow or disallow dynamic search attribute extraction

public void
setKeys(boolean keys)

Toggle searchable keys

public void
setValues(boolean values)

Toggle searchable values

public boolean

Returns:

true if values are searchable
values()

Are values searchable?

public void
values(boolean b)

Toggle searchable values

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

allowDynamicIndexingback to summary
private boolean allowDynamicIndexing
DYNAMIC_INDEXING_DEFAULTback to summary
public static final boolean DYNAMIC_INDEXING_DEFAULT

Default for allowing dynamic indexing

frozenback to summary
private boolean frozen
keysback to summary
private boolean keys
KEYS_DEFAULTback to summary
public static final boolean KEYS_DEFAULT

Default for auto-searchable keys

searchAttributesback to summary
private final Map<String, SearchAttribute> searchAttributes

The defined search attributes (if any) indexed by name

valuesback to summary
private boolean values
VALUES_DEFAULTback to summary
public static final boolean VALUES_DEFAULT

Default for auto-searchable values

Constructor Detail

Searchableback to summary
public Searchable()

Constructor

Method Detail

addSearchAttributeback to summary
public void addSearchAttribute(SearchAttribute searchAttribute) throws InvalidConfigurationException

Add the given search attribute

Parameters
searchAttribute:SearchAttribute

to add

Exceptions
InvalidConfigurationException:
if an attribute already exists for the same name
allowDynamicIndexingback to summary
public void allowDynamicIndexing(boolean allow)

Allow or disallow dynamic search attribute extraction

checkDynamicChangeback to summary
private void checkDynamicChange()
disallowBuiltinsback to summary
private void disallowBuiltins(String attributeName)
freezeConfigurationback to summary
public void freezeConfiguration()

Freeze this configuration. Any subsequent changes will throw a CacheException

getSearchAttributesback to summary
public Map<String, SearchAttribute> getSearchAttributes()

Get the defined search attributes indexed by attribute name

Returns:Map<String, SearchAttribute>

search attributes

getUserDefinedSearchAttributesback to summary
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:Map<String, SearchAttribute>

search attributes

isDynamicIndexingAllowedback to summary
public boolean isDynamicIndexingAllowed()

Is dynamic indexing allowed?

keysback to summary
public boolean keys()

Are keys searchable?

Returns:boolean

true if keys are searchable

keysback to summary
public void keys(boolean b)

Toggle searchable keys

searchAttributeback to summary
public Searchable searchAttribute(SearchAttribute searchAttribute)

Add a search attribute

Parameters
searchAttribute:SearchAttribute

attribute to add

Returns:Searchable

this

setAllowDynamicIndexingback to summary
public void setAllowDynamicIndexing(boolean allow)

Allow or disallow dynamic search attribute extraction

setKeysback to summary
public void setKeys(boolean keys)

Toggle searchable keys

setValuesback to summary
public void setValues(boolean values)

Toggle searchable values

valuesback to summary
public boolean values()

Are values searchable?

Returns:boolean

true if values are searchable

valuesback to summary
public void values(boolean b)

Toggle searchable values