MetadataIndexingOptions
Inheritance: java.lang.Object
public abstract class MetadataIndexingOptions
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
Constructors
| Constructor | Description |
|---|---|
| MetadataIndexingOptions() |
Methods
| Method | Description |
|---|---|
| getIndexingEmptyValues() | Gets a value indicating whether to index empty field values or not. |
| setIndexingEmptyValues(boolean value) | Sets a value indicating whether to index empty field values or not. |
| getIndexingEmptyNames() | Gets a value indicating whether to index empty field names or not. |
| setIndexingEmptyNames(boolean value) | Sets a value indicating whether to index empty field names or not. |
| getDefaultFieldName() | Gets the default field name used to index empty field names. |
| setDefaultFieldName(String value) | Sets the default field name used to index empty field names. |
| getSeparatorInCompoundName() | Gets the separator in the compound name of a field. |
| setSeparatorInCompoundName(String value) | Sets the separator in the compound name of a field. |
| getMaxBytesToIndexField() | Gets the maximum number of values in an array of type byte to index the field. |
| setMaxBytesToIndexField(int value) | Sets the maximum number of values in an array of type byte to index the field. |
| getMaxIntsToIndexField() | Gets the maximum number of values in an array of type int to index the field. |
| setMaxIntsToIndexField(int value) | Sets the maximum number of values in an array of type int to index the field. |
| getMaxLongsToIndexField() | Gets the maximum number of values in an array of type long to index the field. |
| setMaxLongsToIndexField(int value) | Sets the maximum number of values in an array of type long to index the field. |
| getMaxDoublesToIndexField() | Gets the maximum number of values in an array of type double to index the field. |
| setMaxDoublesToIndexField(int value) | Sets the maximum number of values in an array of type double to index the field. |
| getSeparatorBetweenValues() | Gets the separator between values in a field of type array. |
| setSeparatorBetweenValues(String value) | Sets the separator between values in a field of type array. |
MetadataIndexingOptions()
public MetadataIndexingOptions()
getIndexingEmptyValues()
public abstract boolean getIndexingEmptyValues()
Gets a value indicating whether to index empty field values or not. The default value is true .
Returns: boolean - A value indicating whether to index empty field values or not.
setIndexingEmptyValues(boolean value)
public abstract void setIndexingEmptyValues(boolean value)
Sets a value indicating whether to index empty field values or not. The default value is true .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A value indicating whether to index empty field values or not. |
getIndexingEmptyNames()
public abstract boolean getIndexingEmptyNames()
Gets a value indicating whether to index empty field names or not. The default value is true .
Returns: boolean - A value indicating whether to index empty field names or not.
setIndexingEmptyNames(boolean value)
public abstract void setIndexingEmptyNames(boolean value)
Sets a value indicating whether to index empty field names or not. The default value is true .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A value indicating whether to index empty field names or not. |
getDefaultFieldName()
public abstract String getDefaultFieldName()
Gets the default field name used to index empty field names. The default value is “unknown” .
Returns: java.lang.String - The default field name used to index empty field names.
setDefaultFieldName(String value)
public abstract void setDefaultFieldName(String value)
Sets the default field name used to index empty field names. The default value is “unknown” .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The default field name used to index empty field names. |
getSeparatorInCompoundName()
public abstract String getSeparatorInCompoundName()
Gets the separator in the compound name of a field. The default value is “.” .
Returns: java.lang.String - The separator in the compound name of a field.
setSeparatorInCompoundName(String value)
public abstract void setSeparatorInCompoundName(String value)
Sets the separator in the compound name of a field. The default value is “.” .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The separator in the compound name of a field. |
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: int - The maximum number of values in an array of type byte to index the field.
setMaxBytesToIndexField(int value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | int | The maximum number of values in an array of type byte 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: int - The maximum number of values in an array of type int to index the field.
setMaxIntsToIndexField(int value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | int | 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: int - The maximum number of values in an array of type long to index the field.
setMaxLongsToIndexField(int value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | int | The maximum number of values in an array of type long 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: int - The maximum number of values in an array of type double to index the field.
setMaxDoublesToIndexField(int value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | int | The maximum number of values in an array of type double 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: java.lang.String - The separator between values in a field of type array.
setSeparatorBetweenValues(String value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The separator between values in a field of type array. |