org.apache.maven.index.creator

Class MavenArchetypeArtifactInfoIndexCreator

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.index.creator.AbstractIndexCreator

org.apache.maven.index.creator.MavenArchetypeArtifactInfoIndexCreator

All Implemented Interfaces:

IndexCreator, org.codehaus.plexus.logging.LogEnabled

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

A Maven Archetype index creator used to detect and correct the artifact packaging to "maven-archetype" if the inspected JAR is an Archetype. Since packaging is already handled by Minimal creator, this Creator only alters the supplied ArtifactInfo packaging field during processing, but does not interferes with Lucene document fill-up or the ArtifactInfo fill-up (the update* methods are empty).

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	ARCHETYPE_XML_LOCATIONS
static java.lang.String	ID
private static java.lang.String	MAVEN_ARCHETYPE_PACKAGING

Constructor Summary

Constructors

Constructor and Description
MavenArchetypeArtifactInfoIndexCreator()

Method Summary

Modifier and Type	Method and Description
private void	checkMavenArchetype(ArtifactInfo ai, java.io.File artifact) Archetypes that are added will have their packaging types set correctly (to maven-archetype)
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_ARCHETYPE_PACKAGING

private static final java.lang.String MAVEN_ARCHETYPE_PACKAGING

See Also:

Constant Field Values

ARCHETYPE_XML_LOCATIONS

private static final java.lang.String[] ARCHETYPE_XML_LOCATIONS

Constructor Detail

MavenArchetypeArtifactInfoIndexCreator

public MavenArchetypeArtifactInfoIndexCreator()

Method Detail

populateArtifactInfo

public void populateArtifactInfo(ArtifactContext ac)

Description copied from interface: IndexCreator

Populate an ArtifactContext with information about corresponding artifact.

checkMavenArchetype

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

Archetypes that are added will have their packaging types set correctly (to maven-archetype)

Parameters:

ai -

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: