org.hibernate.search.metadata
Interface FieldDescriptor

All Superinterfaces:
FieldSettingsDescriptor
All Known Implementing Classes:
FieldDescriptorImpl, NumericFieldDescriptorImpl

public interface FieldDescriptor
extends FieldSettingsDescriptor

Metadata related to a single field. It extends @{code FieldSettingsDescriptor} to add Search specific information, like indexNullAs(). It also contains the analyzer and field bridge used to create the actual field for the Lucene Document.

Author:
Hardy Ferentschik

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.hibernate.search.metadata.FieldSettingsDescriptor
FieldSettingsDescriptor.Type
 
Method Summary
 Analyzer getAnalyzer()
           
 FieldBridge getFieldBridge()
           
 boolean indexNull()
           
 String indexNullAs()
           
 
Methods inherited from interface org.hibernate.search.metadata.FieldSettingsDescriptor
as, getAnalyze, getBoost, getIndex, getName, getNorms, getStore, getTermVector, getType
 

Method Detail

indexNullAs

String indexNullAs()
Returns:
the string used to index null values. null in case null values are not indexed

indexNull

boolean indexNull()
Returns:
true if null values are indexed, false otherwise
See Also:
indexNullAs()

getFieldBridge

FieldBridge getFieldBridge()
Returns:
the field bridge instance used to convert the property value into a string based field value

getAnalyzer

Analyzer getAnalyzer()
Returns:
the analyzer used for this field, null if the field is not analyzed


Copyright © 2006-2013 Red Hat Middleware, LLC. All Rights Reserved