Skip navigation links

com.fatwire.cs.core.search.source
Interface IndexSourceMetadata

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

getName

java.lang.String getName()

Retrieves the name of the index source for which the metadata is for

Returns:

the String name of the index source

getFieldDescriptor

FieldDescriptor getFieldDescriptor(java.lang.String name)

Retrieves the field descriptor information for a given field

Parameters:

name - the String name of the field interests in

Returns:

the FieldDescriptor of the given field

getFieldDescriptorString

java.lang.String getFieldDescriptorString()

Retrieves the String format of all the field descriptors information for this index source

Returns:

String format of the field descritors information

setFieldDescriptorString

void setFieldDescriptorString(java.lang.String fieldDescritporString)

Sets the String format of all the field descriptors information for this index source

Parameters:

fieldDescritporString - String format of the field descritors information

getFieldNames

java.util.Set<java.lang.String> getFieldNames()

Retrieves all the field names specified in the index source

Returns:

the Set of String names of all the fields

indexableField

boolean indexableField(java.lang.String fieldname)

Checks whether the specified field is indexable in the index source or not

Parameters:

fieldname - the String field name

Returns:

whether the specified field is indexable; true indicates the field is indexable, false indicates not

indexAllFields

boolean indexAllFields()

Checks whether all the fields in the index source are indexable or not

Returns:

true indicates all the fields are indexable; false indiates not all are indexable

getSortableFields

java.util.List<java.lang.String> getSortableFields()

Retrieves the list of Sortable fields in the index source

Returns:

the list of String names of all sortable fields

getUniqueIDField

java.lang.String getUniqueIDField()

Gets the name of the unique id field of the index source

Returns:

the String name of the unique id field

getDefaultSearchField

java.lang.String getDefaultSearchField()

Gets the name of the field that would be searched against by default for this index source

Returns:

the String name of the default searched field

getProperty

java.lang.String getProperty(java.lang.String key)

Gets the defined proprty value for given property name

Parameters:

key - the property name

Returns:

the String value of the defined property

setProperty

void setProperty(java.lang.String key,
                 java.lang.String value)

Sets the value for the given property name

Parameters:

key - the property name

value - the value for the property to be set to

getPropertyNames

java.util.Set<java.lang.String> getPropertyNames()

Gets the list of property names defined in this index source

Returns:

the list of String names of all defined property

getSearchEngineName

java.lang.String getSearchEngineName()

Gets the name of the Search Engine that this index source would use to index and search. One could use this name and get the metadata information of the search engine using SearchEngineConfig

Returns:

the String name of the Search Engine that this index source would use

Skip navigation links