public class LiteralOptions
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Options for literal field. Present if IndexFieldType
specifies
the field is of type literal
. All options are enabled by
default.
Modifier and Type | Field and Description |
---|---|
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 |
facetEnabled
Whether facet information 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.Boolean |
searchEnabled
Whether the contents of the field are searchable.
|
private java.lang.Boolean |
sortEnabled
Whether the field can be used to sort the search results.
|
private java.lang.String |
sourceField |
Constructor and Description |
---|
LiteralOptions() |
Modifier and Type | Method and Description |
---|---|
LiteralOptions |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDefaultValue()
A value to use for the field if the field isn't specified for a document.
|
java.lang.Boolean |
getFacetEnabled()
Whether facet information 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.Boolean |
getSearchEnabled()
Whether the contents of the field are searchable.
|
java.lang.Boolean |
getSortEnabled()
Whether the field can be used to sort the search results.
|
java.lang.String |
getSourceField() |
int |
hashCode() |
java.lang.Boolean |
isFacetEnabled()
Whether facet information can be returned for the field.
|
java.lang.Boolean |
isReturnEnabled()
Whether the contents of the field can be returned in the search results.
|
java.lang.Boolean |
isSearchEnabled()
Whether the contents of the field are searchable.
|
java.lang.Boolean |
isSortEnabled()
Whether the field can be used to sort the search results.
|
void |
setDefaultValue(java.lang.String defaultValue)
A value to use for the field if the field isn't specified for a document.
|
void |
setFacetEnabled(java.lang.Boolean facetEnabled)
Whether facet information 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 |
setSearchEnabled(java.lang.Boolean searchEnabled)
Whether the contents of the field are searchable.
|
void |
setSortEnabled(java.lang.Boolean sortEnabled)
Whether the field can be used to sort the search results.
|
void |
setSourceField(java.lang.String sourceField) |
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
LiteralOptions |
withDefaultValue(java.lang.String defaultValue)
A value to use for the field if the field isn't specified for a document.
|
LiteralOptions |
withFacetEnabled(java.lang.Boolean facetEnabled)
Whether facet information can be returned for the field.
|
LiteralOptions |
withReturnEnabled(java.lang.Boolean returnEnabled)
Whether the contents of the field can be returned in the search results.
|
LiteralOptions |
withSearchEnabled(java.lang.Boolean searchEnabled)
Whether the contents of the field are searchable.
|
LiteralOptions |
withSortEnabled(java.lang.Boolean sortEnabled)
Whether the field can be used to sort the search results.
|
LiteralOptions |
withSourceField(java.lang.String sourceField) |
private java.lang.String defaultValue
private java.lang.String sourceField
private java.lang.Boolean facetEnabled
Whether facet information can be returned for the field.
private java.lang.Boolean searchEnabled
Whether the contents of the field are searchable.
private java.lang.Boolean returnEnabled
Whether the contents of the field can be returned in the search results.
private java.lang.Boolean sortEnabled
Whether the field can be used to sort the search results.
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 LiteralOptions withDefaultValue(java.lang.String defaultValue)
defaultValue
- A value to use for the field if the field isn't specified for a
document.public void setSourceField(java.lang.String sourceField)
sourceField
- public java.lang.String getSourceField()
public LiteralOptions withSourceField(java.lang.String sourceField)
sourceField
- public void setFacetEnabled(java.lang.Boolean facetEnabled)
Whether facet information can be returned for the field.
facetEnabled
- Whether facet information can be returned for the field.public java.lang.Boolean getFacetEnabled()
Whether facet information can be returned for the field.
public LiteralOptions withFacetEnabled(java.lang.Boolean facetEnabled)
Whether facet information can be returned for the field.
facetEnabled
- Whether facet information can be returned for the field.public java.lang.Boolean isFacetEnabled()
Whether facet information can be returned for the field.
public void setSearchEnabled(java.lang.Boolean searchEnabled)
Whether the contents of the field are searchable.
searchEnabled
- Whether the contents of the field are searchable.public java.lang.Boolean getSearchEnabled()
Whether the contents of the field are searchable.
public LiteralOptions withSearchEnabled(java.lang.Boolean searchEnabled)
Whether the contents of the field are searchable.
searchEnabled
- Whether the contents of the field are searchable.public java.lang.Boolean isSearchEnabled()
Whether the contents of the field are searchable.
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 LiteralOptions 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 setSortEnabled(java.lang.Boolean sortEnabled)
Whether the field can be used to sort the search results.
sortEnabled
- Whether the field can be used to sort the search results.public java.lang.Boolean getSortEnabled()
Whether the field can be used to sort the search results.
public LiteralOptions withSortEnabled(java.lang.Boolean sortEnabled)
Whether the field can be used to sort the search results.
sortEnabled
- Whether the field can be used to sort the search results.public java.lang.Boolean isSortEnabled()
Whether the field can be used to sort the search results.
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 LiteralOptions clone()
clone
in class java.lang.Object