public class TextArrayOptions
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Options for a field that contains an array of text strings. Present if
IndexFieldType
specifies the field is of type
text-array
. A text-array
field is always
searchable. All options are enabled by default.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
analysisScheme
The name of an analysis scheme for a
text-array field. |
private java.lang.String |
defaultValue
A value to use for the field if the field isn't specified for a document.
|
private java.lang.Boolean |
highlightEnabled
Whether highlights can be returned for the field.
|
private java.lang.Boolean |
returnEnabled
Whether the contents of the field can be returned in the search results.
|
private java.lang.String |
sourceFields
A list of source fields to map to the field.
|
Constructor and Description |
---|
TextArrayOptions() |
Modifier and Type | Method and Description |
---|---|
TextArrayOptions |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAnalysisScheme()
The name of an analysis scheme for a
text-array field. |
java.lang.String |
getDefaultValue()
A value to use for the field if the field isn't specified for a document.
|
java.lang.Boolean |
getHighlightEnabled()
Whether highlights can be returned for the field.
|
java.lang.Boolean |
getReturnEnabled()
Whether the contents of the field can be returned in the search results.
|
java.lang.String |
getSourceFields()
A list of source fields to map to the field.
|
int |
hashCode() |
java.lang.Boolean |
isHighlightEnabled()
Whether highlights can be returned for the field.
|
java.lang.Boolean |
isReturnEnabled()
Whether the contents of the field can be returned in the search results.
|
void |
setAnalysisScheme(java.lang.String analysisScheme)
The name of an analysis scheme for a
text-array field. |
void |
setDefaultValue(java.lang.String defaultValue)
A value to use for the field if the field isn't specified for a document.
|
void |
setHighlightEnabled(java.lang.Boolean highlightEnabled)
Whether highlights can be returned for the field.
|
void |
setReturnEnabled(java.lang.Boolean returnEnabled)
Whether the contents of the field can be returned in the search results.
|
void |
setSourceFields(java.lang.String sourceFields)
A list of source fields to map to the field.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
TextArrayOptions |
withAnalysisScheme(java.lang.String analysisScheme)
The name of an analysis scheme for a
text-array field. |
TextArrayOptions |
withDefaultValue(java.lang.String defaultValue)
A value to use for the field if the field isn't specified for a document.
|
TextArrayOptions |
withHighlightEnabled(java.lang.Boolean highlightEnabled)
Whether highlights can be returned for the field.
|
TextArrayOptions |
withReturnEnabled(java.lang.Boolean returnEnabled)
Whether the contents of the field can be returned in the search results.
|
TextArrayOptions |
withSourceFields(java.lang.String sourceFields)
A list of source fields to map to the field.
|
private java.lang.String defaultValue
private java.lang.String sourceFields
A list of source fields to map to the field.
private java.lang.Boolean returnEnabled
Whether the contents of the field can be returned in the search results.
private java.lang.Boolean highlightEnabled
Whether highlights can be returned for the field.
private java.lang.String analysisScheme
The name of an analysis scheme for a text-array
field.
public void setDefaultValue(java.lang.String defaultValue)
defaultValue
- A value to use for the field if the field isn't specified for a
document.public java.lang.String getDefaultValue()
public TextArrayOptions withDefaultValue(java.lang.String defaultValue)
defaultValue
- A value to use for the field if the field isn't specified for a
document.public void setSourceFields(java.lang.String sourceFields)
A list of source fields to map to the field.
sourceFields
- A list of source fields to map to the field.public java.lang.String getSourceFields()
A list of source fields to map to the field.
public TextArrayOptions withSourceFields(java.lang.String sourceFields)
A list of source fields to map to the field.
sourceFields
- A list of source fields to map to the field.public void setReturnEnabled(java.lang.Boolean returnEnabled)
Whether the contents of the field can be returned in the search results.
returnEnabled
- Whether the contents of the field can be returned in the search
results.public java.lang.Boolean getReturnEnabled()
Whether the contents of the field can be returned in the search results.
public TextArrayOptions withReturnEnabled(java.lang.Boolean returnEnabled)
Whether the contents of the field can be returned in the search results.
returnEnabled
- Whether the contents of the field can be returned in the search
results.public java.lang.Boolean isReturnEnabled()
Whether the contents of the field can be returned in the search results.
public void setHighlightEnabled(java.lang.Boolean highlightEnabled)
Whether highlights can be returned for the field.
highlightEnabled
- Whether highlights can be returned for the field.public java.lang.Boolean getHighlightEnabled()
Whether highlights can be returned for the field.
public TextArrayOptions withHighlightEnabled(java.lang.Boolean highlightEnabled)
Whether highlights can be returned for the field.
highlightEnabled
- Whether highlights can be returned for the field.public java.lang.Boolean isHighlightEnabled()
Whether highlights can be returned for the field.
public void setAnalysisScheme(java.lang.String analysisScheme)
The name of an analysis scheme for a text-array
field.
analysisScheme
- The name of an analysis scheme for a text-array
field.public java.lang.String getAnalysisScheme()
The name of an analysis scheme for a text-array
field.
text-array
field.public TextArrayOptions withAnalysisScheme(java.lang.String analysisScheme)
The name of an analysis scheme for a text-array
field.
analysisScheme
- The name of an analysis scheme for a text-array
field.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public TextArrayOptions clone()
clone
in class java.lang.Object