|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IndexedTypeDescriptor
Top level descriptor of the metadata API. Giving access to the indexing information for a single type.
Method Summary | |
---|---|
BoostStrategy |
getDynamicBoost()
|
Set<FieldDescriptor> |
getFieldsForProperty(String propertyName)
Returns the set of index descriptors for the indexed field generated by the property with the given name. |
Set<IndexDescriptor> |
getIndexDescriptors()
Returns a set of IndexDescriptor instances describing Lucene index information, in particular the index name. |
FieldDescriptor |
getIndexedField(String fieldName)
Retrieves the field descriptor for a given field name. |
Set<PropertyDescriptor> |
getIndexedProperties()
|
PropertyDescriptor |
getProperty(String propertyName)
Retrieves the property descriptor for a given property name. |
float |
getStaticBoost()
|
Class<?> |
getType()
|
boolean |
isIndexed()
|
boolean |
isSharded()
|
Methods inherited from interface org.hibernate.search.metadata.FieldContributor |
---|
getIndexedFields |
Method Detail |
---|
Class<?> getType()
boolean isIndexed()
true
if the type for this descriptor is indexed, false
otherwiseboolean isSharded()
true
is this index is sharded, false
otherwiseSet<IndexDescriptor> getIndexDescriptors()
IndexDescriptor
instances describing Lucene index information, in particular the index name.
The index name can also be used to retrieve the actual IndexManager
for this index via
org.hibernate.search.engine.spi.SearchFactoryImplementor#getIndexManagerHolder()#getIndexManager(String)
.
For non sharded indexes there will be only a single IndexDescriptor
. The empty set is returned for an unindexed type
IndexDescriptor
instances describing Lucene index informationfloat getStaticBoost()
BoostStrategy getDynamicBoost()
Set<PropertyDescriptor> getIndexedProperties()
PropertyDescriptor
sPropertyDescriptor getProperty(String propertyName)
propertyName
- the property name for which to return descriptor, cannot be null
null
is returned in case a property with
the specified name does not exist
IllegalArgumentException
- in case propertyName
is null
FieldDescriptor getIndexedField(String fieldName)
fieldName
- the field name for which to return descriptor, cannot be null
null
is returned in case a field with the specified name does not exist
IllegalArgumentException
- in case fieldName
is null
Set<FieldDescriptor> getFieldsForProperty(String propertyName)
propertyName
- the property name, cannot be null
IllegalArgumentException
- in case propertyName
is null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |