org.apache.maven.index
Class IndexerField

java.lang.Object
  org.apache.maven.index.IndexerField

public class IndexerField
extends Object

Holds basic information about Indexer field, how it is stored. To keep this centralized, and not spread across code. Since Lucene 2.x, the field names are encoded, so please use real chatty names instead of cryptic chars!

Author:

cstamas

Constructor Summary

IndexerField(Field ontology, IndexerFieldVersion version, String key, String description, org.apache.lucene.document.Field.Store storeMethod, org.apache.lucene.document.Field.Index indexMethod)

IndexerField(Field ontology, IndexerFieldVersion version, String key, String description, org.apache.lucene.document.Field.Store storeMethod, org.apache.lucene.document.Field.Index indexMethod, org.apache.lucene.document.Field.TermVector termVector)

Method Summary

org.apache.lucene.document.Field.Index	getIndexMethod()
String	getKey()
Field	getOntology()
org.apache.lucene.document.Field.Store	getStoreMethod()
org.apache.lucene.document.Field.TermVector	getTermVector()
IndexerFieldVersion	getVersion()
boolean	isIndexed()
boolean	isKeyword()
boolean	isStored()
org.apache.lucene.document.Field	toField(String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexerField

public IndexerField(Field ontology,
                    IndexerFieldVersion version,
                    String key,
                    String description,
                    org.apache.lucene.document.Field.Store storeMethod,
                    org.apache.lucene.document.Field.Index indexMethod)

IndexerField

public IndexerField(Field ontology,
                    IndexerFieldVersion version,
                    String key,
                    String description,
                    org.apache.lucene.document.Field.Store storeMethod,
                    org.apache.lucene.document.Field.Index indexMethod,
                    org.apache.lucene.document.Field.TermVector termVector)

Method Detail

getOntology

public Field getOntology()

getVersion

public IndexerFieldVersion getVersion()

getKey

public String getKey()

getStoreMethod

public org.apache.lucene.document.Field.Store getStoreMethod()

getIndexMethod

public org.apache.lucene.document.Field.Index getIndexMethod()

getTermVector

public org.apache.lucene.document.Field.TermVector getTermVector()

isIndexed

public boolean isIndexed()

isKeyword

public boolean isKeyword()

isStored

public boolean isStored()

toField

public org.apache.lucene.document.Field toField(String value)