|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FieldSettingsDescriptor
Metadata related to a single Lucene Document field and its options. Some of the values in this interface do not have a direct counterpart in the Lucene works, but are an abstraction of Hibernate Search and mapped to the appropriate Lucene construct.
Nested Class Summary | |
---|---|
static class |
FieldSettingsDescriptor.Type
Defines different logical field types |
Method Summary | ||
---|---|---|
|
as(Class<T> type)
Narrows the type of this descriptor down to the specified type . |
|
Analyze |
getAnalyze()
|
|
float |
getBoost()
|
|
Index |
getIndex()
|
|
String |
getName()
Returns the Lucene Document field name for this indexed property. |
|
Norms |
getNorms()
|
|
Store |
getStore()
|
|
TermVector |
getTermVector()
|
|
FieldSettingsDescriptor.Type |
getType()
|
Method Detail |
---|
String getName()
Document
field name for this indexed property.
Index getIndex()
Index
enum instance defining whether this field is indexedAnalyze getAnalyze()
Analyze
enum instance defining the type of analyzing applied to this fieldStore getStore()
Store
enum instance defining whether the index value is stored in the index itselfTermVector getTermVector()
TermVector
enum instance defining whether and how term vectors are stored for this fieldNorms getNorms()
Norms
enum instance defining whether and how norms are stored for this fieldfloat getBoost()
FieldSettingsDescriptor.Type getType()
Type
of this field<T extends FieldSettingsDescriptor> T as(Class<T> type)
type
. The appropriate
type should be checked beforehand by calling getType()
.
T
- the type to narrow down totype
- class object representing the descriptor type to narrow down to
to
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |