Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

A B C D E F G H I J L M N O P Q R S T U

## A

add(Object) - Method in class org.jboss.cache.search.LazyQueryResultIterator
  This method is not supported in and should not be called.
add(Object) - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  This method is not supported in and should not be called.
addCacheListener(Object) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Adds a listener to the cache.
afterFirst() - Method in class org.jboss.cache.search.LazyQueryResultIterator
afterFirst() - Method in interface org.jboss.cache.search.QueryResultIterator
  Jumps to the one-after-the-first result
afterFirst() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  Jumps to second element in the list.

## B

beforeLast() - Method in class org.jboss.cache.search.LazyQueryResultIterator
beforeLast() - Method in interface org.jboss.cache.search.QueryResultIterator
  Jumps to the one-before-the-last result
beforeLast() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  Jumps to penultimate element in the list.

## C

CacheEntityId - Class in org.jboss.cache.search
  This class is used to get fqns, keys and documentId's by calling methods on `Transformer`

CacheEntityId(String) - Constructor for class org.jboss.cache.search.CacheEntityId
CacheEntityId(Fqn, String) - Constructor for class org.jboss.cache.search.CacheEntityId
CacheEntityLoader - Class in org.jboss.cache.search
  Class that is used to load objects from a list of CacheEntityId ids.
CacheEntityLoader(Cache) - Constructor for class org.jboss.cache.search.CacheEntityLoader
CacheQuery - Interface in org.jboss.cache.search
  A cache-query is what will be returned when the createQuery() method is run.
CacheQueryImpl - Class in org.jboss.cache.search
  Implementation class of the CacheQuery interface.
CacheQueryImpl(Query, SearchFactoryImplementor, Cache) - Constructor for class org.jboss.cache.search.CacheQueryImpl
CacheQueryImpl(Query, SearchFactoryImplementor, Cache, Class...) - Constructor for class org.jboss.cache.search.CacheQueryImpl
classes - Variable in class org.jboss.cache.search.SearchableCacheConfiguration
clearData(String) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Removes the keys and properties from a named node.
clearData(Fqn<?>) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Removes the keys and properties from a named node.
close() - Method in class org.jboss.cache.search.LazyQueryResultIterator
close() - Method in interface org.jboss.cache.search.QueryResultIterator
  This method must be called on your iterator once you have finished so that Lucene resources can be freed up.
close() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
create() - Method in class org.jboss.cache.search.SearchableCacheImpl
  Lifecycle method that initializes configuration state, the root node, etc.
createQuery(Query) - Method in interface org.jboss.cache.search.SearchableCache
  Creates a CacheQuery object from a luceneQuery.
createQuery(Query, Class...) - Method in interface org.jboss.cache.search.SearchableCache
  Creates a CacheQuery from a lucene query and a class array.
createQuery(Query) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Creates a CacheQuery object from a given Lucene Query.
createQuery(Query, Class...) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Creates a CacheQuery object from a Lucene Query and a class array.
createSearchableCache(Cache<?, ?>, Class...) - Method in class org.jboss.cache.search.SearchableCacheFactory
  Creates a searchable cache from a cache object and a class array, without the properties object.
createSearchableCache(Cache<?, ?>, Properties, Class...) - Method in class org.jboss.cache.search.SearchableCacheFactory
  This method creates a searchable cache as well but requires the properties object.

## D

destroy() - Method in class org.jboss.cache.search.SearchableCacheImpl
  Lifecycle method that destroys the cache and removes any interceptors/configuration elements.
disableFullTextFilter(String) - Method in interface org.jboss.cache.search.CacheQuery
  Disable a given filter by its name.
disableFullTextFilter(String) - Method in class org.jboss.cache.search.CacheQueryImpl
  Disable a given filter by its name.

## E

enableFullTextFilter(String) - Method in interface org.jboss.cache.search.CacheQuery
  Enable a given filter by its name.
enableFullTextFilter(String) - Method in class org.jboss.cache.search.CacheQueryImpl
  Enable a given filter by its name.
evict(Fqn<?>) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Eviction call that evicts the specified Node from memory.
evict(Fqn<?>, boolean) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Eviction call that evicts the specified Node from memory.

## F

first() - Method in class org.jboss.cache.search.LazyQueryResultIterator
first() - Method in interface org.jboss.cache.search.QueryResultIterator
  Jumps to the first result
first() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  Jumps to first element in the list.

## G

generateId(Fqn, String) - Static method in class org.jboss.cache.search.Transformer
  Generates the documentId from an Fqn, key combination.
get(String, K) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Convenience method that allows for direct access to the data in a Node.
get(Fqn<?>, K) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Convenience method that allows for direct access to the data in a Node.
getCacheListeners() - Method in class org.jboss.cache.search.SearchableCacheImpl
  Returns a set of listeners that the cache has.
getCacheStatus() - Method in class org.jboss.cache.search.SearchableCacheImpl
  Gets where the cache currently is its lifecycle transitions.
getClassMapping(String) - Method in class org.jboss.cache.search.SearchableCacheConfiguration
getClassMappings() - Method in class org.jboss.cache.search.SearchableCacheConfiguration
getConfiguration() - Method in class org.jboss.cache.search.SearchableCacheImpl
  Returns an org.jboss.cache.config.Configuration instance.
getData(Fqn<?>) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Retrieves a defensively copied data map of the underlying node.
getDocumentId() - Method in class org.jboss.cache.search.CacheEntityId
  Gets a documentId String from an Fqn and key combination.
getFqn() - Method in class org.jboss.cache.search.CacheEntityId
  Gets the Fqn from the instance of CacheEntityId.
getFqn(String) - Static method in class org.jboss.cache.search.Transformer
  Takes in the documentId string from the user and will return the Fqn from the Fqn, key combination.
getInvocationContext() - Method in class org.jboss.cache.search.SearchableCacheImpl
  The current invocation context for the current invocation and cache instance.
getKey() - Method in class org.jboss.cache.search.CacheEntityId
  Gets the key from the instance of CacheEntityId.
getKey(String) - Static method in class org.jboss.cache.search.Transformer
  Takes in the documentId string from the user and will return the key from the Fqn, key combination.
getKeys(String) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Returns a set of attribute keys for the Fqn.
getKeys(Fqn<?>) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Returns a set of attribute keys for the Fqn.
getLocalAddress() - Method in class org.jboss.cache.search.SearchableCacheImpl
  Returns the local address of this cache in a cluster, or null if running in local mode.
getMembers() - Method in class org.jboss.cache.search.SearchableCacheImpl
  Returns a list of members in the cluster, or null if running in local mode.
getNode(String) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Gets a node from a String representation of a Fqn
getNode(Fqn<?>) - Method in class org.jboss.cache.search.SearchableCacheImpl
  A convenience method to retrieve a node directly from the cache.
getProperties() - Method in class org.jboss.cache.search.SearchableCacheConfiguration
getProperty(String) - Method in class org.jboss.cache.search.SearchableCacheConfiguration
getReflectionManager() - Method in class org.jboss.cache.search.SearchableCacheConfiguration
getRegion(Fqn<?>, boolean) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Retrieves a Region for a given Fqn.
getResultSize() - Method in interface org.jboss.cache.search.CacheQuery
  Gets the integer number of results.
getResultSize() - Method in class org.jboss.cache.search.CacheQueryImpl
getRoot() - Method in class org.jboss.cache.search.SearchableCacheImpl
  Returns an org.jboss.cache.Node instance.
getTransactionIdentifier() - Method in class org.jboss.cache.search.NodeModifiedTransactionContext
  Returns a JTA transaction.
getVersion() - Method in class org.jboss.cache.search.SearchableCacheImpl
  Returns the version of the cache as a string.

## H

handleDeleteData(NodeModifiedEvent, SearchFactoryImplementor) - Method in class org.jboss.cache.search.SearchableCoreListener
  If the modification type is DELETE_DATA then this method will be called.
handlePutData(NodeModifiedEvent, SearchFactoryImplementor) - Method in class org.jboss.cache.search.SearchableCoreListener
  If the modification type is PUT_MAP or PUT_DATA then this method will be called.
hasNext() - Method in class org.jboss.cache.search.LazyQueryResultIterator
hasNext() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  Returns true if the list has more elements when traversing the list in the forward direction.
hasPrevious() - Method in class org.jboss.cache.search.LazyQueryResultIterator
hasPrevious() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  Returns true if the list has more elements when traversing the list in the reverse direction.

## I

InvalidFqnException - Exception in org.jboss.cache.search
  Thrown when an invalid Fqn is passed into `Transformer.generateId(org.jboss.cache.Fqn, String)`

InvalidFqnException() - Constructor for exception org.jboss.cache.search.InvalidFqnException
InvalidFqnException(String) - Constructor for exception org.jboss.cache.search.InvalidFqnException
InvalidFqnException(String, Throwable) - Constructor for exception org.jboss.cache.search.InvalidFqnException
InvalidFqnException(Throwable) - Constructor for exception org.jboss.cache.search.InvalidFqnException
InvalidKeyException - Exception in org.jboss.cache.search
  * Thrown when an invalid Key is passed into `Transformer.generateId(org.jboss.cache.Fqn, String)`

InvalidKeyException() - Constructor for exception org.jboss.cache.search.InvalidKeyException
InvalidKeyException(String) - Constructor for exception org.jboss.cache.search.InvalidKeyException
InvalidKeyException(String, Throwable) - Constructor for exception org.jboss.cache.search.InvalidKeyException
InvalidKeyException(Throwable) - Constructor for exception org.jboss.cache.search.InvalidKeyException
isAfterFirst() - Method in class org.jboss.cache.search.LazyQueryResultIterator
isAfterFirst() - Method in interface org.jboss.cache.search.QueryResultIterator
isAfterFirst() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
isBeforeLast() - Method in class org.jboss.cache.search.LazyQueryResultIterator
isBeforeLast() - Method in interface org.jboss.cache.search.QueryResultIterator
isBeforeLast() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
isFirst() - Method in class org.jboss.cache.search.LazyQueryResultIterator
isFirst() - Method in interface org.jboss.cache.search.QueryResultIterator
isFirst() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
isLast() - Method in class org.jboss.cache.search.LazyQueryResultIterator
isLast() - Method in interface org.jboss.cache.search.QueryResultIterator
isLast() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
isTransactionInProgress() - Method in class org.jboss.cache.search.NodeModifiedTransactionContext
  Returns a boolean value whether or not a transaction is in progress (JTA transaction and in this case *not* an org.hibernate transaction).
iterator(int) - Method in interface org.jboss.cache.search.CacheQuery
  Returns the results of a search as a `QueryResultIterator` with a given integer parameter - the fetchSize.
iterator() - Method in interface org.jboss.cache.search.CacheQuery
  Returns the results of a search as a `QueryResultIterator`.
iterator() - Method in class org.jboss.cache.search.CacheQueryImpl
iterator(int) - Method in class org.jboss.cache.search.CacheQueryImpl

## J

jumpToResult(int) - Method in class org.jboss.cache.search.LazyQueryResultIterator
jumpToResult(int) - Method in interface org.jboss.cache.search.QueryResultIterator
  Jumps to a specific index in the iterator.
jumpToResult(int) - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  Jumps to a given index in the list of results.

## L

last() - Method in class org.jboss.cache.search.LazyQueryResultIterator
last() - Method in interface org.jboss.cache.search.QueryResultIterator
  Jumps to the last result
last() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  Jumps to last element in the list.
lazyIterator(int) - Method in interface org.jboss.cache.search.CacheQuery
  Lazily loads the results from the Query as a `QueryResultIterator` with a given integer parameter - the fetchSize.
lazyIterator() - Method in interface org.jboss.cache.search.CacheQuery
  Calls the `CacheQuery.lazyIterator(int fetchSize)` method but passes in a default 1 as a parameter.
lazyIterator() - Method in class org.jboss.cache.search.CacheQueryImpl
lazyIterator(int) - Method in class org.jboss.cache.search.CacheQueryImpl
LazyQueryResultIterator - Class in org.jboss.cache.search
  Implementation for `QueryResultIterator`.
LazyQueryResultIterator(DocumentExtractor, CacheEntityLoader, Hits, IndexSearcher, SearchFactoryImplementor, int, int, int) - Constructor for class org.jboss.cache.search.LazyQueryResultIterator
list() - Method in interface org.jboss.cache.search.CacheQuery
  Returns the results of a search as a list.
list() - Method in class org.jboss.cache.search.CacheQueryImpl
load(List<CacheEntityId>) - Method in class org.jboss.cache.search.CacheEntityLoader
  Takes a list of entity ids and gets them from the cache.
load(CacheEntityId) - Method in class org.jboss.cache.search.CacheEntityLoader
  Takes a list of entity ids and gets them from the cache.

## M

move(String, String) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Moves a part of the cache to a different subtree.
move(Fqn<?>, Fqn<?>) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Moves a part of the cache to a different subtree.

## N

next() - Method in class org.jboss.cache.search.LazyQueryResultIterator
next() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  Returns the next element in the list
nextIndex() - Method in class org.jboss.cache.search.LazyQueryResultIterator
nextIndex() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  Returns the index of the element that would be returned by a subsequent call to next.
NodeModifiedTransactionContext - Class in org.jboss.cache.search
  This class implements the `TransactionContext` interface.
NodeModifiedTransactionContext(NodeModifiedEvent) - Constructor for class org.jboss.cache.search.NodeModifiedTransactionContext
  Creates a new instance of NodeModifiedTransactionContext.

## O

org.jboss.cache.search - package org.jboss.cache.search

## P

previous() - Method in class org.jboss.cache.search.LazyQueryResultIterator
previous() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  Returns the previous element in the list.
previousIndex() - Method in class org.jboss.cache.search.LazyQueryResultIterator
previousIndex() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  Returns the index of the element that would be returned by a subsequent call to previous.
put(String, K, V) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Puts something into the cache with a given Fqn, key and value.
put(String, Map<K, V>) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Puts something into the cache with a given Fqn and Map instance.
put(Fqn<?>, Map<K, V>) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Copies all of the mappings from the specified map to a Node.
put(Fqn<?>, K, V) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Associates the specified value with the specified key for a Node in this cache.
putForExternalRead(Fqn<?>, K, V) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Under special operating behavior, associates the value with the specified key for a node identified by the Fqn passed in.

## Q

QueryResultIterator - Interface in org.jboss.cache.search
  Iterates over query results

QueryResultIteratorImpl - Class in org.jboss.cache.search
  This is the implementation class for the interface QueryResultIterator which extends ListIterator.
QueryResultIteratorImpl(List<CacheEntityId>, CacheEntityLoader, int) - Constructor for class org.jboss.cache.search.QueryResultIteratorImpl

## R

registerSynchronization(Synchronization) - Method in class org.jboss.cache.search.NodeModifiedTransactionContext
  Registers the synchronization passed in as a parameter with the ongoing transaction.
remove() - Method in class org.jboss.cache.search.LazyQueryResultIterator
  This method is not supported and should not be used.
remove() - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  This method is not supported and should not be used.
remove(String, K) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Removes something from the cache with a given Fqn and key.
remove(Fqn<?>, K) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Moves a part of the cache to a different subtree.
removeCacheListener(Object) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Removes a listener from the cache.
removeNode(String) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Convenience method that takes a string representation of an Fqn.
removeNode(Fqn<?>) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Removes a Node indicated by absolute Fqn.
removeRegion(Fqn<?>) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Removes a region denoted by the Fqn passed in.

## S

SearchableCache<K,V> - Interface in org.jboss.cache.search
  This will be the most used interface in JBossCache searchable.
SearchableCacheConfiguration - Class in org.jboss.cache.search
  Class that implements `SearchConfiguration` so that within JBossCache Searchable, there is no need for a Hibernate Core configuration object.
SearchableCacheConfiguration(Class[], Properties) - Constructor for class org.jboss.cache.search.SearchableCacheConfiguration
SearchableCacheFactory - Class in org.jboss.cache.search
  Factory class used to create the searchable-cache like so: -

  SearchableCache searchableCache = SearchableCacheFactory.createSearchableCache(coreCache, class[]);

SearchableCacheFactory() - Constructor for class org.jboss.cache.search.SearchableCacheFactory
SearchableCacheImpl<K,V> - Class in org.jboss.cache.search
  Implementation class for the SearchableCache interface.
SearchableCacheImpl(Cache<K, V>, SearchFactoryImplementor) - Constructor for class org.jboss.cache.search.SearchableCacheImpl
SearchableCoreListener - Class in org.jboss.cache.search
SearchableCoreListener(SearchFactoryImplementor) - Constructor for class org.jboss.cache.search.SearchableCoreListener
set(Object) - Method in class org.jboss.cache.search.LazyQueryResultIterator
  This method is not supported in and should not be called.
set(Object) - Method in class org.jboss.cache.search.QueryResultIteratorImpl
  This method is not supported in and should not be called.
setFilter(Filter) - Method in interface org.jboss.cache.search.CacheQuery
  Allows lucene to filter the results.
setFilter(Filter) - Method in class org.jboss.cache.search.CacheQueryImpl
  Takes in a lucene filter and sets it to the filter field in the class.
setFirstResult(int) - Method in interface org.jboss.cache.search.CacheQuery
  Sets a result with a given index to the first result.
setFirstResult(int) - Method in class org.jboss.cache.search.CacheQueryImpl
  Sets the the result of the given integer value to the first result.
setInvocationContext(InvocationContext) - Method in class org.jboss.cache.search.SearchableCacheImpl
  Sets the passed in InvocationContext as current.
setMaxResults(int) - Method in interface org.jboss.cache.search.CacheQuery
  Sets the maximum number of results to the number passed in as a parameter.
setMaxResults(int) - Method in class org.jboss.cache.search.CacheQueryImpl
setSort(Sort) - Method in interface org.jboss.cache.search.CacheQuery
  Allows lucene to sort the results.
setSort(Sort) - Method in class org.jboss.cache.search.CacheQueryImpl
start() - Method in class org.jboss.cache.search.SearchableCacheImpl
  Lifecycle method that starts the cache loader, starts cache replication, starts the region manager, etc., and (if configured) warms the cache using a state transfer or cache loader preload.
stop() - Method in class org.jboss.cache.search.SearchableCacheImpl
  Lifecycle method that stops the cache, including replication, clustering, cache loading, notifications, etc., and clears all cache in-memory state.

## T

Transformer - Class in org.jboss.cache.search
  This class is one that does all the 'conversion' work between JBossCache and Hibernate Search.
Transformer() - Constructor for class org.jboss.cache.search.Transformer

## U

updateLuceneIndexes(NodeModifiedEvent) - Method in class org.jboss.cache.search.SearchableCoreListener
  Takes in a NodeModifiedEvent and updates the Lucene indexes using methods on the NodeModifiedEvent class.

A B C D E F G H I J L M N O P Q R S T U

Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

Copyright © 2008 JBoss, a division of Red Hat. All Rights Reserved.