Package org.apache.maven.index
Class DefaultIndexer
java.lang.Object
org.apache.maven.index.DefaultIndexer
- All Implemented Interfaces:
Indexer
A default
Indexer
implementation.- Author:
- Tamas Cservenak
-
Constructor Summary
ConstructorDescriptionDefaultIndexer
(SearchEngine searcher, IndexerEngine indexerEngine, QueryCreator queryCreator) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addArtifactsToIndex
(Collection<ArtifactContext> ac, IndexingContext context) Adds the passed in artifact contexts to passed in indexing context.void
addArtifactToIndex
(ArtifactContext ac, IndexingContext context) Adds the passed in artifact contexts to passed in indexing context.void
closeIndexingContext
(IndexingContext context, boolean deleteFiles) Closes the indexing context: closes it and deletes (if specified) the index files.org.apache.lucene.search.Query
constructQuery
(Field field, String expression, SearchType searchType) Helper method to construct Lucene query for given field without need for knowledge (on caller side) HOW is a field indexed, and WHAT query is needed to achieve that search.org.apache.lucene.search.Query
constructQuery
(Field field, SearchExpression expression) Helper method to construct Lucene query for given field without need for knowledge (on caller side) HOW is a field indexed, and WHAT query is needed to achieve that search.createIndexingContext
(String id, String repositoryId, File repository, File indexDirectory, String repositoryUrl, String indexUpdateUrl, boolean searchable, boolean reclaim, List<? extends IndexCreator> indexers) Creates an indexing context.createMergedIndexingContext
(String id, String repositoryId, File repository, File indexDirectory, boolean searchable, ContextMemberProvider membersProvider) Creates a merged indexing context.void
deleteArtifactsFromIndex
(Collection<ArtifactContext> ac, IndexingContext context) Removes the passed in artifacts contexts from passed in indexing context.identify
(File artifact, Collection<IndexingContext> contexts) Performs an "identity" search.identify
(org.apache.lucene.search.Query query, Collection<IndexingContext> contexts) Performs an "identity" search.searchFlat
(FlatSearchRequest request) Searches according the request parameters.searchGrouped
(GroupedSearchRequest request) Searches according the request parameters.searchIterator
(IteratorSearchRequest request) Searches according to request parameters.
-
Constructor Details
-
DefaultIndexer
@Inject public DefaultIndexer(SearchEngine searcher, IndexerEngine indexerEngine, QueryCreator queryCreator)
-
-
Method Details
-
createIndexingContext
public IndexingContext createIndexingContext(String id, String repositoryId, File repository, File indexDirectory, String repositoryUrl, String indexUpdateUrl, boolean searchable, boolean reclaim, List<? extends IndexCreator> indexers) throws IOException, ExistingLuceneIndexMismatchException, IllegalArgumentException Description copied from interface:Indexer
Creates an indexing context.- Specified by:
createIndexingContext
in interfaceIndexer
- Parameters:
id
- the ID of the context.repositoryId
- the ID of the repository that this context represents. You might have several contexts indexing same repository ID, but on separate locations.repository
- the location of the repository on FS.indexDirectory
- the location of the Lucene indexes on FS.repositoryUrl
- the location of the remote repository ornull
if this indexing context does not need remote updates (is not a proxy).indexUpdateUrl
- the alternate location of the remote repository indexes (if they are not in default place) ornull
if defaults are applicable.searchable
- if context should be searched in non-targeted mode.reclaim
- if indexDirectory is known to contain (or should contain) valid Maven Indexer lucene index, and no checks needed to be performed, or, if we want to "stomp" over existing index (unsafe to do!).indexers
- the set of indexers to apply to this context.- Returns:
- the context created.
- Throws:
IOException
- in case of some serious IO problem.ExistingLuceneIndexMismatchException
- if a Lucene index already exists where location is specified, but it has no Nexus descriptor record or it has, but the embedded repoId differs from the repoId specified from the supplied one. Never thrown ifreclaim
istrue
, as in that case, if Lucene index exists but any of those criteria above are not met, the existing index is overwritten, and equipped with proper descriptor silently.IllegalArgumentException
- in case the supplied list of IndexCreators are having non-satisfiable dependencies.
-
createMergedIndexingContext
public IndexingContext createMergedIndexingContext(String id, String repositoryId, File repository, File indexDirectory, boolean searchable, ContextMemberProvider membersProvider) throws IOException Description copied from interface:Indexer
Creates a merged indexing context.- Specified by:
createMergedIndexingContext
in interfaceIndexer
- Parameters:
id
- the ID of the context.repositoryId
- the ID of the repository that this context represents. You might have several contexts indexing same repository ID, but on separate locations.repository
- the location of the repository on FS.indexDirectory
- the location of the Lucene indexes on FS.searchable
- if context should be searched in non-targeted mode.membersProvider
- theContextMemberProvider
, never null.- Returns:
- the context created.
- Throws:
IOException
- in case of some serious IO problem.
-
closeIndexingContext
Description copied from interface:Indexer
Closes the indexing context: closes it and deletes (if specified) the index files.- Specified by:
closeIndexingContext
in interfaceIndexer
- Parameters:
context
- the one needed to be closed, nevernull
.deleteFiles
-true
if all indexer related files (including Lucene index!) needs to be deleted,false
otherwise.- Throws:
IOException
-
addArtifactToIndex
Description copied from interface:Indexer
Adds the passed in artifact contexts to passed in indexing context.- Specified by:
addArtifactToIndex
in interfaceIndexer
- Parameters:
ac
-context
-- Throws:
IOException
-
addArtifactsToIndex
public void addArtifactsToIndex(Collection<ArtifactContext> ac, IndexingContext context) throws IOException Description copied from interface:Indexer
Adds the passed in artifact contexts to passed in indexing context.- Specified by:
addArtifactsToIndex
in interfaceIndexer
- Parameters:
ac
-context
-- Throws:
IOException
-
deleteArtifactsFromIndex
public void deleteArtifactsFromIndex(Collection<ArtifactContext> ac, IndexingContext context) throws IOException Description copied from interface:Indexer
Removes the passed in artifacts contexts from passed in indexing context.- Specified by:
deleteArtifactsFromIndex
in interfaceIndexer
- Parameters:
ac
-context
-- Throws:
IOException
-
searchFlat
Description copied from interface:Indexer
Searches according the request parameters.- Specified by:
searchFlat
in interfaceIndexer
- Parameters:
request
-- Returns:
- search response
- Throws:
IOException
-
searchIterator
Description copied from interface:Indexer
Searches according to request parameters.- Specified by:
searchIterator
in interfaceIndexer
- Parameters:
request
-- Returns:
- search response
- Throws:
IOException
-
searchGrouped
Description copied from interface:Indexer
Searches according the request parameters.- Specified by:
searchGrouped
in interfaceIndexer
- Parameters:
request
-- Returns:
- search response
- Throws:
IOException
-
identify
public Collection<ArtifactInfo> identify(File artifact, Collection<IndexingContext> contexts) throws IOException Description copied from interface:Indexer
Performs an "identity" search. Passed inFile
will have SHA1 hash calculated, and anIndexer.identify(Query, Collection)
method will be invoked searching with calculated hash theMAVEN.SHA1
field. This is just a shorthand method, as these calls are simply calculating hex encoded SHA1 of the file, and invoking theIndexer.constructQuery(Field, SearchExpression)
andIndexer.identify(Query, Collection)
methods.- Specified by:
identify
in interfaceIndexer
- Parameters:
artifact
- the filecontexts
- in which to perform the action- Returns:
- collection of identified matches.
- Throws:
IOException
-
identify
public Collection<ArtifactInfo> identify(org.apache.lucene.search.Query query, Collection<IndexingContext> contexts) throws IOException Description copied from interface:Indexer
Performs an "identity" search. Those are usually simple key-value queries, involving "unique" fields likeMAVEN.SHA1
or such.- Specified by:
identify
in interfaceIndexer
- Parameters:
query
-contexts
-- Returns:
- collection of identified matches.
- Throws:
IOException
-
constructQuery
public org.apache.lucene.search.Query constructQuery(Field field, SearchExpression expression) throws IllegalArgumentException Description copied from interface:Indexer
Helper method to construct Lucene query for given field without need for knowledge (on caller side) HOW is a field indexed, and WHAT query is needed to achieve that search.- Specified by:
constructQuery
in interfaceIndexer
- Parameters:
field
-expression
-- Returns:
- the query to be used for search.
- Throws:
IllegalArgumentException
- See Also:
-
constructQuery
public org.apache.lucene.search.Query constructQuery(Field field, String expression, SearchType searchType) throws IllegalArgumentException Description copied from interface:Indexer
Helper method to construct Lucene query for given field without need for knowledge (on caller side) HOW is a field indexed, and WHAT query is needed to achieve that search.- Specified by:
constructQuery
in interfaceIndexer
- Parameters:
field
-expression
-searchType
-- Returns:
- Throws:
IllegalArgumentException
-