public abstract class QueryIndexProvider extends Object
Constructor and Description |
---|
QueryIndexProvider() |
Modifier and Type | Method and Description |
---|---|
abstract QueryIndexPlanner |
getIndexPlanner()
Get the planner that, during the query planning/optimization phase, evaluates for a single source the AND-ed query
constraints and defines indexes that may be used.
|
protected Logger |
getLogger() |
String |
getName()
Get the name for this provider.
|
abstract QueryIndex |
getQueryIndex(String indexName)
Get the queryable index with the given name.
|
abstract QueryIndexWriter |
getQueryIndexWriter()
Get the writer that ModeShape can use to update the indexes when repository content changes.
|
String |
getRepositoryName()
Get the name of the repository.
|
void |
initialize()
Initialize the provider.
|
void |
shutdown()
Signal this provider that it is no longer needed and can release any resources that are being held.
|
protected final Logger getLogger()
public final String getName()
public final String getRepositoryName()
public void initialize() throws RepositoryException
By default this method does nothing, so it should be overridden by implementations to do a one-time initialization of any internal components after all of the fields have been set during instantiation.
RepositoryException
- if there is a problem initializing the provider failpublic void shutdown() throws RepositoryException
RepositoryException
- if there is a problem shutting down the providerpublic abstract QueryIndexWriter getQueryIndexWriter()
public abstract QueryIndex getQueryIndex(String indexName)
indexName
- the name of the index in this provider; never nullpublic abstract QueryIndexPlanner getIndexPlanner()
This method is typically called only once after the provider has been initialized
.
Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.