public class Searchable extends Object
Modifier and Type | Field and Description |
---|---|
static boolean |
DYNAMIC_INDEXING_DEFAULT
Default for allowing dynamic indexing
|
static boolean |
KEYS_DEFAULT
Default for auto-searchable keys
|
static boolean |
VALUES_DEFAULT
Default for auto-searchable values
|
Constructor and Description |
---|
Searchable()
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
addSearchAttribute(SearchAttribute searchAttribute)
Add the given search attribute
|
void |
allowDynamicIndexing(boolean allow)
Allow or disallow dynamic search attribute extraction
|
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.
|
boolean |
isDynamicIndexingAllowed()
Is dynamic indexing allowed?
|
boolean |
keys()
Are keys searchable?
|
void |
keys(boolean b)
Toggle searchable keys
|
Searchable |
searchAttribute(SearchAttribute searchAttribute)
Add a search attribute
|
void |
setAllowDynamicIndexing(boolean allow)
Allow or disallow dynamic search attribute extraction
|
void |
setKeys(boolean keys)
Toggle searchable keys
|
void |
setValues(boolean values)
Toggle searchable values
|
boolean |
values()
Are values searchable?
|
void |
values(boolean b)
Toggle searchable values
|
public static final boolean KEYS_DEFAULT
public static final boolean VALUES_DEFAULT
public static final boolean DYNAMIC_INDEXING_DEFAULT
public void addSearchAttribute(SearchAttribute searchAttribute) throws InvalidConfigurationException
searchAttribute
- to addInvalidConfigurationException
- if an attribute already exists for the same namepublic Map<String,SearchAttribute> getSearchAttributes()
public Searchable searchAttribute(SearchAttribute searchAttribute)
searchAttribute
- attribute to addpublic void freezeConfiguration()
public Map<String,SearchAttribute> getUserDefinedSearchAttributes()
public boolean keys()
public boolean values()
public boolean isDynamicIndexingAllowed()
public void values(boolean b)
b
- public void keys(boolean b)
b
- public void setKeys(boolean keys)
keys
- public void setValues(boolean values)
values
- public void setAllowDynamicIndexing(boolean allow)
allow
- public void allowDynamicIndexing(boolean allow)
allow
- Copyright © 2003–2016 Terracotta, Inc.. All rights reserved.