public interface IndexSourceMetadata
Modifier and Type | Method and Description |
---|---|
String |
getDefaultSearchField()
Gets the name of the field that would be searched against by default for this index source
|
FieldDescriptor |
getFieldDescriptor(String name)
Retrieves the field descriptor information for a given field
|
String |
getFieldDescriptorString()
Retrieves the String format of all the field descriptors information for this index source
|
Set<String> |
getFieldNames()
Retrieves all the field names specified in the index source
|
String |
getName()
Retrieves the name of the index source for which the metadata is for
|
String |
getProperty(String key)
Gets the defined proprty value for given property name
|
Set<String> |
getPropertyNames()
Gets the list of property names defined in this index source
|
String |
getSearchEngineName()
Gets the name of the Search Engine that this index source would use to index and search.
|
List<String> |
getSortableFields()
Retrieves the list of Sortable fields in the index source
|
String |
getUniqueIDField()
Gets the name of the unique id field of the index source
|
boolean |
indexableField(String fieldname)
Checks whether the specified field is indexable in the index source or not
|
boolean |
indexAllFields()
Checks whether all the fields in the index source are indexable or not
|
void |
setFieldDescriptorString(String fieldDescritporString)
Sets the String format of all the field descriptors information for this index source
|
void |
setProperty(String key, String value)
Sets the value for the given property name
|
String getName()
FieldDescriptor getFieldDescriptor(String name)
name
- the String name of the field interests inString getFieldDescriptorString()
void setFieldDescriptorString(String fieldDescritporString)
fieldDescritporString
- String format of the field descritors informationSet<String> getFieldNames()
boolean indexableField(String fieldname)
fieldname
- the String field nameboolean indexAllFields()
List<String> getSortableFields()
String getUniqueIDField()
String getDefaultSearchField()
String getProperty(String key)
key
- the property namevoid setProperty(String key, String value)
key
- the property namevalue
- the value for the property to be set toSet<String> getPropertyNames()
String getSearchEngineName()
SearchEngineConfig