org.apache.maven.index.creator

Class MavenPluginArtifactInfoIndexCreator

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.index.creator.AbstractIndexCreator

org.apache.maven.index.creator.MavenPluginArtifactInfoIndexCreator

All Implemented Interfaces:

IndexCreator, org.codehaus.plexus.logging.LogEnabled

@Component(role=IndexCreator.class,
           hint="maven-plugin")
public class MavenPluginArtifactInfoIndexCreator
extends AbstractIndexCreator

A Maven Plugin index creator used to provide information about Maven Plugins. It will collect the plugin prefix and the goals the plugin provides. Also, the Lucene document and the returned ArtifactInfo will be correctly filled with these information.

Field Summary

Fields

Modifier and Type	Field and Description
static IndexerField	FLD_PLUGIN_GOALS
static IndexerField	FLD_PLUGIN_PREFIX
static java.lang.String	ID
private static java.lang.String	MAVEN_PLUGIN_PACKAGING

Constructor Summary

Constructors

Constructor and Description
MavenPluginArtifactInfoIndexCreator()

Method Summary

Modifier and Type	Method and Description
private void	checkMavenPlugin(ArtifactInfo ai, java.io.File artifact)
java.util.Collection<IndexerField>	getIndexerFields() Returns the indexer fields that this IndexCreator introduces to index.
void	populateArtifactInfo(ArtifactContext ac) Populate an ArtifactContext with information about corresponding artifact.
java.lang.String	toString()
boolean	updateArtifactInfo(org.apache.lucene.document.Document doc, ArtifactInfo ai) Update an ArtifactInfo from given Lucene Document.
void	updateDocument(ArtifactInfo ai, org.apache.lucene.document.Document doc) Update Lucene Document from a given ArtifactInfo.

Methods inherited from class org.apache.maven.index.creator.AbstractIndexCreator

bos, getCreatorDependencies, getId, sob

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

MAVEN_PLUGIN_PACKAGING

private static final java.lang.String MAVEN_PLUGIN_PACKAGING

See Also:

Constant Field Values

FLD_PLUGIN_PREFIX

public static final IndexerField FLD_PLUGIN_PREFIX

FLD_PLUGIN_GOALS

public static final IndexerField FLD_PLUGIN_GOALS

Constructor Detail

MavenPluginArtifactInfoIndexCreator

public MavenPluginArtifactInfoIndexCreator()

Method Detail

populateArtifactInfo

public void populateArtifactInfo(ArtifactContext ac)

Description copied from interface: IndexCreator

Populate an ArtifactContext with information about corresponding artifact.

checkMavenPlugin

private void checkMavenPlugin(ArtifactInfo ai,
                              java.io.File artifact)

updateDocument

public void updateDocument(ArtifactInfo ai,
                           org.apache.lucene.document.Document doc)

Description copied from interface: IndexCreator

Update Lucene Document from a given ArtifactInfo.

updateArtifactInfo

public boolean updateArtifactInfo(org.apache.lucene.document.Document doc,
                                  ArtifactInfo ai)

Description copied from interface: IndexCreator

Update an ArtifactInfo from given Lucene Document.

Returns:

true is artifact info has been updated

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIndexerFields

public java.util.Collection<IndexerField> getIndexerFields()

Description copied from interface: IndexCreator

Returns the indexer fields that this IndexCreator introduces to index.

Returns: