Class DateOptions
- All Implemented Interfaces:
Serializable
,Cloneable
Options for a date field. Dates and times are specified in UTC (Coordinated
Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if
IndexFieldType
specifies the field is of type date
.
All options are enabled by default.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
A value to use for the field if the field isn't specified for a document.Whether facet information can be returned for the field.Whether the contents of the field can be returned in the search results.Whether the contents of the field are searchable.Whether the field can be used to sort the search results.int
hashCode()
Whether facet information can be returned for the field.Whether the contents of the field can be returned in the search results.Whether the contents of the field are searchable.Whether the field can be used to sort the search results.void
setDefaultValue
(String defaultValue) A value to use for the field if the field isn't specified for a document.void
setFacetEnabled
(Boolean facetEnabled) Whether facet information can be returned for the field.void
setReturnEnabled
(Boolean returnEnabled) Whether the contents of the field can be returned in the search results.void
setSearchEnabled
(Boolean searchEnabled) Whether the contents of the field are searchable.void
setSortEnabled
(Boolean sortEnabled) Whether the field can be used to sort the search results.void
setSourceField
(String sourceField) toString()
Returns a string representation of this object; useful for testing and debugging.withDefaultValue
(String defaultValue) A value to use for the field if the field isn't specified for a document.withFacetEnabled
(Boolean facetEnabled) Whether facet information can be returned for the field.withReturnEnabled
(Boolean returnEnabled) Whether the contents of the field can be returned in the search results.withSearchEnabled
(Boolean searchEnabled) Whether the contents of the field are searchable.withSortEnabled
(Boolean sortEnabled) Whether the field can be used to sort the search results.withSourceField
(String sourceField)
-
Constructor Details
-
DateOptions
public DateOptions()
-
-
Method Details
-
setDefaultValue
A value to use for the field if the field isn't specified for a document.- Parameters:
defaultValue
- A value to use for the field if the field isn't specified for a document.
-
getDefaultValue
A value to use for the field if the field isn't specified for a document.- Returns:
- A value to use for the field if the field isn't specified for a document.
-
withDefaultValue
A value to use for the field if the field isn't specified for a document.- Parameters:
defaultValue
- A value to use for the field if the field isn't specified for a document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSourceField
- Parameters:
sourceField
-
-
getSourceField
- Returns:
-
withSourceField
- Parameters:
sourceField
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setFacetEnabled
Whether facet information can be returned for the field.
- Parameters:
facetEnabled
- Whether facet information can be returned for the field.
-
getFacetEnabled
Whether facet information can be returned for the field.
- Returns:
- Whether facet information can be returned for the field.
-
withFacetEnabled
Whether facet information can be returned for the field.
- Parameters:
facetEnabled
- Whether facet information can be returned for the field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isFacetEnabled
Whether facet information can be returned for the field.
- Returns:
- Whether facet information can be returned for the field.
-
setSearchEnabled
Whether the contents of the field are searchable.
- Parameters:
searchEnabled
- Whether the contents of the field are searchable.
-
getSearchEnabled
Whether the contents of the field are searchable.
- Returns:
- Whether the contents of the field are searchable.
-
withSearchEnabled
Whether the contents of the field are searchable.
- Parameters:
searchEnabled
- Whether the contents of the field are searchable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isSearchEnabled
Whether the contents of the field are searchable.
- Returns:
- Whether the contents of the field are searchable.
-
setReturnEnabled
Whether the contents of the field can be returned in the search results.
- Parameters:
returnEnabled
- Whether the contents of the field can be returned in the search results.
-
getReturnEnabled
Whether the contents of the field can be returned in the search results.
- Returns:
- Whether the contents of the field can be returned in the search results.
-
withReturnEnabled
Whether the contents of the field can be returned in the search results.
- Parameters:
returnEnabled
- Whether the contents of the field can be returned in the search results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isReturnEnabled
Whether the contents of the field can be returned in the search results.
- Returns:
- Whether the contents of the field can be returned in the search results.
-
setSortEnabled
Whether the field can be used to sort the search results.
- Parameters:
sortEnabled
- Whether the field can be used to sort the search results.
-
getSortEnabled
Whether the field can be used to sort the search results.
- Returns:
- Whether the field can be used to sort the search results.
-
withSortEnabled
Whether the field can be used to sort the search results.
- Parameters:
sortEnabled
- Whether the field can be used to sort the search results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isSortEnabled
Whether the field can be used to sort the search results.
- Returns:
- Whether the field can be used to sort the search results.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-