MetadataIndexingOptions (GroupDocs.Search (26.6) API Reference)

java.lang.Object
- com.groupdocs.search.options.MetadataIndexingOptions

```
public abstract class MetadataIndexingOptions
extends Object
```
Provides options for indexing metadata fields.
Learn more
- Indexing options
- MetadataIndexingOptions are used when retrieving document text from an index: Getting indexed documents
- MetadataIndexingOptions are used when highlighting search results: Highlighting search results

Constructor Summary

Constructors
Constructor and Description

MetadataIndexingOptions()

Constructors
Constructor and Description
`MetadataIndexingOptions()`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract String`	`getDefaultFieldName()` Gets the default field name used to index empty field names.
`abstract boolean`	`getIndexingEmptyNames()` Gets a value indicating whether to index empty field names or not.
`abstract boolean`	`getIndexingEmptyValues()` Gets a value indicating whether to index empty field values or not.
`abstract int`	`getMaxBytesToIndexField()` Gets the maximum number of values in an array of type byte to index the field.
`abstract int`	`getMaxDoublesToIndexField()` Gets the maximum number of values in an array of type double to index the field.
`abstract int`	`getMaxIntsToIndexField()` Gets the maximum number of values in an array of type int to index the field.
`abstract int`	`getMaxLongsToIndexField()` Gets the maximum number of values in an array of type long to index the field.
`abstract String`	`getSeparatorBetweenValues()` Gets the separator between values in a field of type array.
`abstract String`	`getSeparatorInCompoundName()` Gets the separator in the compound name of a field.
`abstract void`	`setDefaultFieldName(String value)` Sets the default field name used to index empty field names.
`abstract void`	`setIndexingEmptyNames(boolean value)` Sets a value indicating whether to index empty field names or not.
`abstract void`	`setIndexingEmptyValues(boolean value)` Sets a value indicating whether to index empty field values or not.
`abstract void`	`setMaxBytesToIndexField(int value)` Sets the maximum number of values in an array of type byte to index the field.
`abstract void`	`setMaxDoublesToIndexField(int value)` Sets the maximum number of values in an array of type double to index the field.
`abstract void`	`setMaxIntsToIndexField(int value)` Sets the maximum number of values in an array of type int to index the field.
`abstract void`	`setMaxLongsToIndexField(int value)` Sets the maximum number of values in an array of type long to index the field.
`abstract void`	`setSeparatorBetweenValues(String value)` Sets the separator between values in a field of type array.
`abstract void`	`setSeparatorInCompoundName(String value)` Sets the separator in the compound name of a field.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MetadataIndexingOptions
```
public MetadataIndexingOptions()
```
- Method Detail
  - getDefaultFieldName
```
public abstract String getDefaultFieldName()
```
    Gets the default field name used to index empty field names. The default value is "unknown".
    
    Returns:
    
    The default field name used to index empty field names.
  - getIndexingEmptyNames
```
public abstract boolean getIndexingEmptyNames()
```
    Gets a value indicating whether to index empty field names or not. The default value is true.
    
    Returns:
    
    A value indicating whether to index empty field names or not.
  - getIndexingEmptyValues
```
public abstract boolean getIndexingEmptyValues()
```
    Gets a value indicating whether to index empty field values or not. The default value is true.
    
    Returns:
    
    A value indicating whether to index empty field values or not.
  - getMaxBytesToIndexField
```
public abstract int getMaxBytesToIndexField()
```
    Gets the maximum number of values in an array of type byte to index the field. The default value is Integer.MAX_VALUE.
    
    Returns:
    
    The maximum number of values in an array of type byte to index the field.
  - getMaxDoublesToIndexField
```
public abstract int getMaxDoublesToIndexField()
```
    Gets the maximum number of values in an array of type double to index the field. The default value is Integer.MAX_VALUE.
    
    Returns:
    
    The maximum number of values in an array of type double to index the field.
  - getMaxIntsToIndexField
```
public abstract int getMaxIntsToIndexField()
```
    Gets the maximum number of values in an array of type int to index the field. The default value is Integer.MAX_VALUE.
    
    Returns:
    
    The maximum number of values in an array of type int to index the field.
  - getMaxLongsToIndexField
```
public abstract int getMaxLongsToIndexField()
```
    Gets the maximum number of values in an array of type long to index the field. The default value is Integer.MAX_VALUE.
    
    Returns:
    
    The maximum number of values in an array of type long to index the field.
  - getSeparatorBetweenValues
```
public abstract String getSeparatorBetweenValues()
```
    Gets the separator between values in a field of type array. The default value is the space sign.
    
    Returns:
    
    The separator between values in a field of type array.
  - getSeparatorInCompoundName
```
public abstract String getSeparatorInCompoundName()
```
    Gets the separator in the compound name of a field. The default value is ".".
    
    Returns:
    
    The separator in the compound name of a field.
  - setDefaultFieldName
```
public abstract void setDefaultFieldName(String value)
```
    Sets the default field name used to index empty field names. The default value is "unknown".
    
    Parameters:
    
    value - The default field name used to index empty field names.
  - setIndexingEmptyNames
```
public abstract void setIndexingEmptyNames(boolean value)
```
    Sets a value indicating whether to index empty field names or not. The default value is true.
    
    Parameters:
    
    value - A value indicating whether to index empty field names or not.
  - setIndexingEmptyValues
```
public abstract void setIndexingEmptyValues(boolean value)
```
    Sets a value indicating whether to index empty field values or not. The default value is true.
    
    Parameters:
    
    value - A value indicating whether to index empty field values or not.
  - setMaxBytesToIndexField
```
public abstract void setMaxBytesToIndexField(int value)
```
    Sets the maximum number of values in an array of type byte to index the field. The default value is Integer.MAX_VALUE.
    
    Parameters:
    
    value - The maximum number of values in an array of type byte to index the field.
  - setMaxDoublesToIndexField
```
public abstract void setMaxDoublesToIndexField(int value)
```
    Sets the maximum number of values in an array of type double to index the field. The default value is Integer.MAX_VALUE.
    
    Parameters:
    
    value - The maximum number of values in an array of type double to index the field.
  - setMaxIntsToIndexField
```
public abstract void setMaxIntsToIndexField(int value)
```
    Sets the maximum number of values in an array of type int to index the field. The default value is Integer.MAX_VALUE.
    
    Parameters:
    
    value - The maximum number of values in an array of type int to index the field.
  - setMaxLongsToIndexField
```
public abstract void setMaxLongsToIndexField(int value)
```
    Sets the maximum number of values in an array of type long to index the field. The default value is Integer.MAX_VALUE.
    
    Parameters:
    
    value - The maximum number of values in an array of type long to index the field.
  - setSeparatorBetweenValues
```
public abstract void setSeparatorBetweenValues(String value)
```
    Sets the separator between values in a field of type array. The default value is the space sign.
    
    Parameters:
    
    value - The separator between values in a field of type array.
  - setSeparatorInCompoundName
```
public abstract void setSeparatorInCompoundName(String value)
```
    Sets the separator in the compound name of a field. The default value is ".".
    
    Parameters:
    
    value - The separator in the compound name of a field.

Class MetadataIndexingOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetadataIndexingOptions

Method Detail

getDefaultFieldName

getIndexingEmptyNames

getIndexingEmptyValues

getMaxBytesToIndexField

getMaxDoublesToIndexField

getMaxIntsToIndexField

getMaxLongsToIndexField

getSeparatorBetweenValues

getSeparatorInCompoundName

setDefaultFieldName

setIndexingEmptyNames

setIndexingEmptyValues

setMaxBytesToIndexField

setMaxDoublesToIndexField

setMaxIntsToIndexField

setMaxLongsToIndexField

setSeparatorBetweenValues

setSeparatorInCompoundName