Package org.apache.maven.index.context

Class DefaultIndexingContext

java.lang.Object

org.apache.maven.index.context.AbstractIndexingContext

org.apache.maven.index.context.DefaultIndexingContext

All Implemented Interfaces:

IndexingContext

public class DefaultIndexingContext
extends AbstractIndexingContext

The default IndexingContext implementation.

Author:

Jason van Zyl, Tamas Cservenak

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FLD_DESCRIPTOR
static final String	FLD_DESCRIPTOR_CONTENTS
static final String	FLD_IDXINFO
static final String	VERSION

Fields inherited from interface org.apache.maven.index.context.IndexingContext

INDEX_CHAIN_ID, INDEX_CHUNK_COUNTER, INDEX_CHUNK_PREFIX, INDEX_FILE_PREFIX, INDEX_ID, INDEX_LEGACY_TIMESTAMP, INDEX_PACKER_PROPERTIES_FILE, INDEX_PROPERTY_PREFIX, INDEX_REMOTE_PROPERTIES_FILE, INDEX_TIME_DAY_FORMAT, INDEX_TIME_FORMAT, INDEX_TIMESTAMP, INDEX_UPDATER_PROPERTIES_FILE

Constructor Summary

Constructors

Constructor	Description
DefaultIndexingContext(String id, String repositoryId, File repository, File indexDirectoryFile, String repositoryUrl, String indexUpdateUrl, List<? extends IndexCreator> indexCreators, boolean reclaimIndex)
DefaultIndexingContext(String id, String repositoryId, File repository, org.apache.lucene.store.Directory indexDirectory, String repositoryUrl, String indexUpdateUrl, List<? extends IndexCreator> indexCreators, boolean reclaimIndex)	Deprecated.

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.search.IndexSearcher	acquireIndexSearcher()	Acquires a fresh instance of IndexSearcher.
void	close(boolean deleteFiles)	Shuts down this context.
void	commit()	Commits changes to context, eventually refreshing readers/searchers too.
Set<String>	getAllGroups()	Gets all group names stored in the current indexing context
org.apache.lucene.analysis.Analyzer	getAnalyzer()	Returns the Lucene Analyzer of this context used for by IndexWriter and IndexSearcher.
GavCalculator	getGavCalculator()	Returns the GavCalculator for this Context.
String	getId()	Returns this indexing context id.
List<IndexCreator>	getIndexCreators()	List of IndexCreators used in this context.
org.apache.lucene.store.Directory	getIndexDirectory()
File	getIndexDirectoryFile()
String	getIndexUpdateUrl()	Returns url for the index update
org.apache.lucene.index.IndexWriter	getIndexWriter()	Returns the Lucene IndexWriter (thread safe, shared instance) of this context.
File	getRepository()	Returns location for the local repository.
String	getRepositoryId()	Returns repository id.
String	getRepositoryUrl()	Returns public repository url.
Set<String>	getRootGroups()	Gets root group names stored in the current indexing context
int	getSize()	Returns a number that represents the "size" useful for doing comparisons between contexts (which one has more data indexed?).
Date	getTimestamp()	Returns index update time
protected org.apache.lucene.index.IndexWriterConfig	getWriterConfig()	Returns new IndexWriterConfig instance
boolean	isSearchable()	Is the context searchable when doing "non-targeted" searches? Ie.
void	merge(org.apache.lucene.store.Directory directory)	Merges content of given Lucene directory with this context.
void	merge(org.apache.lucene.store.Directory directory, DocumentFilter filter)	Merges content of given Lucene directory with this context, but filters out the unwanted ones.
void	merge(org.apache.lucene.store.Directory directory, DocumentFilter filter, Set<String> allGroups, Set<String> rootGroups)	Merges content of given Lucene directory with this context, but filters out the unwanted ones and adds the groups to the context.
protected void	openAndWarmup()
void	optimize()	Optimizes index.
void	purge()	Purge (cleans) the context, deletes/empties the index and restores the context to new/empty state.
void	rebuildGroups()	Rebuilds stored group names from the index
void	releaseIndexSearcher(org.apache.lucene.search.IndexSearcher is)	Releases the IndexSearcher instance.
void	replace(org.apache.lucene.store.Directory directory)	Replaces the Lucene index with the one from supplied directory.
void	replace(org.apache.lucene.store.Directory directory, Set<String> allGroups, Set<String> rootGroups)
void	rollback()	Rolls back changes to context, eventually refreshing readers/searchers too.
void	setAllGroups(Collection<String> groups)	Sets all group names stored in the current indexing context
protected void	setIndexDirectoryFile(File dir)	Sets index location.
void	setRootGroups(Collection<String> groups)	Sets root group names stored in the current indexing context
void	setSearchable(boolean searchable)	Sets is the context searchable when doing "non-targeted" searches.
String	toString()
void	updateTimestamp()
void	updateTimestamp(boolean save)
void	updateTimestamp(boolean save, Date timestamp)

Methods inherited from class org.apache.maven.index.context.AbstractIndexingContext

isReceivingUpdates

Methods inherited from class java.lang.Object

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

Field Details

FLD_DESCRIPTOR

public static final String FLD_DESCRIPTOR

See Also:

• Constant Field Values

FLD_DESCRIPTOR_CONTENTS

public static final String FLD_DESCRIPTOR_CONTENTS

See Also:

• Constant Field Values

FLD_IDXINFO

public static final String FLD_IDXINFO

See Also:

• Constant Field Values

VERSION

public static final String VERSION

See Also:

• Constant Field Values

Constructor Details

DefaultIndexingContext

public DefaultIndexingContext(String id,
 String repositoryId,
 File repository,
 File indexDirectoryFile,
 String repositoryUrl,
 String indexUpdateUrl,
 List<? extends IndexCreator> indexCreators,
 boolean reclaimIndex)
                       throws IOException,
ExistingLuceneIndexMismatchException

Throws:

IOException

ExistingLuceneIndexMismatchException

DefaultIndexingContext

@Deprecated
public DefaultIndexingContext(String id,
 String repositoryId,
 File repository,
 org.apache.lucene.store.Directory indexDirectory,
 String repositoryUrl,
 String indexUpdateUrl,
 List<? extends IndexCreator> indexCreators,
 boolean reclaimIndex)
                       throws IOException,
ExistingLuceneIndexMismatchException

Deprecated.

Throws:

IOException

ExistingLuceneIndexMismatchException

Method Details

getIndexDirectory

public org.apache.lucene.store.Directory getIndexDirectory()

setIndexDirectoryFile

protected void setIndexDirectoryFile(File dir)
                              throws IOException

Sets index location. As usually index is persistent (is on disk), this will point to that value, but in some circumstances (ie, using RAMDisk for index), this will point to an existing tmp directory.

Throws:

IOException

getIndexDirectoryFile

public File getIndexDirectoryFile()

isSearchable

public boolean isSearchable()

Description copied from interface: IndexingContext

Is the context searchable when doing "non-targeted" searches? Ie. Should it take a part when searching without specifying context?

Returns:

setSearchable

public void setSearchable(boolean searchable)

Description copied from interface: IndexingContext

Sets is the context searchable when doing "non-targeted" searches.

Parameters:

searchable -

getId

public String getId()

Description copied from interface: IndexingContext

Returns this indexing context id.

updateTimestamp

public void updateTimestamp()
                     throws IOException

Throws:

IOException

updateTimestamp

public void updateTimestamp(boolean save)
                     throws IOException

Throws:

IOException

updateTimestamp

public void updateTimestamp(boolean save,
 Date timestamp)
                     throws IOException

Throws:

IOException

getTimestamp

public Date getTimestamp()

Description copied from interface: IndexingContext

Returns index update time

getSize

public int getSize()
            throws IOException

Description copied from interface: IndexingContext

Returns a number that represents the "size" useful for doing comparisons between contexts (which one has more data indexed?). The number return does not represent the count of ArtifactInfos, neither other "meaningful" info, it is purely to be used for inter-context comparisons only!

Returns:

Throws:

IOException

getRepositoryId

public String getRepositoryId()

Description copied from interface: IndexingContext

Returns repository id.

getRepository

public File getRepository()

Description copied from interface: IndexingContext

Returns location for the local repository.

getRepositoryUrl

public String getRepositoryUrl()

Description copied from interface: IndexingContext

Returns public repository url.

getIndexUpdateUrl

public String getIndexUpdateUrl()

Description copied from interface: IndexingContext

Returns url for the index update

getAnalyzer

public org.apache.lucene.analysis.Analyzer getAnalyzer()

Description copied from interface: IndexingContext

Returns the Lucene Analyzer of this context used for by IndexWriter and IndexSearcher. Note: this method always creates a new instance of analyzer!

Returns:

openAndWarmup

protected void openAndWarmup()
                      throws IOException

Throws:

IOException

getWriterConfig

protected org.apache.lucene.index.IndexWriterConfig getWriterConfig()

Returns new IndexWriterConfig instance

Since:

5.1

getIndexWriter

public org.apache.lucene.index.IndexWriter getIndexWriter()
                                                   throws IOException

Description copied from interface: IndexingContext

Returns the Lucene IndexWriter (thread safe, shared instance) of this context.

Returns:

indexWriter

Throws:

IOException

acquireIndexSearcher

public org.apache.lucene.search.IndexSearcher acquireIndexSearcher()
                                                            throws IOException

Description copied from interface: IndexingContext

Acquires a fresh instance of IndexSearcher. You have to release the received instance with IndexingContext.releaseIndexSearcher(IndexSearcher) otherwise you are about to introduce leak.

Returns:

Throws:

IOException

releaseIndexSearcher

public void releaseIndexSearcher(org.apache.lucene.search.IndexSearcher is)
                          throws IOException

Description copied from interface: IndexingContext

Releases the IndexSearcher instance.

Parameters:

is -

Throws:

IOException

commit

public void commit()
            throws IOException

Description copied from interface: IndexingContext

Commits changes to context, eventually refreshing readers/searchers too.

Throws:

IOException

rollback

public void rollback()
              throws IOException

Description copied from interface: IndexingContext

Rolls back changes to context, eventually refreshing readers/searchers too.

Throws:

IOException

optimize

public void optimize()
              throws org.apache.lucene.index.CorruptIndexException,
IOException

Description copied from interface: IndexingContext

Optimizes index. According to Lucene 3.6+ Javadoc, there is no more sense to optimize, so this method might become "noop".

Throws:

org.apache.lucene.index.CorruptIndexException

IOException

close

public void close(boolean deleteFiles)
           throws IOException

Description copied from interface: IndexingContext

Shuts down this context.

Throws:

IOException

purge

public void purge()
           throws IOException

Description copied from interface: IndexingContext

Purge (cleans) the context, deletes/empties the index and restores the context to new/empty state.

Throws:

IOException

replace

public void replace(org.apache.lucene.store.Directory directory)
             throws IOException

Description copied from interface: IndexingContext

Replaces the Lucene index with the one from supplied directory.

Parameters:

directory -

Throws:

IOException

replace

public void replace(org.apache.lucene.store.Directory directory,
 Set<String> allGroups,
 Set<String> rootGroups)
             throws IOException

Throws:

IOException

merge

public void merge(org.apache.lucene.store.Directory directory)
           throws IOException

Description copied from interface: IndexingContext

Merges content of given Lucene directory with this context.

Parameters:

directory - - the directory to merge

Throws:

IOException

merge

public void merge(org.apache.lucene.store.Directory directory,
 DocumentFilter filter)
           throws IOException

Description copied from interface: IndexingContext

Merges content of given Lucene directory with this context, but filters out the unwanted ones.

Parameters:

directory - - the directory to merge

Throws:

IOException

merge

public void merge(org.apache.lucene.store.Directory directory,
 DocumentFilter filter,
 Set<String> allGroups,
 Set<String> rootGroups)
           throws IOException

Description copied from interface: IndexingContext

Merges content of given Lucene directory with this context, but filters out the unwanted ones and adds the groups to the context.

Parameters:

directory - - the directory to merge

Throws:

IOException

getGavCalculator

public GavCalculator getGavCalculator()

Description copied from interface: IndexingContext

Returns the GavCalculator for this Context. Implies repository layout.

getIndexCreators

public List<IndexCreator> getIndexCreators()

Description copied from interface: IndexingContext

List of IndexCreators used in this context.

Returns:

list of index creators.

rebuildGroups

public void rebuildGroups()
                   throws IOException

Description copied from interface: IndexingContext

Rebuilds stored group names from the index

Throws:

IOException

getAllGroups

public Set<String> getAllGroups()

Description copied from interface: IndexingContext

Gets all group names stored in the current indexing context

setAllGroups

public void setAllGroups(Collection<String> groups)

Description copied from interface: IndexingContext

Sets all group names stored in the current indexing context

getRootGroups

public Set<String> getRootGroups()
                          throws IOException

Description copied from interface: IndexingContext

Gets root group names stored in the current indexing context

Throws:

IOException

setRootGroups

public void setRootGroups(Collection<String> groups)

Description copied from interface: IndexingContext

Sets root group names stored in the current indexing context

toString

public String toString()

Overrides:

toString in class Object