|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IndexSourceMetadata
IndexSourceMetadata represents the metadata information for a given index source in Content Server.
Method Summary | |
---|---|
java.lang.String |
getDefaultSearchField()
Gets the name of the field that would be searched against by default for this index source |
FieldDescriptor |
getFieldDescriptor(java.lang.String name)
Retrieves the field descriptor information for a given field |
java.lang.String |
getFieldDescriptorString()
Retrieves the String format of all the field descriptors information for this index source |
java.util.Set<java.lang.String> |
getFieldNames()
Retrieves all the field names specified in the index source |
java.lang.String |
getName()
Retrieves the name of the index source for which the metadata is for |
java.lang.String |
getProperty(java.lang.String key)
Gets the defined proprty value for given property name |
java.util.Set<java.lang.String> |
getPropertyNames()
Gets the list of property names defined in this index source |
java.lang.String |
getSearchEngineName()
Gets the name of the Search Engine that this index source would use to index and search. |
java.util.List<java.lang.String> |
getSortableFields()
Retrieves the list of Sortable fields in the index source |
java.lang.String |
getUniqueIDField()
Gets the name of the unique id field of the index source |
boolean |
indexableField(java.lang.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(java.lang.String fieldDescritporString)
Sets the String format of all the field descriptors information for this index source |
void |
setProperty(java.lang.String key,
java.lang.String value)
Sets the value for the given property name |
Method Detail |
---|
java.lang.String getName()
FieldDescriptor getFieldDescriptor(java.lang.String name)
name
- the String name of the field interests in
java.lang.String getFieldDescriptorString()
void setFieldDescriptorString(java.lang.String fieldDescritporString)
fieldDescritporString
- String format of the field descritors informationjava.util.Set<java.lang.String> getFieldNames()
boolean indexableField(java.lang.String fieldname)
fieldname
- the String field name
boolean indexAllFields()
java.util.List<java.lang.String> getSortableFields()
java.lang.String getUniqueIDField()
java.lang.String getDefaultSearchField()
java.lang.String getProperty(java.lang.String key)
key
- the property name
void setProperty(java.lang.String key, java.lang.String value)
key
- the property namevalue
- the value for the property to be set tojava.util.Set<java.lang.String> getPropertyNames()
java.lang.String getSearchEngineName()
SearchEngineConfig
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |